anitab-org / anitab-org/stem-diverse-tv

Document 401 Unauthorized HTTP status error on Swagger UI for every API

Aperta
#194 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Category: Coding Category: Documentation/Training Status: Available
Lingua principale
Python
Stelle
13
Fork
48
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

## Description

As a frontend developer,
I need to know the available responses from the API,
so that I can properly adjust frontend for the potential responses.

Documentation about the 401 Unauthorize HTTP status is missing from Swagger UI. The idea is for this to be documented, and Swagger UI acknowledge that the 401 documentation exists. This happens at least for `PATCH /sections/{id}`, but I am pretty sure it is happening with all endpoints.

## Mocks

You can see in the following message, the 401 shows as undocumented.

![401 HTTP status undocumented on Swagger UI](https://user-images.githubusercontent.com/11148726/114249926-f71c4780-9993-11eb-8e40-a148a4514c8c.png)

## Acceptance Criteria
### Update [Required]
- [ ] Every API should have 401 Unauthrized HTTP status documented on Swagger UI

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

## Estimation

2 hours

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.