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

JSON Reference mention in 3.1.0 #2738

Open
char0n opened this issue Oct 5, 2021 · 2 comments
Open

JSON Reference mention in 3.1.0 #2738

char0n opened this issue Oct 5, 2021 · 2 comments
Assignees
Labels
bug re-use: ref/id resolution how $ref, operationId, or anything else is resolved
Milestone

Comments

@char0n
Copy link
Contributor

char0n commented Oct 5, 2021

Hi all,

There is a single occurrence of JSON reference words withing the 3.1.0 spec:

Note that in the use of operationRef, the escaped forward-slash is necessary when using JSON references.

https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#operationref-examples

This might be confusing, as it's not clear what JSON references really means here. I assume it is refereing to https://datatracker.ietf.org/doc/html/draft-pbryan-zyp-json-ref-03, but I'm not really sure.

IMHO it would be more appropriate to have following sentence:

Note that in the use of operationRef, the escaped forward-slash is necessary when using JSON Pointer in fragment identifier part of the URI

...and have JSON Pointer link to JSON Pointer specification.

@handrews
Copy link
Contributor

handrews commented Nov 6, 2022

You may be interested in the general referencing discussion that has recently started, partially in response to the continued use of the decade-old JSON Reference draft (and yes, in this case and in AsyncAPI, it is referring to draft-pbryan-zyp-json-ref-03).

@handrews handrews added the bug label Jan 27, 2024
@handrews handrews added this to the v3.1.1 milestone Jan 27, 2024
@handrews
Copy link
Contributor

Yeah this should point to JSON Pointer. Added to 3.1.1.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug re-use: ref/id resolution how $ref, operationId, or anything else is resolved
Projects
None yet
Development

No branches or pull requests

2 participants