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

Add json-schema builder #1173

Open
stephenliang opened this issue Apr 5, 2022 · 2 comments
Open

Add json-schema builder #1173

stephenliang opened this issue Apr 5, 2022 · 2 comments
Labels
feature-request A feature should be added or improved. OpenAPI

Comments

@stephenliang
Copy link

I saw there is a json-schema smithy builder however smithy doesn't seem to support exporting the models to json-schema as an output and it seems like the json-schema builder is an intermediary for OpenAPI.

The use case I have is to have Smithy create a JSON Schema file which can then be imported into dynamic form builders that consumes JSON Schema. Is there a workaround to enable JSON Schema to be exported?

@kstich
Copy link
Contributor

kstich commented Apr 7, 2022

We use the smithy-jsonschema library as the basis for conversion to OpenAPI (smithy-openapi) and to generate CloudFormation Resource Schemas (smithy-aws-cloudformation). We don't currently offer a straight-to-JSON Schema build output, mostly because so many different outputs build on top of JSON Schema with specific use cases (for example, how do they handle Smithy's service, resource, and operation shapes?)

For your specific use case, you can create a Smithy build plugin by implementing the SmithyBuildPlugin interface and using the JsonSchemaConverter to jump-start the process.

@kstich kstich added the feature-request A feature should be added or improved. label Jul 24, 2023
@kstich
Copy link
Contributor

kstich commented Jul 24, 2023

I think any implementation of this should come after a solution to adding shapes directly to a service, akin to #1061 .

@srchase srchase added the OpenAPI label Aug 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request A feature should be added or improved. OpenAPI
Projects
None yet
Development

No branches or pull requests

3 participants