Skip to content

Allow URI-references for Security Requirements (3.2.0) - #3821

Closed
handrews wants to merge 1 commit into
OAI:v3.2.0-devfrom
handrews:sec-req-uri-320
Closed

Allow URI-references for Security Requirements (3.2.0)#3821
handrews wants to merge 1 commit into
OAI:v3.2.0-devfrom
handrews:sec-req-uri-320

Conversation

@handrews

@handrewshandrews commented May 19, 2024

Copy link
Copy Markdown
Member

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.
@handrewshandrews 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
@handrewshandrews added this to the v3.2.0 milestone May 19, 2024
@handrews
handrews requested a review from a teamMay 19, 2024 17:58
@handrewshandrews changed the title Allow URI-references for Security Requiements (3.2.0)Allow URI-references for Security Requirements (3.2.0)May 20, 2024

@ralfhandlralfhandl left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

+1 with minor nit

Comment threadversions/3.2.0.md
@ralfhandl
ralfhandl self-requested a review May 23, 2024 15:05

@miquimiqui left a comment

Copy link
Copy Markdown
Contributor

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
Copy Markdown
MemberAuthor

@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.

@ralfhandl

Copy link
Copy Markdown
Contributor

Looking forward to the next PR 😄

@handrews
handrews deleted the sec-req-uri-320 branch June 19, 2025 18:16
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancementre-use: ref/id resolutionhow $ref, operationId, or anything else is resolvedre-use: ref-everywhereRequests to support referencing in more / all placessecurity: configThe mechanics of severs and structure of security-related objects

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@handrews@ralfhandl@miqui