Make version control statement about requirements

The `$version` control statement can now be set to only a major version (e.g., "1") to indicate that an implementation must support a version >= 1 and < 2. `$version` can now be set to `major.minor` (e.g., "1.1") to indicate that an implementation must support a version >= 1.1 and < 2.
kggilmer · May 4, 2020 · 34d51e3 · 34d51e3
1 parent 33994de
commit 34d51e3
Show file tree

Hide file tree

Showing 370 changed files with 533 additions and 529 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,7 +10,7 @@ the end of this entry.
 
 #### General
 
-* The model format version has beeen updated to `1.0.0` and contains several updates: [BC] ([#357](https://github.com/awslabs/smithy/pull/357), [#381](https://github.com/awslabs/smithy/pull/381))
+* The model format version has beeen updated to `1.0` and contains several updates: [BC] ([#357](https://github.com/awslabs/smithy/pull/357), [#381](https://github.com/awslabs/smithy/pull/381))
   * The JSON AST representation requires describing annotation traits as `{}` instead of `true`.
   * Annotation traits in the IDL are now provided as `@foo` or `@foo()`. Explicit `@foo(true)` and
   `@foo(null)` support was removed.
@@ -23,6 +23,9 @@ from Smithy `Node`s. ([#301](https://github.com/awslabs/smithy/pull/301))
 * Added expect* methods to the base `Shape`. ([#314](https://github.com/awslabs/smithy/pull/314))
 * Added `@SmithyUnstableApi`, `@SmithyInternalApi` and `@SmithyGenerated` Java annotations. ([#297](https://github.com/awslabs/smithy/pull/297))
 * `NodeValidationVisitor`s are marked as internal and/or unstable. ([#375](https://github.com/awslabs/smithy/pull/375))
+* The `$version` control statement can now be set to only a major version (e.g., "1") to indicate that an
+  implementation must support a version >= 1 and < 2. `$version` can now be set to `major.minor` (e.g., "1.1")
+  to indicate that an implementation must support a version >= 1.1 and < 2.
 
 #### Trait updates
 
@@ -321,7 +324,7 @@ complete redesign. Many direct links to components of the documentation will hav
 
 * Fix collection and gradle doc issues ([#145](https://github.com/awslabs/smithy/pull/145))
 * Make `AuthorizerDefinition` definition private ([#146](https://github.com/awslabs/smithy/pull/146))
-* Fix put handling on `ResourceShape` ([#158](https://github.com/awslabs/smithy/pull/158)) 
+* Fix put handling on `ResourceShape` ([#158](https://github.com/awslabs/smithy/pull/158))
 * Fix parse error when `apply` is at eof ([#159](https://github.com/awslabs/smithy/pull/159))
 * Prevent `list`/`set` member from targeting container ([#162](https://github.com/awslabs/smithy/pull/162))
 * Allow model assembling from symlink model files / directory ([#163](https://github.com/awslabs/smithy/pull/163))
diff --git a/docs/source/1.0/guides/model-linters.rst b/docs/source/1.0/guides/model-linters.rst
@@ -79,7 +79,7 @@ Example:
 
 .. code-block:: smithy
 
-    $version: "1.0.0"
+    $version: "1.0"
 
     metadata validators = [
         {name: "AbbreviationName"}
@@ -121,7 +121,7 @@ Example:
 
 .. code-block:: smithy
 
-    $version: "1.0.0"
+    $version: "1.0"
 
     metadata validators = [
         {name: "CamelCase"}
@@ -183,7 +183,7 @@ Example:
 
 .. code-block:: smithy
 
-    $version: "1.0.0"
+    $version: "1.0"
 
     metadata validators = [{
         id: "FooReservedWords"
@@ -338,7 +338,7 @@ Example:
 
 .. code-block:: smithy
 
-    $version: "1.0.0"
+    $version: "1.0"
 
     metadata validators = [{
         name: "StandardOperationVerb",
@@ -672,7 +672,7 @@ example warns each time the word "meow" appears in documentation:
 
 .. code-block:: smithy
 
-    $version: "1.0.0"
+    $version: "1.0"
 
     metadata validators = [
         {
@@ -691,7 +691,7 @@ example warns each time the word "meow" appears in documentation:
 
     .. code-block:: smithy
 
-        $version: "1.0.0"
+        $version: "1.0"
 
         metadata validators = [
             {

diff --git a/docs/source/1.0/guides/style-guide.rst b/docs/source/1.0/guides/style-guide.rst
@@ -19,7 +19,7 @@ Smithy models SHOULD resemble the following example:
 
 .. code-block:: smithy
 
-    $version: "1.0.0"
+    $version: "1.0"
 
     metadata validators = []
     metadata suppressions = []

diff --git a/docs/source/1.0/spec/aws/amazon-apigateway.rst b/docs/source/1.0/spec/aws/amazon-apigateway.rst
@@ -60,7 +60,7 @@ The following example sets the ``X-API-Key`` header as the API key source.
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "smithy.example#Weather": {
                     "type": "service",
@@ -295,7 +295,7 @@ Then following example enables request validation on a service:
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "smithy.example#Weather": {
                     "type": "service",
@@ -423,7 +423,7 @@ operation within the service.
 .. code-block:: json
 
     {
-        "smithy": "1.0.0",
+        "smithy": "1.0",
         "shapes": {
             "smithy.example#Weather": {
                 "type": "service",
@@ -535,7 +535,7 @@ The following example defines an operation that uses a mock integration.
 .. code-block:: json
 
     {
-        "smithy": "1.0.0",
+        "smithy": "1.0",
         "shapes": {
             "smithy.example#MyOperation": {
                 "type": "operation",

diff --git a/docs/source/1.0/spec/aws/aws-auth.rst b/docs/source/1.0/spec/aws/aws-auth.rst
@@ -60,7 +60,7 @@ Trait value
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "aws.fooBaz#FooBaz": {
                     "type": "service",
@@ -116,7 +116,7 @@ operation MUST NOT be used as part of the request signature calculation:
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "smithy.example#PutThings": {
                     "type": "operation",

diff --git a/docs/source/1.0/spec/aws/aws-core.rst b/docs/source/1.0/spec/aws/aws-core.rst
@@ -39,7 +39,7 @@ The following example defines an AWS service that uses the default values of
 
     .. code-tab:: smithy
 
-        $version: "1.0.0"
+        $version: "1.0"
         namespace aws.fooBaz
 
         use aws.api#service
@@ -52,7 +52,7 @@ The following example defines an AWS service that uses the default values of
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "aws.fooBaz#FooBaz": {
                     "type": "service",
@@ -72,7 +72,7 @@ The following example provides explicit values for all properties:
 
     .. code-tab:: smithy
 
-        $version: "1.0.0"
+        $version: "1.0"
         namespace aws.fooBaz
 
         use aws.api#service
@@ -89,7 +89,7 @@ The following example provides explicit values for all properties:
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "aws.fooBaz#FooBaz": {
                     "type": "service",
@@ -386,7 +386,7 @@ For example, given the following service:
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "smithy.example#FooBaz": {
                     "type": "service",
@@ -452,7 +452,7 @@ resource.
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "smithy.example#MyResource": {
                     "type": "resource",
@@ -550,7 +550,7 @@ referenced resource.
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "smithy.example#SomeResourceId": {
                     "type": "string",
@@ -573,7 +573,7 @@ previous example:
 
     .. code-tab:: smithy
 
-        $version: "1.0.0"
+        $version: "1.0"
         namespace smithy.example
 
         use aws.api#arnReference
@@ -584,7 +584,7 @@ previous example:
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "smithy.example#SomeResourceId": {
                     "type": "string",
@@ -638,7 +638,7 @@ structure, union, or collection unless overridden.
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "smithy.example#MyStructure": {
                     "type": "structure",
@@ -764,7 +764,7 @@ plane unless an operation or resource is marked with the
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "smithy.example#PutThings": {
                     "type": "operation",
@@ -818,7 +818,7 @@ plane unless an operation or resource is marked with the
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "smithy.example#PutThings": {
                     "type": "operation",
@@ -1014,7 +1014,7 @@ using an ``clientEndpointDiscoveryId``.
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "ns.foo#FooService": {
                     "type": "service",

diff --git a/docs/source/1.0/spec/aws/aws-ec2-query-protocol.rst b/docs/source/1.0/spec/aws/aws-ec2-query-protocol.rst
@@ -43,7 +43,7 @@ Value type
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "smithy.example#MyService": {
                     "type": "service",
@@ -90,7 +90,7 @@ Given the following structure definition:
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "smithy.example#MyStruct": {
                     "type": "structure",

diff --git a/docs/source/1.0/spec/aws/aws-iam.rst b/docs/source/1.0/spec/aws/aws-iam.rst
@@ -51,7 +51,7 @@ Value type
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "smithy.example#FooOperation": {
                     "type": "operation",
@@ -112,7 +112,7 @@ The following example's ``MyResource`` resource has the
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "smithy.example#MyService": {
                     "type": "service",
@@ -235,7 +235,7 @@ Each condition key structure supports the following members:
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "smithy.example#MyService": {
                     "type": "service",
@@ -358,7 +358,7 @@ condition key inference disabled.
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "smithy.example#MyService": {
                     "type": "service",
@@ -439,7 +439,7 @@ operation for it to complete successfully.
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "smithy.example#MyService": {
                     "type": "service",
@@ -535,7 +535,7 @@ Given the following model,
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "smithy.example#MyService": {
                     "type": "service",

diff --git a/docs/source/1.0/spec/aws/aws-json-1_0-protocol.rst b/docs/source/1.0/spec/aws/aws-json-1_0-protocol.rst
@@ -44,7 +44,7 @@ See
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "smithy.example#MyService": {
                     "type": "service",

diff --git a/docs/source/1.0/spec/aws/aws-json-1_1-protocol.rst b/docs/source/1.0/spec/aws/aws-json-1_1-protocol.rst
@@ -44,7 +44,7 @@ See
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "smithy.example#MyService": {
                     "type": "service",

diff --git a/docs/source/1.0/spec/aws/aws-query-protocol.rst b/docs/source/1.0/spec/aws/aws-query-protocol.rst
@@ -44,7 +44,7 @@ See
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "smithy.example#MyService": {
                     "type": "service",

diff --git a/docs/source/1.0/spec/aws/aws-restjson1-protocol.rst b/docs/source/1.0/spec/aws/aws-restjson1-protocol.rst
@@ -76,7 +76,7 @@ The following example defines a service that uses ``aws.protocols#restJson1``.
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "smithy.example#MyService": {
                     "type": "service",

diff --git a/docs/source/1.0/spec/aws/aws-restxml-protocol.rst b/docs/source/1.0/spec/aws/aws-restxml-protocol.rst
@@ -77,7 +77,7 @@ The following example defines a service that uses ``aws.protocols#restXml``.
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "smithy.example#MyService": {
                     "type": "service",

diff --git a/docs/source/1.0/spec/core/auth-traits.rst b/docs/source/1.0/spec/core/auth-traits.rst
@@ -68,7 +68,7 @@ and the hypothetical ``fooExample`` authentication scheme.
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "smithy.example#WeatherService": {
                     "type": "service",
@@ -323,7 +323,7 @@ The following example defines two operations:
     .. code-tab:: json
 
         {
-            "smithy": "1.0.0",
+            "smithy": "1.0",
             "shapes": {
                 "smithy.example#AuthenticatedService": {
                     "type": "service",