openapi-preprocessor icon indicating copy to clipboard operation
openapi-preprocessor copied to clipboard
verified publisher icon dolmen-go

$ref restriction is non-standard; breaks existing usage

Open freddrake opened this issue 5 years ago • 3 comments

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.

freddrake avatar Aug 24 '20 17:08 freddrake

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 avatar Dec 11 '20 10:12 dolmen

@freddrake Ping

dolmen avatar Mar 11 '21 11:03 dolmen

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

dolmen avatar Mar 15 '21 13:03 dolmen