Correct the Resource shape properties Type entry (#1415)

* Correct a minor grammar mistake

* Correct the Resource shape properties Type entry

Prior to this change, the docs incorrectly list the Type as
"AST shape reference", but as per the Description column, and the
Model (not AST) docs, as well as the Introducing Smithy IDL 2.0
blog post, this Type should be a map of strings to shape ID.

See:
* https://awslabs.github.io/smithy/2.0/spec/service-types.html#resource
* https://awslabs.github.io/smithy/2.0/spec/json-ast.html#resource-shape
* https://aws.amazon.com/blogs/developer/introducing-smithy-idl-2-0/

* Correct the Resource shape's `properties` type

It should be a map of AST shape references, as per
https://github.com/awslabs/smithy/pull/1415#discussion_r1018609584
This commit is contained in:
Paul Colby 2022-11-15 03:47:09 +11:00 committed by GitHub
parent a8fd6c537d
commit c6ed7aefc6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 3 deletions

View File

@ -65,7 +65,7 @@ a ``type`` property to define the shape type or ``apply``.
}
All entries in the ``shapes`` map can contain a ``traits`` property that
defines the traits attached to the shape. ``traits`` is a map of where
defines the traits attached to the shape. ``traits`` is a map where
each key is the absolute shape ID of a trait shape and each value is
the value to assign to the trait.

View File

@ -69,7 +69,7 @@ a ``type`` property to define the shape type or ``apply``.
}
All entries in the ``shapes`` map can contain a ``traits`` property that
defines the traits attached to the shape. ``traits`` is a map of where
defines the traits attached to the shape. ``traits`` is a map where
each key is the absolute shape ID of a trait shape and each value is
the value to assign to the trait.
@ -496,7 +496,7 @@ shapes defined in JSON support the same properties as the Smithy IDL.
- Map<String, :ref:`AST shape reference <ast-shape-reference>`>
- Defines identifier names and shape IDs used to identify the resource.
* - :ref:`properties <resource-properties>`
- :ref:`AST shape reference <ast-shape-reference>`
- Map<String, :ref:`AST shape reference <ast-shape-reference>`>
- Defines a map of property string names to shape IDs that
enumerate the properties of the resource.
* - :ref:`create <create-lifecycle>`