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

What would be the best way to document a binary response. #479

Closed
tecbeast42 opened this issue Mar 18, 2019 · 1 comment
Closed

What would be the best way to document a binary response. #479

tecbeast42 opened this issue Mar 18, 2019 · 1 comment
Assignees

Comments

@tecbeast42
Copy link

I have a route where creates a pdf and returns the file binary with ->header('Content-Type', 'application/pdf'). I am not sure what would be the best way to document this.

I think something like this would be nice:

* @response <binary>

I think to just put it in the description is not a good way to solve this.

@shalvah
Copy link
Contributor

shalvah commented Mar 22, 2019

That could work. I'd prefer <<binary>> though, just to avoid the possibility of someone's response actually being "<binary>".

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

No branches or pull requests

2 participants