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

$ref restriction is non-standard; breaks existing usage #7

Open
freddrake opened this issue Aug 24, 2020 · 3 comments
Open

$ref restriction is non-standard; breaks existing usage #7

freddrake opened this issue Aug 24, 2020 · 3 comments
Labels
help wanted Extra attention is needed

Comments

@freddrake
Copy link

The restriction on where $ref'd content is inserted means that common examples of $ref usage cannot be used with this preprocessor.

That means an existing project really can't adopt the additional features from this preprocessor without re-structuring or replacing all $ref uses with $inline or $merge.

@dolmen
Copy link
Member

dolmen commented Dec 11, 2020

Please give me an example of those $ref usages which are not supported. Links to real world specs would be welcome.

I have designed openapi-preprocessor about 4 years ago, at a time where only Swagger/OpenAPI 2.x existed and at that time $ref was quite limited. I would be happy to remove some barriers which were designed to protect users.

@dolmen dolmen added the help wanted Extra attention is needed label Mar 11, 2021
@dolmen
Copy link
Member

dolmen commented Mar 11, 2021

@freddrake Ping

@dolmen
Copy link
Member

dolmen commented Mar 15, 2021

Reference: http://spec.openapis.org/oas/v3.1.0#reference-object

Barriers to remove:

  • do not block use of property summary
  • do not block use of property description

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants