Skip to content

Support bundle download endpoints could distinguish success and failure status codes in OpenAPI #7346

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ahl
Copy link
Contributor

@ahl ahl commented Jan 15, 2025

this is probably wrong; we might return a 200 or 206.

@ahl ahl marked this pull request as draft January 15, 2025 04:21
@smklein
Copy link
Collaborator

smklein commented Jan 15, 2025

I think this is the right approach for all support bundle endpoints - I either forgot or never knew about FreeformBody, but it seems vastly superior to just returning a raw Body to be vaguely interpreted.

I'll give a shot at updating all these response endpoints in #7187 to confirm this works with the integration tests

@smklein
Copy link
Collaborator

smklein commented Jan 15, 2025

Following up on comments made in chat:

  • I think this is the right-ish direction (would like to make possible return values explicit)
  • However, FreefromBody appears to drop all the response headers
  • This is a problem for range requests, which would like to return headers
  • We might need to patch dropshot to make this work

@ahl
Copy link
Contributor Author

ahl commented Jan 15, 2025

Yeah. I don't think we can do this right now, but ideally we'd like the following to appear in the OpenAPI document:

  • range-related headers (both for requests and responses)
  • error response codes
  • multiple success responses (200 and 206)
  • content type for the output ("application/octet-stream" I think?)

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

Successfully merging this pull request may close these issues.

2 participants