Skip to content

Fixed and enhanced OpenAPI#195

Draft
adriendupuis wants to merge 16 commits intomainfrom
enh-openapi
Draft

Fixed and enhanced OpenAPI#195
adriendupuis wants to merge 16 commits intomainfrom
enh-openapi

Conversation

@adriendupuis
Copy link
Copy Markdown
Contributor

@adriendupuis adriendupuis commented Aug 5, 2025

🎫 Issue IBX-10444

Related PRs:

Description:

Accept and Content-Type headers

https://spec.openapis.org/oas/v3.1.1.html#x4-8-12-2-1-common-fixed-fields

If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored.

https://swagger.io/docs/specification/v3_0/describing-parameters/#header-parameters

Note: Header parameters named Accept, Content-Type and Authorization are not allowed.

When using "Try it out' on live doc (/api/ibexa/v2/doc#/Objects/api_contentobjects_contentId_get), the previously displayed Accept header parameter form input was never taken into account. To choose an Accept header, one must be selected in the Responses panel.

So, I removed the useless and ignored Accept header parameter definition, and moved it's description up into the ressource description.

image
Other changes

See #218 for how I used Copilot for repetitive tasks.
Since, I added "For requestBody and responses, sort content by keys." to this prompt.

For QA:

Documentation:

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Aug 5, 2025

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Oct 5, 2025

@sonarqubecloud
Copy link
Copy Markdown

@sonarqubecloud
Copy link
Copy Markdown

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.

5 participants