From 687c05f32c28f994bc5309bc62144a8884019b1b Mon Sep 17 00:00:00 2001 From: Michael Dowling Date: Wed, 23 Mar 2022 15:41:28 -0700 Subject: [PATCH] Document that requiresLength only impacts requests We have no use case of a server needing to be constrained by requiresLength. We can always expand this trait later if needed since it's an annotation trait. Closes #1086 --- docs/source/1.0/spec/core/stream-traits.rst | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/source/1.0/spec/core/stream-traits.rst b/docs/source/1.0/spec/core/stream-traits.rst index a3cb91a21d0..03b8abb2e01 100644 --- a/docs/source/1.0/spec/core/stream-traits.rst +++ b/docs/source/1.0/spec/core/stream-traits.rst @@ -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]``