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

API Documentation doesn't support to document error codes for an API. #7885

Closed
muhammad-shafique opened this issue Jan 8, 2020 · 8 comments

Comments

@muhammad-shafique
Copy link

Is your feature request related to a problem? Please describe.
I need to add supported error codes that a specific API can return in response.

Describe the solution you'd like
There must be an option to document error codes description under Postman API documentation.

Describe alternatives you've considered
I couldn't find any alternative yet.

@muhammad-shafique
Copy link
Author

Dear Raja-Simha,
Thank you for picking up this as feature.

Eagerly waiting for this feature to be used for our product documentation. :)

@muhammad-shafique
Copy link
Author

Hi Postman Team,

Is there any chance to get this feature implemented please? Actually we need to document our product documentation if this could help us, else we need to move to any other alternative.

Would appreciate your response on this, thanks!

@godfrzero
Copy link

@muhammad-shafique Is there a reason why these error codes can't be documented using the freeform request/folder descriptions? We've seen people use markdown tables or lists to cover this use case.

@muhammad-shafique
Copy link
Author

Can you please provide any example or screenshot? I tried but couldn't find where to document possible error code for a particular web response.

@Raja-Simha
Copy link

Here are a couple of examples I found.
image

image

Feel free to share your thoughts around these and let us know if this helps.

@Raja-Simha Raja-Simha added this to Pending Triage in Documentation Feb 13, 2020
@Raja-Simha Raja-Simha moved this from Pending Triage to Later in Documentation Feb 18, 2020
@mehdinourollah
Copy link

Can you tell me how this is possible ?
I can't figure it out how to display the end-user response codes and error codes

@mehdinourollah
Copy link

Here are a couple of examples I found. image

image

Feel free to share your thoughts around these and let us know if this helps.

I mean this...can you explain more?

@kamil-bednarek
Copy link

Same here. Unfortunately generator doesn't support error codes. Only error description is visible to viewer.

@akshaydeo akshaydeo moved this from Later to Done in Documentation Sep 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Documentation
  
Done
Development

No branches or pull requests

6 participants