Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add note about httpPayload to aws docs #683

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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