Skip to content

Add $self for self-identifying documents#4389

Closed
handrews wants to merge 12 commits into
OAI:v3.2-devfrom
handrews:self2
Closed

Add $self for self-identifying documents#4389
handrews wants to merge 12 commits into
OAI:v3.2-devfrom
handrews:self2

Conversation

@handrews
Copy link
Copy Markdown
Member

@handrews handrews commented Feb 28, 2025

See the proposal for background information.

This is a rather minimal approach, as @karenetheridge and I plan to work together on a more thorough revamp of the document parsing / reference resolution sections.

This adds $self as a way for a document to define its own URI for use in reference targets, and as the base URI for relative URI references in the document.

This does not impact the resolution of relative API URLs. [NOTE: I'm not entirely sure about this, but it seems more useful this way to allow multiple deployed locations of an OAD to correspond to multiple deployments of the API.)

  • schema changes are included in this pull request

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

OAS3 Tag/template to define external-components URL

6 participants