search

kogosoftwarellc / open-api

A Monorepo of various packages to power OpenAPI in node
MIT License
895 stars 237 forks source link

openapi-types: support x- specification extensions everywhere without a pre-existing index signature #899

Open mitchell-merry opened 8 months ago

mitchell-merry commented 8 months ago

Fixes #768

Per the Swagger 2.0, OpenAPI 3.0, and OpenAPI 3.1 specs, most objects should support ^x- properties for the purposes of extending the specification. However, openapi-types does not support these yet.

This PR introduces the Extensible interface, which is used to specify the types that should support this. It also bumps the prettier package to 2.2.0, which is the earliest version which supports TypeScript templating strings.

As is, this PR contains breaking changes to the types, to better fit the specfication! See details in the comments.

Interested to hear your thoughts!

jsdevel commented 6 months ago

@mitchell-merry can you resolve conflicts and ensure a passing build?

mitchell-merry commented 6 months ago

Merge conflict resolved, though it looks like you need to approve the build to be run