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

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

オープン
#194 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る
Category: Coding Category: Documentation/Training Status: Available
主要言語
Python
スター
13
フォーク
48
PR マージ指標
30日以内にマージされた PR はありません

説明

## 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

コントリビューションガイド

コントリビューションガイドを開く

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。