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

Custom auth types in security_map #1940

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

anna-intellegens
Copy link

Allow definition of new auth types (not just schemes) to be passed in to security_map
This is particularly motivated by wanting to support OpenIDConnect auth type, but was running into an error as it couldn't find the scheme key (as it's not permitted in the schema by the openAPI validator).

The docs imply that you should be able to implement a custom scheme for this, instead I would get a KeyError.

Changes proposed in this pull request:

  • Update parse_security_schemes to allow the detection of auth types, not just schemes.

@Ruwann Ruwann force-pushed the fix/custom-security-type branch from e5bf766 to f949454 Compare December 12, 2024 14:27
@Ruwann Ruwann force-pushed the fix/custom-security-type branch from 523dfd2 to f701207 Compare December 13, 2024 17:53
@Ruwann Ruwann force-pushed the fix/custom-security-type branch from f701207 to 1ef1833 Compare December 13, 2024 17:54
@coveralls
Copy link

Coverage Status

coverage: 94.354% (-0.07%) from 94.419%
when pulling 1ef1833 on anna-intellegens:fix/custom-security-type
into 1844a2f on spec-first:main.

Copy link
Member

@Ruwann Ruwann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I have updated the code a bit to already add openIdConnect as an option, without default implementation.

@RobbeSneyders feel free to review, I've kept the "other" custom scheme/type options even though the types allowed are limited, but didn't see much harm in keeping them, as new security types should then also be possible to be provided by the user

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.

3 participants