postmanlabs / postman-app-support

Postman is an API platform for building and using APIs. Postman simplifies each step of the API lifecycle and streamlines collaboration so you can create better APIs—faster.
https://www.postman.com
5.82k stars 839 forks source link

Status codes in generated documentation #3417

Open vaibhav-plackal opened 7 years ago

vaibhav-plackal commented 7 years ago

App Details:

Postman for Mac
Version 5.1.3 (5.1.3)

Issue Report:

When I look at the docs generated by Postman, I can see all my examples there, however, I do not see the HTTP response codes in the docs. They are important for us. I thought they are available to Pro accounts but they are not.

Steps to reproduce:

Save examples for any request with different response codes; then go to Postman dashboard and view your Docs. The examples will not show the HTTP response codes you had saved in examples.

bhawna2109 commented 7 years ago

@vaibhav-plackal - the status codes which you set for your examples are currently NOT shown in the documenter. However, you can specify those in the example name for now. For instance, you could name your example as '200 OK example' or '400 Error' – these will be displayed in the docs. Adding this as a feature request too.

vaibhav-plackal commented 7 years ago

Thanks :) Hope to see this awesome feature soon. I am shifting from another platform to Postman and this was probably the only thing missing (though, after having used Postman, I think there is so much more that can be added; it kind of opened up my mind) :)

On 21-Aug-2017, at 2:45 PM, Bhawna Agarwal notifications@github.com wrote:

@vaibhav-plackal https://github.com/vaibhav-plackal - the status codes which you set for your examples are currently NOT shown in the documenter. However, you can specify those in the example name for now. For instance, you could name your example as '200 OK example' or '400 Error' – these will be displayed in the docs. Adding this as a feature request too.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/postmanlabs/postman-app-support/issues/3417#issuecomment-323691143, or mute the thread https://github.com/notifications/unsubscribe-auth/AcleBwCRX-Mrv69VXE6wyi2akF3kSb3aks5saUqtgaJpZM4O85qE.

bhawna2109 commented 7 years ago

Glad to hear that @vaibhav-plackal Also feel free to share your other thoughts/general feedback on the product - we're all ears!

danielhammerl commented 6 years ago

+1

godfrzero commented 6 years ago

Status codes have been showing up in documentation for a while now, FYI.

snnbotchway commented 1 year ago

Status codes have been showing up in documentation for a while now, FYI.

I don't see them, it's 2023. Or it's not available for free accounts?

hung-native commented 1 year ago

+1 not seeing it 😥

ankitjaggi commented 1 year ago

This is not the expected behaviour. We're looking into fixing this. I'll keep the issue updated whenever this is fixed.

sony-mathew commented 2 weeks ago

Hey @snnbotchway @hung-native ,

We've been actively improving our documentation to better serve you. Since this issue seems to be related to an older version, I'd like to confirm if it's still reproducible with our current UI and UX. Can you please verify if the issue persists?

I can see the status codes in the documentation like this: Screenshot 2024-09-03 at 2 26 34 AM

Screenshot 2024-09-03 at 2 28 00 AM