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

Allow URIs for Security Schemes #4388

Merged
merged 2 commits into from
Mar 22, 2025
Merged

Allow URIs for Security Schemes #4388

merged 2 commits into from
Mar 22, 2025

Conversation

handrews
Copy link
Member

Fixes #3776

This allows Security Requirement Objects to reference Security Scheme Objects by URI instead of implicit component name. Without this ability, it is difficult to share Security Schemes in a way that is consistent with re-usable component documents.

This approach provides parity with how the Discriminator Object's mapping field works.

Also add a note about the complexity of these rules to the Security Considerations section.

Note that since the existing name syntax is still valid, and no constraints are present on names, there are no meaningful schema updates for this change.

  • schema changes are included in this pull request
  • schema changes are needed for this pull request but not done yet
  • no schema changes are needed for this pull request

@handrews handrews added the re-use: ref/id resolution how $ref, operationId, or anything else is resolved label Feb 28, 2025
@handrews handrews added this to the v3.2.0 milestone Feb 28, 2025
@handrews handrews requested review from a team as code owners February 28, 2025 14:46
mikekistler
mikekistler previously approved these changes Feb 28, 2025
Copy link
Contributor

@mikekistler mikekistler left a comment

Choose a reason for hiding this comment

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

Looks good! 👍

This allows Security Requirement Objects to reference Security Scheme Objects by URI instead of implicit component name. Without this ability, it is difficult to share Security Schemes in a way that is consistent with re-usable component documents.

This approach provides parity with how the Discriminator Object's mapping field works.

Also add a note about the complexity of these rules to the Security Considerations section.
@handrews
Copy link
Member Author

@ralfhandl this should now have your comments addressed.

@ralfhandl ralfhandl requested review from mikekistler and a team March 19, 2025 11:06
@ralfhandl ralfhandl linked an issue Mar 19, 2025 that may be closed by this pull request
@miqui miqui merged commit 55d0c62 into OAI:v3.2-dev Mar 22, 2025
2 checks passed
@handrews handrews deleted the sec-req-uri branch March 29, 2025 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement re-use: ref/id resolution how $ref, operationId, or anything else is resolved
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use URI references for Security Requirements in 3.2
4 participants