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

Exclude Accept, Content-type and Authorization header from OpenAPI docs #504

Merged
merged 3 commits into from
Jan 16, 2025

Conversation

ticapix
Copy link
Contributor

@ticapix ticapix commented Jun 26, 2024

Hello,

Based on the OpenAPI specs, some headers are not supposed to be listed directly as parameters https://swagger.io/docs/specification/describing-parameters/#header-parameters

From the doc here https://www.neoteroi.dev/blacksheep/binders/#built-in-binders, the Accept header will generate the following openapi.json content which is invalid according to the OpenAPI specs.

The warning message comes from the swagger tool.

image

The proposal is to exclude the content-type, accept, authorization header from the parameters configuration.

Best regards,
Pierre

@RobertoPrevato RobertoPrevato changed the title Exclude Acccept, Content-type and Authorization header from OpenAPI docs Exclude Accept, Content-type and Authorization header from OpenAPI docs Jan 15, 2025
@RobertoPrevato RobertoPrevato merged commit b212cba into Neoteroi:main Jan 16, 2025
14 checks passed
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