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

Remove abbreviation from aws.api#service docs #532

Merged
merged 1 commit into from
Aug 19, 2020
Merged

Conversation

mtdowling
Copy link
Member

The abbreviation property in aws.api#service was not actually supported
by the underlying Smithy model for the trait. We intended to remove this
from Smithy 1.0, but it was a miss. The abbreviation property is no
longer necessary since we now have the service ID property via sdkId.
The abbreviation property was also problematic since lots of entries
across services didn't make sense (like a value longer than the title).
Trying to define an abbreviation will emit a warning but will not break
builds (this is actually the current behavior too since it wasn't
defined in the model).

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.

The abbreviation property in aws.api#service was not actually supported
by the underlying Smithy model for the trait. We intended to remove this
from Smithy 1.0, but it was a miss. The abbreviation property is no
longer necessary since we now have the service ID property via sdkId.
The abbreviation property was also problematic since lots of entries
across services didn't make sense (like a value longer than the title).
Trying to define an abbreviation will emit a warning but will not break
builds (this is actually the current behavior too since it wasn't
defined in the model).
Copy link
Contributor

@JordonPhillips JordonPhillips left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should add the deprecated trait to the abbreviation member too

@mtdowling mtdowling merged commit 2fefe1e into master Aug 19, 2020
@mtdowling mtdowling deleted the remove-abbreviation branch September 14, 2020 22:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants