Skip to content

Commit

Permalink
Add note about httpPayload to aws docs
Browse files Browse the repository at this point in the history
This adds a note to the aws protocol docs noting their stricter
requirements for the httpPayload trait.
  • Loading branch information
JordonPhillips committed Jan 6, 2021
1 parent 63b5277 commit 99a7192
Show file tree
Hide file tree
Showing 6 changed files with 33 additions and 6 deletions.
5 changes: 5 additions & 0 deletions docs/source/1.0/spec/aws/aws-ec2-query-protocol.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@ Value type

This protocol does not support document types.

.. important::

This protocol only permits the :ref:`httpPayload-trait` to be applied to
members that target structures, documents, strings, blobs, or unions.

.. tabs::

.. code-tab:: smithy
Expand Down
5 changes: 5 additions & 0 deletions docs/source/1.0/spec/aws/aws-json-1_0-protocol.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,9 @@ See
}
}

.. important::

This protocol only permits the :ref:`httpPayload-trait` to be applied to
members that target structures, documents, strings, blobs, or unions.

*TODO: Add specifications, protocol examples, etc.*
5 changes: 5 additions & 0 deletions docs/source/1.0/spec/aws/aws-json-1_1-protocol.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,9 @@ See
}
}

.. important::

This protocol only permits the :ref:`httpPayload-trait` to be applied to
members that target structures, documents, strings, blobs, or unions.

*TODO: Add specifications, protocol examples, etc.*
5 changes: 5 additions & 0 deletions docs/source/1.0/spec/aws/aws-query-protocol.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,9 @@ See

This protocol does not support document types.

.. important::

This protocol only permits the :ref:`httpPayload-trait` to be applied to
members that target structures, documents, strings, blobs, or unions.

*TODO: Add specifications, protocol examples, etc.*
6 changes: 6 additions & 0 deletions docs/source/1.0/spec/aws/aws-restjson1-protocol.rst
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,12 @@ that affect serialization:
* - :ref:`httpPayload <httpPayload-trait>`
- Binds a top-level input or output structure member as the payload
of a request or response.

.. important::

This protocol only permits the :ref:`httpPayload-trait` to be applied to
members that target structures, documents, strings, blobs, or unions.

* - :ref:`httpPrefixHeaders <httpPrefixHeaders-trait>`
- Binds a top-level input, output, or error member to a map of
prefixed HTTP headers.
Expand Down
13 changes: 7 additions & 6 deletions docs/source/1.0/spec/core/http-traits.rst
Original file line number Diff line number Diff line change
Expand Up @@ -685,10 +685,11 @@ Summary
Trait selector
.. code-block:: none
structure > :test(member > :test(string, blob, structure, union, document))
structure > :test(member > :test(string, blob, structure, union, document, list, set, map))
The ``httpPayload`` trait can be applied to ``structure`` members that
target a ``string``, ``blob``, ``structure``, ``union``, or ``document``.
target a ``string``, ``blob``, ``structure``, ``union``, ``document``,
``set``, ``map``, or ``list``.
Value type
Annotation trait.
Conflicts with
Expand Down Expand Up @@ -749,10 +750,10 @@ or :ref:`httpPrefixHeaders-trait`.

#. When a string or blob member is referenced, the raw value is serialized
as the body of the message.
#. When a :ref:`structure <structure>`, :ref:`union <union>`, or
document type is targeted, the shape value is serialized
as a :ref:`protocol-specific <protocolDefinition-trait>` document that is
sent as the body of the message.
#. When a :ref:`structure <structure>`, :ref:`union <union>`, :ref:`list <list>`,
:ref:`set <set>`, :ref:`map <map>`, or document type is targeted,
the shape value is serialized as a :ref:`protocol-specific <protocolDefinition-trait>`
document that is sent as the body of the message.


.. _httpPrefixHeaders-trait:
Expand Down

0 comments on commit 99a7192

Please sign in to comment.