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.

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

To clarify the query regarding the status code documentation #821

Open
Vignesh-D-95 opened this issue Dec 9, 2024 · 1 comment
Open

Comments

@Vignesh-D-95
Copy link

Team - Can you please clarify whether the 502 response code should be documented in the Open API Spec?

502 Bad Gateway error is listed in the Zalando documentation but it is not clearly mentioned whether it has to be documented or not documented. Below is the link which has the details,

https://opensource.zalando.com/restful-api-guidelines/#status-code-502

image

@ePaul
Copy link
Member

ePaul commented Dec 10, 2024

It looks like we missed to add either a document or do-not-document tag here (and same for 504).

Thanks for pointing us to it.

We just talked about it in the API guild meeting, and agree that all of 502, 503, 504 should have [use] + [do-not-document] tags.

I'll open a PR to fix it (and also the broken indentation).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants