Merged
Conversation
mtdowling
requested changes
Apr 23, 2020
This commit updates the changelog entry for the 1.0.0 release with all contents through PR 394. Breaking changes are annotated with [BC] or contained in the Breaking Changes section.
mtdowling
approved these changes
Apr 23, 2020
This file contains hidden or 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
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.
This commit updates the changelog entry for the 1.0.0 release with
contents through PR 394. Breaking changes are annotated with
[BC] or contained in the Breaking Changes section.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
Ed. Note: The minor line break issues below are related to copy/paste into the PR description.
1.0.0 (2020-??-??)
Note: Changes marked with "[BC]" are breaking changes more accurately described in the
specific section. A list of further intended breaking changes have a specific section near
the end of this entry.
Features
General
1.0.0and contains several updates: [BC] (#357, #381){}instead oftrue.trueornullvalues.from Smithy
Nodes. (#301)Shape. (#314)@SmithyUnstableApi,@SmithyInternalApiand@SmithyGeneratedJava annotations. (#297)NodeValidationVisitors are marked as internal and/or unstable. (#375)Trait updates
the
protocolDefinitiontrait. [BC] (#273, #280, #379, #390)the
authDefinitiontrait. [BC] (#273, #280)smithy.api#enumtrait is now a list of enum definitions instead of a map of string keys toenum definitions to improve clarity and encourage adding more properties to definitions. [BC] (#326)
aws.api#streamingtrait is now applied to shapes directly instead of members. [BC] (#340)smithy.api#eventStreamtrait has been removed. Event streams are now indicated by applyingthe
smithy.api#streamingtrait to unions. [BC] (#365)smithy.api#requiresLengthtrait has been split out of thesmithy.api#streamingtrait toimprove clarity around event stream modeling. [BC] (#368)
smithy.api#externalDocumentationtrait is now a map instead of a single string to allow formultiple links per trait. [BC] (#363)
smithy.api#noReplacetrait to indicate a PUT lifecycle operation cannot replace theexisting resource. (#351)
smithy.api#unstabletrait to indicate a shape MAY change. (#290)aws.protocols#httpContentMd5trait to indicate an operation requrest requires asending a Content-MD5 header. (#372)
aws.api#unsignedPayloadto be an annotation. [BC] (#270)contain those properties when serialized. (#385)
Selector updates
Selectors have received significant updates: (#388)
|, including list/object values and objectkeys, was added.
traitrelationship has been added. (#384)~>, has been added. (#386)!=, was added.>,>=,<,<=) were added.:eachselector is now:isfor clarity. [BC]Validation updates
UnreferencedShapevalidator has moved tosmithy-modeland is now always run. [BC] (#319)JSON Schema conversion
The conversion to JSON schema was significantly overhauled. [BC] (#274)
OpenAPI conversion
The conversion to OpenAPI was significantly overhauled. [BC] (#275)
API Gateway OpenAPI conversion
The API Gateway specific OpenAPI mappers have been updated. [BC] (#367)
ApiGatewayMapperinterface was added, allowing mappers to control which API Gateway APItype(s) they support.
Bug Fixes
conversions. (#275)
applystatements wouldn't resolve target shapes properly in some cases. (#287)smithy.api#titletrait. (#387)smithy.api#httpApiKeyAuthtrait and its related conversions. (#291)Optimizations
TraitTargetValidatornow performs as few checks on and selections of the entire model. (#389)jackson-corewas replaced with a vendored version ofminimal-jsonto reducethe chances of dependency conflicts. [BC] (#323)
reference lookups. (#287)
Breaking changes
BooleanTraitabstract class insmithy-modelwas renamedAnnotationTrait. (#381)aws.apigatewaynamespace have moved fromsmithy-aws-traitsto thesmithy-aws-apigateway-traitspackage for more granular use. (#322)aws.iamnamespace have moved fromsmithy-aws-traitsto thesmithy-aws-iam-traitspackage for more granular use. (#322)aws.api#ec2QueryNametrait has moved toaws.protocols#ec2QueryName. (#286)aws.api#unsignedPayloadtrait has moved toaws.auth#unsignedPayload. (#286)smithy-codegen-freemarkerpackage has been removed. (#382)Patternclass is renamed toSmithyPatternto remove the conflict with Java's regexPatternclass. (#315)Tripleclass fromsmithy-utils. (#313)SecurityScemeConverterimplementations. (#291)Deprecation cleanup
NodeFactoryinterface has been removed. (#265)ShapeIndexclass and all related APIs have been removed. (#266)0.4.0model version has been removed. (#267)aws.api#servicetrait no longer supports the deprecatedsdkServiceId,arnService, orproductNameproperties. (#268)TemplateEngineandDefaultDataTemplateEnginehave been removed. (#268)smithy.validatorsandsmithy.suppressionsare no loner used as aliases forvalidators and suppressions. (#268)
smithy.api#referencesandsmithy.api#idReftraits no longer support relative shape IDs. (#268)Documentation
A significant overhaul of the specification and guides has been completed. This includes a better
flow to the spec, more complete guides, deeper documentation of AWS specific components, and a
complete redesign. Many direct links to components of the documentation will have changed.