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

Is the use of $ref compliant with OpenAPI 3.0.3 specification? #457

Open
davidmoten opened this issue May 5, 2023 · 2 comments
Open

Is the use of $ref compliant with OpenAPI 3.0.3 specification? #457

davidmoten opened this issue May 5, 2023 · 2 comments
Assignees
Labels
triage me I really want to be triaged. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.

Comments

@davidmoten
Copy link

davidmoten commented May 5, 2023

I don't see mention of support in the OpenAPI specification 3.0.3 or 3.1.0 for using $ref at the levels shown below in this top level index.yml:

paths:
$ref: "./paths/_index.yml"
components:
parameters:
$ref: "./parameters/_index.yml"
schemas:
$ref: "./schemas/_index.yml"

The reason I raise this is that I don't see these fields available in the results from parsing your specification with the java artifact io.swagger.parser.v3:swagger-parser:2.1.13 and after checking the specification I'm supposing your yaml specification is not compliant with the standard. Is that the case?

@davidmoten davidmoten added triage me I really want to be triaged. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. labels May 5, 2023
@wangela
Copy link
Member

wangela commented May 5, 2023

If you would like to upvote the priority of this issue, please comment below or react with 👍 so we can see what is popular when we triage.

@davidmoten Thank you for opening this issue. 🙏
Please check out these other resources that might help you get to a resolution in the meantime:

This is an automated message, feel free to ignore.

@amuramoto
Copy link
Member

Correct - there are currently quite a few misuses of $ref in the spec in this repo. I've been working on ferreting them out, but it will take some time since it's being done as part of a larger overhaul of this repo. I'll leave this issue open until that is resolved

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
triage me I really want to be triaged. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
Projects
None yet
Development

No branches or pull requests

3 participants