Update Request Compression Trait specification

docs/source-1.0/spec/aws/aws-ec2-query-protocol.rst

@@ -28,7 +28,9 @@ Value type
 
 .. important::
 
-    This protocol does not support document types.
+    * This protocol does not support document types.
+    * This protocol does not support :ref:`HTTP binding traits <http-traits>`.
+      HTTP binding traits MUST be ignored if they are present.
 
 .. tabs::
 

docs/source-1.0/spec/core/behavior-traits.rst

@@ -557,7 +557,7 @@ members:
       - Type
       - Description
     * - encodings
-      - ``list<string>``
+      - ``[string]``
       - Defines the priority-ordered list of compression algorithms supported by
         the service operation. Supported compression algorithms are: "gzip".
 

docs/source-2.0/aws/protocols/aws-ec2-query-protocol.rst

@@ -28,7 +28,9 @@ Value type
 
 .. important::
 
-    This protocol does not support document types.
+    * This protocol does not support document types.
+    * This protocol does not support :ref:`HTTP binding traits <http-traits>`.
+      HTTP binding traits MUST be ignored if they are present.
 
 .. code-block:: smithy
 

docs/source-2.0/spec/behavior-traits.rst

@@ -514,7 +514,7 @@ members:
       - Type
       - Description
     * - encodings
-      - ``list<string>``
+      - ``[string]``
       - Defines the priority-ordered list of compression algorithms supported by
         the service operation. Supported compression algorithms are: "gzip".
 

docs/source-2.0/spec/http-bindings.rst

@@ -14,7 +14,7 @@ and error structures are considered when serializing HTTP messages.
 
 .. important::
 
-    Violating :rfc`HTTP specifications <7230>` or relying on poorly-supported
+    Violating :rfc:`HTTP specifications <7230>` or relying on poorly-supported
     HTTP functionality when defining HTTP bindings will limit interoperability
     and likely lead to undefined behavior across Smithy implementations. For
     example, avoid defining GET/DELETE requests with payloads, defining

smithy-aws-protocol-tests/model/awsJson1_0/requestCompression.smithy

@@ -9,7 +9,7 @@ use smithy.test#httpResponseTests
 apply PutWithContentEncoding @httpRequestTests([
     {
         id: "SDKAppliedContentEncoding_awsJson1_0"
-        documentation: "The user didn't apply an encoding, so the SDK applies gzip"
+        documentation: "Compression algorithm encoding is appended to the Content-Encoding header."
         protocol: awsJson1_0
         params: {
             "data": """
@@ -150,8 +150,12 @@ apply PutWithContentEncoding @httpRequestTests([
         }
     }
     {
-        id: "SDKAppendedGzipAfterProvidedEncoding_awsJson1_0"
-        documentation: "The user provided a content-encoding so the SDK appends gzip"
+        id: "SDKAppendsGzipAndIgnoresHttpProvidedEncoding_awsJson1_0"
+        documentation: """
+        Compression algorithm encoding is appended to the Content-Encoding header, and the
+        user-provided content-encoding is NOT in the Content-Encoding header since HTTP binding
+        traits are ignored in the awsJson1_0 protocol.
+        """
         protocol: awsJson1_0
         params: {
             "encoding": "custom"
@@ -289,7 +293,7 @@ apply PutWithContentEncoding @httpRequestTests([
         method: "POST"
         uri: "/"
         headers: {
-            "Content-Encoding": "custom, gzip"
+            "Content-Encoding": "gzip"
         }
     }
 ])
@@ -306,6 +310,5 @@ structure PutWithContentEncodingInput {
     @httpHeader("Content-Encoding")
     encoding: String
 
-    @httpPayload
     data: String
 }

smithy-aws-protocol-tests/model/awsJson1_1/requestCompression.smithy

@@ -9,7 +9,7 @@ use smithy.test#httpResponseTests
 apply PutWithContentEncoding @httpRequestTests([
     {
         id: "SDKAppliedContentEncoding_awsJson1_1"
-        documentation: "The user didn't apply an encoding, so the SDK applies gzip"
+        documentation: "Compression algorithm encoding is appended to the Content-Encoding header."
         protocol: awsJson1_1
         params: {
             "data": """
@@ -150,8 +150,12 @@ apply PutWithContentEncoding @httpRequestTests([
         }
     }
     {
-        id: "SDKAppendedGzipAfterProvidedEncoding_awsJson1_1"
-        documentation: "The user provided a content-encoding so the SDK appends gzip"
+        id: "SDKAppendsGzipAndIgnoresHttpProvidedEncoding_awsJson1_1"
+        documentation: """
+        Compression algorithm encoding is appended to the Content-Encoding header, and the
+        user-provided content-encoding is NOT in the Content-Encoding header since HTTP binding
+        traits are ignored in the awsJson1_1 protocol.
+        """
         protocol: awsJson1_1
         params: {
             "encoding": "custom"
@@ -289,7 +293,7 @@ apply PutWithContentEncoding @httpRequestTests([
         method: "POST"
         uri: "/"
         headers: {
-            "Content-Encoding": "custom, gzip"
+            "Content-Encoding": "gzip"
         }
     }
 ])
@@ -306,6 +310,5 @@ structure PutWithContentEncodingInput {
     @httpHeader("Content-Encoding")
     encoding: String
 
-    @httpPayload
     data: String
 }

smithy-aws-protocol-tests/model/awsQuery/requestCompression.smithy

@@ -9,7 +9,7 @@ use smithy.test#httpResponseTests
 apply PutWithContentEncoding @httpRequestTests([
     {
         id: "SDKAppliedContentEncoding_awsQuery"
-        documentation: "The user didn't apply an encoding, so the SDK applies gzip"
+        documentation: "Compression algorithm encoding is appended to the Content-Encoding header."
         protocol: awsQuery
         params: {
             "data": """
@@ -150,8 +150,12 @@ apply PutWithContentEncoding @httpRequestTests([
         }
     }
     {
-        id: "SDKAppendedGzipAfterProvidedEncoding_awsQuery"
-        documentation: "The user provided a content-encoding so the SDK appends gzip"
+        id: "SDKAppendsGzipAndIgnoresHttpProvidedEncoding_awsQuery"
+        documentation: """
+        Compression algorithm encoding is appended to the Content-Encoding header, and the
+        user-provided content-encoding is NOT in the Content-Encoding header since HTTP binding
+        traits are ignored in the awsQuery protocol.
+        """
         protocol: awsQuery
         params: {
             "encoding": "custom"
@@ -289,7 +293,7 @@ apply PutWithContentEncoding @httpRequestTests([
         method: "POST"
         uri: "/"
         headers: {
-            "Content-Encoding": "custom, gzip"
+            "Content-Encoding": "gzip"
         }
     }
 ])
@@ -306,6 +310,5 @@ structure PutWithContentEncodingInput {
     @httpHeader("Content-Encoding")
     encoding: String
 
-    @httpPayload
     data: String
 }

smithy-aws-protocol-tests/model/ec2Query/requestCompression.smithy

@@ -9,7 +9,7 @@ use smithy.test#httpResponseTests
 apply PutWithContentEncoding @httpRequestTests([
     {
         id: "SDKAppliedContentEncoding_ec2Query"
-        documentation: "The user didn't apply an encoding, so the SDK applies gzip"
+        documentation: "Compression algorithm encoding is appended to the Content-Encoding header."
         protocol: ec2Query
         params: {
             "data": """
@@ -150,8 +150,12 @@ apply PutWithContentEncoding @httpRequestTests([
         }
     }
     {
-        id: "SDKAppendedGzipAfterProvidedEncoding_ec2Query"
-        documentation: "The user provided a content-encoding so the SDK appends gzip"
+        id: "SDKAppendsGzipAndIgnoresHttpProvidedEncoding_ec2Query"
+        documentation: """
+        Compression algorithm encoding is appended to the Content-Encoding header, and the
+        user-provided content-encoding is NOT in the Content-Encoding header since HTTP binding
+        traits are ignored in the ec2Query protocol.
+        """
         protocol: ec2Query
         params: {
             "encoding": "custom"
@@ -289,7 +293,7 @@ apply PutWithContentEncoding @httpRequestTests([
         method: "POST"
         uri: "/"
         headers: {
-            "Content-Encoding": "custom, gzip"
+            "Content-Encoding": "gzip"
         }
     }
 ])
@@ -306,6 +310,5 @@ structure PutWithContentEncodingInput {
     @httpHeader("Content-Encoding")
     encoding: String
 
-    @httpPayload
     data: String
 }

smithy-aws-protocol-tests/model/restJson1/requestCompression.smithy

@@ -9,7 +9,7 @@ use smithy.test#httpResponseTests
 apply PutWithContentEncoding @httpRequestTests([
     {
         id: "SDKAppliedContentEncoding_restJson1"
-        documentation: "The user didn't apply an encoding, so the SDK applies gzip"
+        documentation: "Compression algorithm encoding is appended to the Content-Encoding header."
         protocol: restJson1
         params: {
             "data": """
@@ -151,7 +151,11 @@ apply PutWithContentEncoding @httpRequestTests([
     }
     {
         id: "SDKAppendedGzipAfterProvidedEncoding_restJson1"
-        documentation: "The user provided a content-encoding so the SDK appends gzip"
+        documentation: """
+        Compression algorithm encoding is appended to the Content-Encoding header, and the
+        user-provided content-encoding is in the Content-Encoding header before the
+        request compression encoding from the HTTP binding.
+        """
         protocol: restJson1
         params: {
             "encoding": "custom"
@@ -310,6 +314,5 @@ structure PutWithContentEncodingInput {
     @httpHeader("Content-Encoding")
     encoding: String
 
-    @httpPayload
     data: String
 }

smithy-aws-protocol-tests/model/restXml/requestCompression.smithy

@@ -9,7 +9,7 @@ use smithy.test#httpResponseTests
 apply PutWithContentEncoding @httpRequestTests([
     {
         id: "SDKAppliedContentEncoding_restXml"
-        documentation: "The user didn't apply an encoding, so the SDK applies gzip"
+        documentation: "Compression algorithm encoding is appended to the Content-Encoding header."
         protocol: restXml
         params: {
             "data": """
@@ -151,7 +151,11 @@ apply PutWithContentEncoding @httpRequestTests([
     }
     {
         id: "SDKAppendedGzipAfterProvidedEncoding_restXml"
-        documentation: "The user provided a content-encoding so the SDK appends gzip"
+        documentation: """
+        Compression algorithm encoding is appended to the Content-Encoding header, and the
+        user-provided content-encoding is in the Content-Encoding header before the
+        request compression encoding from the HTTP binding.
+        """
         protocol: restXml
         params: {
             "encoding": "custom"
@@ -310,6 +314,5 @@ structure PutWithContentEncodingInput {
     @httpHeader("Content-Encoding")
     encoding: String
 
-    @httpPayload
     data: String
 }