OpenAPI-Specification icon indicating copy to clipboard operation
OpenAPI-Specification copied to clipboard

uri resolution notes

Open karenetheridge opened this issue 5 months ago • 3 comments

Not intended for merging in this form.

Notes on my initial thoughts on how each uri-reference in the OAD should resolve.

See https://github.com/OAI/OpenAPI-Specification/discussions/4925#discussioncomment-14329850.

karenetheridge avatar Sep 07 '25 03:09 karenetheridge

Sharing some notes from the meeting: This is a working document from @karenetheridge with her understanding of the spec today. If some of that is "wrong" it probably means that we need to make the specification clearer. @handrews to provide some feedback to help get to a common understanding and identify the potential for improvements in the specification.

baywet avatar Nov 06 '25 17:11 baywet

Another reference point -- https://swagger.io/docs/specification/v3_0/api-host-and-base-path/#relative-urls -- says that other URIs in the OAD (e.g. termsOfService, auth) use the server URLs for base URI determination.

karenetheridge avatar Nov 20 '25 06:11 karenetheridge

@karenetheridge that's correct for 3.0. But not 3.1 or 3.2. OAS 3.0.x does not make a distinction between OAD URIs and API URLs. That was introduced in 3.1.0, and clarfied substantially in 3.1.1.

handrews avatar Nov 20 '25 19:11 handrews