Systers, an AnitaB.org community

Add query parameter to filter mentorship relations by current state (Backend)

Introduction

Mentorship relations can be fetched through GET /mentorship_relations and these can have at least 5 states, described in this wiki page and have their codes in this app/utils/enum_utils.py file.

Prerequisite:

  • Have a GitHub account
  • Know how to use git
  • Setup and run the project on your local development environment

Steps:

  • Create a copy of the project into your account GitHub by forking systers/mentorship-backend project.
  • Clone the project onto your local development environment
  • [Optional] Create a branch to make your changes
  • Add a query parameter support to GET /mentorship_relations, to filter by its current state (available states). Feel free to choose the parameter name.
  • Update Swagger UI documentation for this API.
  • Write at least one test to prove your new feature is working.
  • Commit your change through the interface using our Commit message Style Guide.
  • Submit a Pull Request, targeting gci-dev branch, following the template provided in the description (with reference to issue #329).

Resources:

  • If you need help or get lost, post a response to our questions topic in our #gci stream.
  • Pull request template at this link.
  • Commit message Style Guide can be found here.
  • How to fork, clone and setup remotes the project into your account wiki page can be found here.

Work Submission:

Submit a link to Pull Request (PR) created with the change.

Task tags

  • flask
  • python
  • swagger
  • backend

Students who completed this task

asawesome07, BartekPacia, HardikJH

Task type

  • code Code
close

2019