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

Document that requiresLength only impacts requests #1152

Merged
merged 1 commit into from
Mar 23, 2022
Merged
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
17 changes: 11 additions & 6 deletions docs/source/1.0/spec/core/stream-traits.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,13 +73,18 @@ Validation
------------------------

Summary
Indicates that the streaming blob MUST be finite and has a known size.
Indicates that the streaming blob MUST be finite and have a known
size when sending data from a client to a server.

In an HTTP-based protocol, for instance, this trait indicates that the
``Content-Length`` header MUST be sent prior to a client or server
sending the payload of a message. This can be useful for services that
need to determine if a request will be accepted based on its size or
where to store data based on the size of the stream.
In an HTTP-based protocol, this trait indicates that the
``Content-Length`` header MUST be sent prior to a client sending the
payload of a request. This can be useful for services that need to
determine if a request will be accepted based on its size or where to
store data based on the size of the stream.

.. note::

This trait only has an effect when used on blobs in input shapes.
Trait selector::
``blob[trait|streaming]``

Expand Down