feat(type-safe-api): add smithy shape library project for sharing smithy models between apis #875
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 3736e5a. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
cogwirrel
force-pushed
the
feat/smithy-shape-lib
branch
from
9883988 to
8d57c12
Compare
agdimech
approved these changes
Oct 28, 2024
…thy models between apis Adds a `SmithyShapeLibraryProject` which can be used to define Smithy models that can be reused in different APIs. Previously, one would have to declare a `SmithyModelProject` to achieve this, but this needed an ignored `service` to be defined in the model and generated an OpenAPI spec as part of its build, which is unnecessary. Fixes #825
cogwirrel
force-pushed
the
feat/smithy-shape-lib
branch
from
8d57c12 to
3736e5a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a
SmithyShapeLibraryProjectwhich can be used to define Smithy models that can be reused in different APIs.Previously, one would have to declare a
SmithyModelProjectto achieve this, but this needed an ignoredserviceto be defined in the model and generated an OpenAPI spec as part of its build, which is unnecessary.Note this also renames the "Troubleshooting" section of the docs to "FAQ" as it's answering questions rather than explaining common issues.
This change refactors the Smithy projects/components - only snapshot differences for existing smithy projects is the order of files in the
.gitignoreFixes #825