eclipse / microprofile-open-api

Microprofile open api
Apache License 2.0
131 stars 81 forks source link

Deviation in openapi file postfix definition #553

Closed JanWesterkamp-iJUG closed 1 year ago

JanWesterkamp-iJUG commented 1 year ago

There are two sections that define the openapi file postfix (.yaml, .yml,.json), but they are not consistent:

https://github.com/eclipse/microprofile-open-api/blob/master/spec/src/main/asciidoc/microprofile-openapi-spec.asciidoc#location-and-formats

In sentence "Vendors are required to fetch a single document named openapi with an extension of yml, yaml or json, inside the application module’s root META-INF folder.".

and

https://github.com/eclipse/microprofile-open-api/blob/master/spec/src/main/asciidoc/microprofile-openapi-spec.asciidoc#overview

In list element "one of the allowed static files is present, i.e. META-INF/openapi.(json|yaml)".

The last should be changed to "one of the allowed static files is present, i.e. META-INF/openapi.(json|yaml|yml)" or in the first occurence the "yml" should be removed instead (but that might be a breaking change potentially).