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 URI-references for Security Requirements (3.2.0) #3821

Closed
wants to merge 1 commit into from

Conversation

handrews
Copy link
Member

@handrews handrews commented May 19, 2024

NOTE: This is a draft because I was going to make it a proposal, but its much shorter to just show the PR than explain it some other way. See PR #3823 for more context.

Fixes:

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.

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.
@handrews handrews added enhancement re-use: ref-everywhere Requests to support referencing in more / all places re-use: ref/id resolution how $ref, operationId, or anything else is resolved security: config The mechanics of severs and structure of security-related objects labels May 19, 2024
@handrews handrews added this to the v3.2.0 milestone May 19, 2024
@handrews handrews requested a review from a team May 19, 2024 17:58
@handrews handrews changed the title Allow URI-references for Security Requiements (3.2.0) Allow URI-references for Security Requirements (3.2.0) May 20, 2024
Copy link
Contributor

@ralfhandl ralfhandl left a comment

Choose a reason for hiding this comment

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

+1 with minor nit

versions/3.2.0.md Show resolved Hide resolved
@ralfhandl ralfhandl self-requested a review May 23, 2024 15:05
Copy link
Contributor

@miqui miqui left a comment

Choose a reason for hiding this comment

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

@handrews looks good

@handrews
Copy link
Member Author

@miqui @ralfhandl I think I'm actually going to take this down and write a proposal- when I submitted this I did not realize that we needed a similar solution for tags, and I need to think it through a bit. I can think of two ways to handle it and I'm not suire which is better.

@handrews handrews closed this Aug 28, 2024
@ralfhandl
Copy link
Contributor

Looking forward to the next PR 😄

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 re-use: ref-everywhere Requests to support referencing in more / all places security: config The mechanics of severs and structure of security-related objects
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants