Adds httpChecksumRequired trait

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

@@ -609,3 +609,31 @@ to request additional results from the operation.
    presence, absence, or contents of a continuation token.
 
 .. _UUID: https://tools.ietf.org/html/rfc4122
+
+
+.. _httpChecksumRequired-trait:
+
+------------------------------
+``httpChecksumRequired`` trait
+------------------------------
+
+Summary
+    Indicates that an operation requires a checksum in its HTTP request. By
+    default, the checksum used for a service is a MD5 checksum passed in the
+    Content-MD5 header.
+Trait selector
+    ``operation``
+Value type
+    Annotation trait.
+See
+    :rfc:`1864`
+
+.. tabs::
+
+    .. code-tab:: smithy
+
+        @httpChecksumRequired
+        operation PutSomething {
+            input: PutSomethingInput,
+            output: PutSomethingOutput
+        }

smithy-model/src/main/java/software/amazon/smithy/model/loader/Prelude.java

@@ -53,6 +53,7 @@
 import software.amazon.smithy.model.traits.HttpApiKeyAuthTrait;
 import software.amazon.smithy.model.traits.HttpBasicAuthTrait;
 import software.amazon.smithy.model.traits.HttpBearerAuthTrait;
+import software.amazon.smithy.model.traits.HttpChecksumRequiredTrait;
 import software.amazon.smithy.model.traits.HttpDigestAuthTrait;
 import software.amazon.smithy.model.traits.HttpErrorTrait;
 import software.amazon.smithy.model.traits.HttpHeaderTrait;
@@ -158,6 +159,7 @@ public final class Prelude {
             ExamplesTrait.ID,
             ExternalDocumentationTrait.ID,
             HostLabelTrait.ID,
+            HttpChecksumRequiredTrait.ID,
             HttpErrorTrait.ID,
             HttpHeaderTrait.ID,
             HttpLabelTrait.ID,

smithy-model/src/main/java/software/amazon/smithy/model/traits/HttpChecksumRequiredTrait.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.smithy.model.traits;
+
+import software.amazon.smithy.model.node.Node;
+import software.amazon.smithy.model.node.ObjectNode;
+import software.amazon.smithy.model.shapes.ShapeId;
+
+/**
+ * Indicates that an operation requires a checksum in its HTTP request.
+ * By default, the checksum used for a service is a MD5 checksum passed
+ * in the Content-MD5 header.
+ */
+public final class HttpChecksumRequiredTrait extends AnnotationTrait {
+
+    public static final ShapeId ID = ShapeId.from("smithy.api#httpChecksumRequired");
+
+    public HttpChecksumRequiredTrait(ObjectNode node) {
+        super(ID, node);
+    }
+
+    public HttpChecksumRequiredTrait() {
+        this(Node.objectNode());
+    }
+
+    public static final class Provider extends AnnotationTrait.Provider<HttpChecksumRequiredTrait> {
+        public Provider() {
+            super(ID, HttpChecksumRequiredTrait::new);
+        }
+    }
+}

smithy-model/src/main/resources/META-INF/services/software.amazon.smithy.model.traits.TraitService

@@ -11,6 +11,7 @@ software.amazon.smithy.model.traits.EventPayloadTrait$Provider
 software.amazon.smithy.model.traits.ExamplesTrait$Provider
 software.amazon.smithy.model.traits.ExternalDocumentationTrait$Provider
 software.amazon.smithy.model.traits.HostLabelTrait$Provider
+software.amazon.smithy.model.traits.HttpChecksumRequiredTrait$Provider
 software.amazon.smithy.model.traits.HttpErrorTrait$Provider
 software.amazon.smithy.model.traits.HttpHeaderTrait$Provider
 software.amazon.smithy.model.traits.HttpLabelTrait$Provider

smithy-model/src/main/resources/software/amazon/smithy/model/loader/prelude-traits.smithy

@@ -641,3 +641,9 @@ list suppress {
     @length(min: 1)
     member: String
 }
+
+/// Marks an operation as requiring checksum in its HTTP request.
+/// By default, the checksum used for a service is a MD5 checksum
+/// passed in the Content-MD5 header.
+@trait(selector: "operation")
+structure httpChecksumRequired {}

smithy-model/src/test/resources/software/amazon/smithy/model/errorfiles/validators/http-checksum-required-trait.errors

@@ -0,0 +1,4 @@
+[ERROR] ns.foo#InvalidInput: Trait `httpChecksumRequired` cannot be applied to `ns.foo#InvalidInput`. This trait may only be applied to shapes that match the following selector: operation | TraitTarget
+[ERROR] ns.foo#InvalidOutput: Trait `httpChecksumRequired` cannot be applied to `ns.foo#InvalidOutput`. This trait may only be applied to shapes that match the following selector: operation | TraitTarget
+[ERROR] ns.foo#InvalidError: Trait `httpChecksumRequired` cannot be applied to `ns.foo#InvalidError`. This trait may only be applied to shapes that match the following selector: operation | TraitTarget
+[ERROR] ns.foo#InvalidStructure$Body: Trait `httpChecksumRequired` cannot be applied to `ns.foo#InvalidStructure$Body`. This trait may only be applied to shapes that match the following selector: operation | TraitTarget

smithy-model/src/test/resources/software/amazon/smithy/model/errorfiles/validators/http-checksum-required-trait.json

@@ -0,0 +1,90 @@
+{
+  "smithy": "1.0",
+  "shapes": {
+    "ns.foo#Blob": {
+      "type": "blob"
+    },
+    "ns.foo#ValidOperation": {
+      "type": "operation",
+      "input": {
+        "target": "ns.foo#Input"
+      },
+      "output": {
+        "target": "ns.foo#Output"
+      },
+      "traits": {
+        "smithy.api#httpChecksumRequired": {}
+      }
+    },
+    "ns.foo#Input": {
+      "type": "structure",
+      "members": {
+        "Body": {
+          "target": "smithy.api#Blob"
+        }
+      }
+    },
+    "ns.foo#Output": {
+      "type": "structure",
+      "members": {
+        "Body": {
+          "target": "smithy.api#Blob"
+        }
+      }
+    },
+    "ns.foo#InvalidOperation": {
+      "type": "operation",
+      "input": {
+        "target": "ns.foo#Input"
+      },
+      "output": {
+        "target": "ns.foo#Output"
+      }
+    },
+    "ns.foo#InvalidInput": {
+      "type": "structure",
+      "members": {
+        "Body": {
+          "target": "smithy.api#Blob"
+        }
+      },
+      "traits": {
+        "smithy.api#httpChecksumRequired": {}
+      }
+    },
+    "ns.foo#InvalidOutput": {
+      "type": "structure",
+      "members": {
+        "Body": {
+          "target": "smithy.api#Blob"
+        }
+      },
+      "traits": {
+        "smithy.api#httpChecksumRequired": {}
+      }
+    },
+    "ns.foo#InvalidError": {
+      "type": "structure",
+      "members": {
+        "Body": {
+          "target": "smithy.api#Blob"
+        }
+      },
+      "traits": {
+        "smithy.api#error": "client",
+        "smithy.api#httpChecksumRequired": {}
+      }
+    },
+    "ns.foo#InvalidStructure": {
+      "type": "structure",
+      "members": {
+        "Body": {
+          "target": "smithy.api#Blob",
+          "traits": {
+            "smithy.api#httpChecksumRequired": {}
+          }
+        }
+      }
+    }
+  }
+}