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.

Sign up for GitHub

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
Merged

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

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6fd5209
Exclude Acccept, Content-type and Authorization header from the list …
ticapix Jun 26, 2024
405c58b
Merge branch 'main' into patch-2
RobertoPrevato Jan 15, 2025
fbce7a8
Make linters happy
RobertoPrevato Jan 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion blacksheep/server/openapi/v3.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -861,7 +861,14 @@ def get_parameter_location_for_binder(
return ParameterLocation.QUERY
if isinstance(binder, CookieBinder):
return ParameterLocation.COOKIE
if isinstance(binder, HeaderBinder):

# exclude those specific header value per documentation
# https://swagger.io/docs/specification/describing-parameters/#header-parameters
if isinstance(binder, HeaderBinder) and binder.parameter_name.lower() not in [
"content-type",
"accept",
"authorization",
]:
return ParameterLocation.HEADER
return None

Expand Down
Loading