From 33994de6be3d8d793ebed0f974c2c94303cb9b94 Mon Sep 17 00:00:00 2001 From: kstich Date: Mon, 4 May 2020 12:58:20 -0700 Subject: [PATCH] Fix various link and changelog issues --- CHANGELOG.md | 16 ++++++++++------ smithy-aws-apigateway-traits/README.md | 2 +- smithy-aws-iam-traits/README.md | 2 +- .../model/restJson1/endpoint-host-trait.smithy | 2 +- .../model/restJson1/http-headers.smithy | 2 +- .../model/restJson1/http-labels.smithy | 2 +- .../model/restJson1/http-payload.smithy | 2 +- .../model/restJson1/http-prefix-headers.smithy | 4 ++-- .../model/restJson1/http-query.smithy | 2 +- .../model/restXml/endpoint-host-trait.smithy | 2 +- .../model/restXml/http-headers.smithy | 2 +- .../model/restXml/http-labels.smithy | 2 +- .../model/restXml/http-payload.smithy | 2 +- .../model/restXml/http-prefix-headers.smithy | 4 ++-- .../model/restXml/http-query.smithy | 2 +- smithy-aws-traits/README.md | 2 +- 16 files changed, 27 insertions(+), 23 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4fcd819f4..7c9a2deb4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -27,11 +27,11 @@ from Smithy `Node`s. ([#301](https://github.com/awslabs/smithy/pull/301)) #### Trait updates * Individual protocols are now defined as individual traits that are annotated with -[the `protocolDefinition` trait.](https://awslabs.github.io/smithy/spec/core/protocol-traits.html#protocoldefinition-trait) [BC] ([#273](https://github.com/awslabs/smithy/pull/273), [#280](https://github.com/awslabs/smithy/pull/280), [#379](https://github.com/awslabs/smithy/pull/379), [#390](https://github.com/awslabs/smithy/pull/390)) - * Previously listed [AWS protocols now have trait implementations.](https://awslabs.github.io/smithy/spec/aws/index.html#aws-protocols) +[the `protocolDefinition` trait.](https://awslabs.github.io/smithy/1.0/spec/core/protocol-traits.html#protocoldefinition-trait) [BC] ([#273](https://github.com/awslabs/smithy/pull/273), [#280](https://github.com/awslabs/smithy/pull/280), [#379](https://github.com/awslabs/smithy/pull/379), [#390](https://github.com/awslabs/smithy/pull/390)) + * Previously listed [AWS protocols now have trait implementations.](https://awslabs.github.io/smithy/1.0/spec/aws/index.html#aws-protocols) * Individual authentication schemes are now defined as individual traits that are annotated with -[the `authDefinition` trait.](https://awslabs.github.io/smithy/spec/core/auth-traits.html#authdefinition-trait) [BC] ([#273](https://github.com/awslabs/smithy/pull/273), [#280](https://github.com/awslabs/smithy/pull/280)) - * Previously listed [authentication schemes now have trait implementations.](https://awslabs.github.io/smithy/spec/core/auth-traits.html) +[the `authDefinition` trait.](https://awslabs.github.io/smithy/1.0/spec/core/auth-traits.html#authdefinition-trait) [BC] ([#273](https://github.com/awslabs/smithy/pull/273), [#280](https://github.com/awslabs/smithy/pull/280)) + * Previously listed [authentication schemes now have trait implementations.](https://awslabs.github.io/smithy/1.0/spec/core/auth-traits.html) * The `smithy.api#enum` trait is now a list of enum definitions instead of a map of string keys to enum definitions to improve clarity and encourage adding more properties to definitions. [BC] ([#326](https://github.com/awslabs/smithy/pull/326)) * The `aws.api#streaming` trait is now applied to shapes directly instead of members. [BC] ([#340](https://github.com/awslabs/smithy/pull/340)) @@ -132,6 +132,8 @@ reference lookups. ([#287](https://github.com/awslabs/smithy/pull/287)) ### Breaking changes +All changes listed in this heading and any sub-headings are breaking changes. + * The `BooleanTrait` abstract class in `smithy-model` was renamed `AnnotationTrait`. ([#381](https://github.com/awslabs/smithy/pull/381)) * The traits in the `aws.apigateway` namespace have moved from `smithy-aws-traits` to the `smithy-aws-apigateway-traits` package for more granular use. ([#322](https://github.com/awslabs/smithy/pull/322)) @@ -147,11 +149,13 @@ reference lookups. ([#287](https://github.com/awslabs/smithy/pull/287)) `Pattern` class. ([#315](https://github.com/awslabs/smithy/pull/315)) * Removed the `Triple` class from `smithy-utils`. ([#313](https://github.com/awslabs/smithy/pull/313)) * Normalized class names for OpenAPI `SecurityScemeConverter` implementations. ([#291](https://github.com/awslabs/smithy/pull/291)) +* Removed alias functionality from `software.amazon.smithy.build.SmithyBuildPlugin` and + `software.amazon.smithy.build.ProjectionTransformer`. ([#409](https://github.com/awslabs/smithy/pull/409)) * Removed `software.amazon.smithy.model.shapes.Shape#visitor` and `software.amazon.smithy.model.shapes.ShapeVisitor$Builder`. Use - `software.amazon.smithy.model.shapes.ShapeVisitor$Default` instead [BC]. + `software.amazon.smithy.model.shapes.ShapeVisitor$Default` instead. ([#413](https://github.com/awslabs/smithy/pull/413)) * `software.amazon.smithy.model.Model#getTraitDefinitions` and `getTraitShapes` were removed in favor of - `software.amazon.smithy.model.Model#getShapesWithTrait` [BC] ([#412](https://github.com/awslabs/smithy/pull/412)) + `software.amazon.smithy.model.Model#getShapesWithTrait`. ([#412](https://github.com/awslabs/smithy/pull/412)) #### Deprecation cleanup diff --git a/smithy-aws-apigateway-traits/README.md b/smithy-aws-apigateway-traits/README.md index 880de7291..42be71c0f 100644 --- a/smithy-aws-apigateway-traits/README.md +++ b/smithy-aws-apigateway-traits/README.md @@ -1,4 +1,4 @@ # Smithy AWS API Gateway traits -See the [Smithy specification](https://awslabs.github.io/smithy/spec/) +See the [Smithy specification](https://awslabs.github.io/smithy/1.0/spec/) for details on how these traits are used. diff --git a/smithy-aws-iam-traits/README.md b/smithy-aws-iam-traits/README.md index 3531d508b..352a3d319 100644 --- a/smithy-aws-iam-traits/README.md +++ b/smithy-aws-iam-traits/README.md @@ -1,4 +1,4 @@ # Smithy AWS IAM traits -See the [Smithy specification](https://awslabs.github.io/smithy/spec/) +See the [Smithy specification](https://awslabs.github.io/smithy/1.0/spec/) for details on how these traits are used. diff --git a/smithy-aws-protocol-tests/model/restJson1/endpoint-host-trait.smithy b/smithy-aws-protocol-tests/model/restJson1/endpoint-host-trait.smithy index 08fcbf0da..d30ab5398 100644 --- a/smithy-aws-protocol-tests/model/restJson1/endpoint-host-trait.smithy +++ b/smithy-aws-protocol-tests/model/restJson1/endpoint-host-trait.smithy @@ -1,5 +1,5 @@ // This file defines test cases that change the endpoint based on the endpoint trait. -// See: https://awslabs.github.io/smithy/spec/core.html#endpoint-trait +// See: https://awslabs.github.io/smithy/1.0/spec/core.html#endpoint-trait $version: "1.0.0" diff --git a/smithy-aws-protocol-tests/model/restJson1/http-headers.smithy b/smithy-aws-protocol-tests/model/restJson1/http-headers.smithy index 21e0f0760..51c211df8 100644 --- a/smithy-aws-protocol-tests/model/restJson1/http-headers.smithy +++ b/smithy-aws-protocol-tests/model/restJson1/http-headers.smithy @@ -1,5 +1,5 @@ // This file defines test cases that test HTTP header bindings. -// See: https://awslabs.github.io/smithy/spec/http.html#httpheader-trait +// See: https://awslabs.github.io/smithy/1.0/spec/http.html#httpheader-trait $version: "1.0.0" diff --git a/smithy-aws-protocol-tests/model/restJson1/http-labels.smithy b/smithy-aws-protocol-tests/model/restJson1/http-labels.smithy index 480ef6ba6..a4364e982 100644 --- a/smithy-aws-protocol-tests/model/restJson1/http-labels.smithy +++ b/smithy-aws-protocol-tests/model/restJson1/http-labels.smithy @@ -1,5 +1,5 @@ // This file defines test cases that test HTTP URI label bindings. -// See: https://awslabs.github.io/smithy/spec/http.html#httplabel-trait +// See: https://awslabs.github.io/smithy/1.0/spec/http.html#httplabel-trait $version: "1.0.0" diff --git a/smithy-aws-protocol-tests/model/restJson1/http-payload.smithy b/smithy-aws-protocol-tests/model/restJson1/http-payload.smithy index 2e6b57ccc..eaea3e1c0 100644 --- a/smithy-aws-protocol-tests/model/restJson1/http-payload.smithy +++ b/smithy-aws-protocol-tests/model/restJson1/http-payload.smithy @@ -1,5 +1,5 @@ // This file defines test cases that test HTTP payload bindings. -// See: https://awslabs.github.io/smithy/spec/http.html#httppayload-trait +// See: https://awslabs.github.io/smithy/1.0/spec/http.html#httppayload-trait $version: "1.0.0" diff --git a/smithy-aws-protocol-tests/model/restJson1/http-prefix-headers.smithy b/smithy-aws-protocol-tests/model/restJson1/http-prefix-headers.smithy index ed163704b..1c3fdb0f0 100644 --- a/smithy-aws-protocol-tests/model/restJson1/http-prefix-headers.smithy +++ b/smithy-aws-protocol-tests/model/restJson1/http-prefix-headers.smithy @@ -1,5 +1,5 @@ // This file defines test cases that test httpPrefix headers. -// See: https://awslabs.github.io/smithy/spec/http.html#httpprefixheaders-trait +// See: https://awslabs.github.io/smithy/1.0/spec/http.html#httpprefixheaders-trait $version: "1.0.0" @@ -12,7 +12,7 @@ use smithy.test#httpResponseTests /// This examples adds headers to the input of a request and response by prefix. @readonly @http(uri: "/HttpPrefixHeaders", method: "GET") -@externalDocumentation("httpPrefixHeaders Trait": "https://awslabs.github.io/smithy/spec/http.html#httpprefixheaders-trait") +@externalDocumentation("httpPrefixHeaders Trait": "https://awslabs.github.io/smithy/1.0/spec/http.html#httpprefixheaders-trait") operation HttpPrefixHeaders { input: HttpPrefixHeadersInputOutput, output: HttpPrefixHeadersInputOutput diff --git a/smithy-aws-protocol-tests/model/restJson1/http-query.smithy b/smithy-aws-protocol-tests/model/restJson1/http-query.smithy index 1d00f570c..8385f01cd 100644 --- a/smithy-aws-protocol-tests/model/restJson1/http-query.smithy +++ b/smithy-aws-protocol-tests/model/restJson1/http-query.smithy @@ -1,5 +1,5 @@ // This file defines test cases that test HTTP query string bindings. -// See: https://awslabs.github.io/smithy/spec/http.html#httpquery-trait +// See: https://awslabs.github.io/smithy/1.0/spec/http.html#httpquery-trait $version: "1.0.0" diff --git a/smithy-aws-protocol-tests/model/restXml/endpoint-host-trait.smithy b/smithy-aws-protocol-tests/model/restXml/endpoint-host-trait.smithy index 85ee91ee9..662caa34f 100644 --- a/smithy-aws-protocol-tests/model/restXml/endpoint-host-trait.smithy +++ b/smithy-aws-protocol-tests/model/restXml/endpoint-host-trait.smithy @@ -1,5 +1,5 @@ // This file defines test cases that change the endpoint based on the endpoint trait. -// See: https://awslabs.github.io/smithy/spec/core.html#endpoint-trait +// See: https://awslabs.github.io/smithy/1.0/spec/core.html#endpoint-trait $version: "1.0.0" diff --git a/smithy-aws-protocol-tests/model/restXml/http-headers.smithy b/smithy-aws-protocol-tests/model/restXml/http-headers.smithy index 96211c90b..5779dd4fc 100644 --- a/smithy-aws-protocol-tests/model/restXml/http-headers.smithy +++ b/smithy-aws-protocol-tests/model/restXml/http-headers.smithy @@ -1,5 +1,5 @@ // This file defines test cases that test HTTP header bindings. -// See: https://awslabs.github.io/smithy/spec/http.html#httpheader-trait +// See: https://awslabs.github.io/smithy/1.0/spec/http.html#httpheader-trait $version: "1.0.0" diff --git a/smithy-aws-protocol-tests/model/restXml/http-labels.smithy b/smithy-aws-protocol-tests/model/restXml/http-labels.smithy index 8ef77c946..d9cedf88a 100644 --- a/smithy-aws-protocol-tests/model/restXml/http-labels.smithy +++ b/smithy-aws-protocol-tests/model/restXml/http-labels.smithy @@ -1,5 +1,5 @@ // This file defines test cases that test HTTP URI label bindings. -// See: https://awslabs.github.io/smithy/spec/http.html#httplabel-trait +// See: https://awslabs.github.io/smithy/1.0/spec/http.html#httplabel-trait $version: "1.0.0" diff --git a/smithy-aws-protocol-tests/model/restXml/http-payload.smithy b/smithy-aws-protocol-tests/model/restXml/http-payload.smithy index 35030574f..0eee3c483 100644 --- a/smithy-aws-protocol-tests/model/restXml/http-payload.smithy +++ b/smithy-aws-protocol-tests/model/restXml/http-payload.smithy @@ -1,5 +1,5 @@ // This file defines test cases that test HTTP payload bindings. -// See: https://awslabs.github.io/smithy/spec/http.html#httppayload-trait +// See: https://awslabs.github.io/smithy/1.0/spec/http.html#httppayload-trait $version: "1.0.0" diff --git a/smithy-aws-protocol-tests/model/restXml/http-prefix-headers.smithy b/smithy-aws-protocol-tests/model/restXml/http-prefix-headers.smithy index 1d792c201..607621bba 100644 --- a/smithy-aws-protocol-tests/model/restXml/http-prefix-headers.smithy +++ b/smithy-aws-protocol-tests/model/restXml/http-prefix-headers.smithy @@ -1,5 +1,5 @@ // This file defines test cases that test httpPrefix headers. -// See: https://awslabs.github.io/smithy/spec/http.html#httpprefixheaders-trait +// See: https://awslabs.github.io/smithy/1.0/spec/http.html#httpprefixheaders-trait $version: "1.0.0" @@ -12,7 +12,7 @@ use smithy.test#httpResponseTests /// This examples adds headers to the input of a request and response by prefix. @readonly @http(uri: "/HttpPrefixHeaders", method: "GET") -@externalDocumentation("httpPrefixHeaders Trait": "https://awslabs.github.io/smithy/spec/http.html#httpprefixheaders-trait") +@externalDocumentation("httpPrefixHeaders Trait": "https://awslabs.github.io/smithy/1.0/spec/http.html#httpprefixheaders-trait") operation HttpPrefixHeaders { input: HttpPrefixHeadersInputOutput, output: HttpPrefixHeadersInputOutput diff --git a/smithy-aws-protocol-tests/model/restXml/http-query.smithy b/smithy-aws-protocol-tests/model/restXml/http-query.smithy index 2680fd16f..380f34835 100644 --- a/smithy-aws-protocol-tests/model/restXml/http-query.smithy +++ b/smithy-aws-protocol-tests/model/restXml/http-query.smithy @@ -1,5 +1,5 @@ // This file defines test cases that test HTTP query string bindings. -// See: https://awslabs.github.io/smithy/spec/http.html#httpquery-trait +// See: https://awslabs.github.io/smithy/1.0/spec/http.html#httpquery-trait $version: "1.0.0" diff --git a/smithy-aws-traits/README.md b/smithy-aws-traits/README.md index c780a9864..d687d70d3 100644 --- a/smithy-aws-traits/README.md +++ b/smithy-aws-traits/README.md @@ -2,5 +2,5 @@ Provides traits and validators that are used by most AWS services. -See the [Smithy specification](https://awslabs.github.io/smithy/spec/) +See the [Smithy specification](https://awslabs.github.io/smithy/1.0/spec/) for details on how these traits are used.