Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Open
3 tasks
isabelcosta opened this issue Apr 9, 2021 · 3 comments
Open
3 tasks

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

isabelcosta opened this issue Apr 9, 2021 · 3 comments
Labels
Category: Coding Changes to code base or refactored code that doesn't fix a bug. Category: Documentation/Training Improvements or additions to documentation. Status: Available Issue was approved and available to claim or abandoned for over 3 days.

Comments

@isabelcosta
Copy link
Member

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

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
@isabelcosta isabelcosta added Category: Coding Changes to code base or refactored code that doesn't fix a bug. Category: Documentation/Training Improvements or additions to documentation. First Timers Only Good for newcomers. Status: Available Issue was approved and available to claim or abandoned for over 3 days. Open Source Hack labels Apr 9, 2021
@anjali1102
Copy link
Contributor

I want to work on this

@isabelcosta isabelcosta removed the First Timers Only Good for newcomers. label Apr 14, 2021
@isabelcosta
Copy link
Member Author

@anjali1102 do you still want to work on this one? I will assign to you, if you are not interested let me know and I will unassign

@isabelcosta isabelcosta removed the Status: Available Issue was approved and available to claim or abandoned for over 3 days. label Apr 14, 2021
@epicadk epicadk added the Status: Available Issue was approved and available to claim or abandoned for over 3 days. label Jun 5, 2021
@Aishwarya1396
Copy link

Hi, Is this issue still open? if it is, can i please work on this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Category: Coding Changes to code base or refactored code that doesn't fix a bug. Category: Documentation/Training Improvements or additions to documentation. Status: Available Issue was approved and available to claim or abandoned for over 3 days.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@isabelcosta @Aishwarya1396 @anjali1102 @epicadk