Make internal a trait and not just a tag #531
Merged
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
We've been using the "internal" tag to indicate that something is internal only and should not be exposed to external consumers of a model (i.e., people that don't work at the same company as the service team). The original motivation for using tags and not traits was that there are more dimensions to filtering shapes out of models than just internal vs external. However, the internal/external split is so common that it makes sense to make it a trait, which is more configurable and less based on convention. Tags can still be used for filtering things out of models (for example, an operation could be tagged so that it is only exposed to a particular customer). There are other cases where we migrated away from tags and moved to traits like the `aws.api#controlPlane` and `aws.api#dataPlane` traits. To support this change, a SmithyBuild transform was added that removes shapes marked as internal. Note that this does not perform tree shaking since like other transforms, tree shaking is performed by a dedicated transform.
kstich
reviewed
Aug 18, 2020
mtdowling
force-pushed
the
internal-trait
branch
from
719a3ee to
4516cd8
Compare
kstich
approved these changes
Aug 18, 2020
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.
We've been using the "internal" tag to indicate that something is
internal only and should not be exposed to external consumers of a model
(i.e., people that don't work at the same company as the service team).
The original motivation for using tags and not traits was that there are
more dimensions to filtering shapes out of models than just internal vs
external. However, the internal/external split is so common that it
makes sense to make it a trait, which is more configurable and less
based on convention. Tags can still be used for filtering things out of
models (for example, an operation could be tagged so that it is only
exposed to a particular customer).
There are other cases where we migrated away from tags and moved to
traits like the
aws.api#controlPlaneandaws.api#dataPlanetraits.To support this change, a SmithyBuild transform was added that removes
shapes marked as internal. Note that this does not perform tree shaking
since like other transforms, tree shaking is performed by a dedicated
transform.
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.