anitab-org / anitab-org/mentorship-backend

Add query parameter to filter users by verification state to GET /users API

Offen
#403 47 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Category: Coding Open Source Hack Status: Available Type: Enhancement
Vorherrschende Sprache
Python
Sterne
200
Forks
449
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

## Description
As a developer,
I need a filter feature on the Users listing endpoint,
so that I can reuse `GET /users` API to filter users who have the email verified.

`GET /users` API needs a way to filter users by email verification state (which is represented by a boolean value). This will allow us deprecating the extra `GET /users/verified` API.

## Acceptance Criteria
### Update [Required]
- [ ] Add a query parameter support to `GET /users`, to filter by its current state.
- [ ] Update Swagger UI documentation for this API.
- [ ] Write at least one test to prove your new feature is working.

## Definition of Done
- [ ] All of the required items are completed.
- [ ] Approval by 1 mentor.

## Estimation
4 hours

Beitragsleitfaden

Beitragsleitfaden öffnen

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.