Impact analysis of introducing OpenAPI v3

[pvdbosch]

In GitLab by @wsalembi on May 13, 2019, 11:02

[pvdbosch]

WIP list of impact on styleguide:

• nullable support => something better than empty placeholder type for JSON Merge Patch? => https://github.com/belgif/rest-guide/issues/189
• styleguide updated media type can be specified per response status code, no more default consumes/produces media types
• support for multiple (simple) types e.g. embedded additionalProperties => https://github.com/belgif/rest-guide/issues/181
• partial updated more ways to provide examples (more than one) in openapi 3.0 => update guidelines https://github.com/belgif/rest-guide/issues/188
• styleguide updated default file name swagger.yaml => openapi.yaml
• styleguide updated more places where deprecated can be specified
• serialization modes of schemas to parameters => see #56

other impact:

• styleguide updated swagger validation rules (plugin doesn't support OpenAPI 3.0 at the moment) => abandoned, removed from guide #34
• links to document how to create URL of a referenced resource based on a response value (e.g. id)

[jpraet]

Can this be closed?

[pvdbosch]

Opened new issues for open points:

• examples: https://github.com/belgif/rest-guide/issues/188. The remaining ones without ticket
• nullable: https://github.com/belgif/rest-guide/issues/189

I haven't seen much use cases where the links feature would be worthwhile; so not following that up