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

support references for examples #625

Closed
fehguy opened this issue Apr 6, 2016 · 5 comments
Closed

support references for examples #625

fehguy opened this issue Apr 6, 2016 · 5 comments
Labels
re-use: ref-everywhere Requests to support referencing in more / all places

Comments

@fehguy
Copy link
Contributor

fehguy commented Apr 6, 2016

Like other items that support the $ref syntax, would like to have $ref support for example values.

@IvanGoncharov
Copy link
Contributor

IvanGoncharov commented Apr 6, 2016

@fehguy There is a problem with it.
example is user supplied data so it can natively have $ref.
For example, API that returns JSON Schemas, or any other JSON data since JSON Reference is widely used.
And I have a real-life example, Google Discovery is API that returned data format based on top of JSON Schema.

@ePaul
Copy link
Contributor

ePaul commented Apr 7, 2016

So I guess this can only work easily if we wrap the actual examples in some other format. Is this sensible?

@ePaul
Copy link
Contributor

ePaul commented Apr 25, 2016

#636 did some changes related to this, but I'm not sure if this finished this issue.

@webron
Copy link
Member

webron commented May 19, 2016

@fehguy - see #666 (comment).

@handrews handrews added the $ref label Feb 24, 2020
@handrews handrews added re-use re-use: ref-everywhere Requests to support referencing in more / all places and removed $ref labels Jan 29, 2024
@handrews
Copy link
Member

PR #636 added Example Objects, and they can be referenced in 3.0. #666 definitively decided that referencing example values (which can look identical to references in some cases) will not be done.

Closing this as resolved with referenceable Example Objects in 3.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
re-use: ref-everywhere Requests to support referencing in more / all places
Projects
None yet
Development

No branches or pull requests

5 participants