billing/pdf: add content type header #697
Conversation
The response for `/v2/customers/my/invoices/{uuid}/pdf` contains a
`content-type` header in the response, so we should include that in the
spec.
| @@ -12,7 +14,7 @@ headers: | |||
| $ref: '../../../shared/headers.yml#/ratelimit-reset' | |||
|
|
|||
| content: | |||
| application/pdf: | |||
| application/pdf: | |||
There was a problem hiding this comment.
I thought this is how the content type was determined but, you're right, the content-type isn't added to the rendered docs without it being set in the headers.
There was a problem hiding this comment.
That's shown here, but doesn't document that the header is actually included:
| The response will be a PDF file. | ||
|
|
||
| headers: | ||
| content-type: | ||
| $ref: '../../../shared/headers.yml#/content-type' |
There was a problem hiding this comment.
Unfortunately, this ref defines the content-type as application/json
https://github.com/digitalocean/openapi/blob/main/specification/shared/headers.yml#L51
You might need to add a new schema for pdf content type.
There was a problem hiding this comment.
Ya... It's the "example." It's really just documenting that the header is returned, not what it's content type is. Looks like we have the same problem with the content-disposition header example as well. It uses csv
The response for
/v2/customers/my/invoices/{uuid}/pdfcontains acontent-typeheader in the response, so we should include that in the spec.