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

Resolving Reference Object #138

Closed
gcatanese opened this issue Feb 2, 2024 · 2 comments · Fixed by #146
Closed

Resolving Reference Object #138

gcatanese opened this issue Feb 2, 2024 · 2 comments · Fixed by #146

Comments

@gcatanese
Copy link

The Reference Object section suggests to see the rules for resolving Relative References from the OpenAPI Specification. However, OpenAPI relative references are resolved using the ServerObject as a Base URL.

I think this section might need some clarity:

  • use relative references from within the Workflow Specification file?
  • use relative references within the SourceDescriptions?
  • respect absolute URLs to refer to external resources?
@handrews
Copy link
Member

handrews commented Feb 2, 2024

@gcatanese I see the problem. Short version: Follow RFC 3986 and use the retrieval URI of the document as the base URI.

@frankkilcommins that section needs to reference the "Relative References in URIs" section, which applies to $ref. The "Relative References in URLs" section apples to Server URLs. I've filed OAI/OpenAPI-Specification#3545 to clarify this in OAS 3.1.1.

@handrews
Copy link
Member

handrews commented Feb 7, 2024

Actually, I think this is even simpler- the fragment syntax for the reference link changed, so it was dropping you in the wrong place in the OAS 3.1 spec. it was actually referencing the correct section. PR #146 should fix it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants