Add unstable, internal, and generated annotations #297
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
These annotations allows different parts of the Smithy implementation to evolve at their own pace and better communicate how end users should use the code. The SmithyUnstableApi annotations indicates that an API is subject to change and should be considered experimental. The SmithyInternalApi annotation indicates that an API should not be relied on by end users outside of the Smithy software.amazon.smithy packages. The SmithyGenerated annotation indicates that a package or type was generated and should not be edited by hand.
kstich
approved these changes
Mar 4, 2020
Merged
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.
These annotations allows different parts of the Smithy implementation to
evolve at their own pace and better communicate how end users should use
the code. The SmithyUnstableApi annotations indicates that an API is
subject to change and should be considered experimental. The
SmithyInternalApi annotation indicates that an API should not be relied
on by end users outside of the Smithy software.amazon.smithy packages.
The SmithyGenerated annotation indicates that a package or type was
generated and should not be edited by hand.
Issue #, if available:
Description of changes:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.