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

$schema and $id Support #51

Open
RyanThompson opened this issue Jan 3, 2022 · 3 comments
Open

$schema and $id Support #51

RyanThompson opened this issue Jan 3, 2022 · 3 comments

Comments

@RyanThompson
Copy link

Is it within the scope of this project to add support for things like $schema and $id support? If so, I would gladly add them via PR. Otherwise, I planned on extending this package as it is a great spec generator!

@matthew-inamdar
Copy link
Member

@RyanThompson Is this part of the OpenAPI spec, and could you give some more context around how you'd expect it to work? Cheers, Matt

@RyanThompson
Copy link
Author

It looks like adding OpenAPI v3.1 support should do it: https://apisyouwonthate.com/blog/openapi-v3-1-and-json-schema

Currently: https://apisyouwonthate.com/blog/openapi-json-schema-divergence

@RyanThompson
Copy link
Author

We are using it for: https://streams.dev/

We return the schema of a "stream" (our domain model structures) for API documentation and code generation, but also as a generic interface to 3rd party services.

We originally used it for our universal RESTful API to generate Swagger documentation. But, I have been using it for a general JSON schema interface nicely :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants