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

Support "previews" for zero byte responses in API explorer #5782

Open
nateKlaux opened this issue Jan 29, 2025 · 0 comments
Open

Support "previews" for zero byte responses in API explorer #5782

nateKlaux opened this issue Jan 29, 2025 · 0 comments
Labels
feature Requests for new features. product/docs Fern Docs which builds and hosts a developer documentation site

Comments

@nateKlaux
Copy link

nateKlaux commented Jan 29, 2025

Feature Description

Support "zero byte" or "no response" responses in the API explorer's response preview. Currently, file preview says "File preview not supported for application/octet-stream".

Image

Use Case

Some endpoints return no response and we've had some feedback that the "File preview not supported..." message created confusion/FUD that there was an error. Just showing a blank response with the 2xx status code should alleviate this.

For reference, we define this behavior in OAS with no content: property:

      responses: 
        '200':  
          description: Request processed successfully, but no content in the response.

Proposed Experience (Optional)

Display a blank/empty text box. For instance, swagger just shows:

Image
@nateKlaux nateKlaux added feature Requests for new features. product/docs Fern Docs which builds and hosts a developer documentation site labels Jan 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Requests for new features. product/docs Fern Docs which builds and hosts a developer documentation site
Development

No branches or pull requests

1 participant