Merge pull request #531 from UMass-Amherst-Libraries/mod-cricStoreage-604

add raml and json for requests anonymization

Author: yuntianhu

ramls/anonymize-storage-request.raml

@@ -0,0 +1,35 @@
+#%RAML 1.0
+title: Anonymize requests
+version: v0.1
+protocols: [ HTTP, HTTPS ]
+baseUri: http://localhost:9130
+
+documentation:
+  - title: Anonymize requests API
+    content: <b>Anonymize requests API</b>
+
+types:
+  errors: !include raml-util/schemas/errors.schema
+  anonymize-storage-requests-response: !include anonymize-storage-requests-response.json
+  anonymize-storage-requests-request: !include anonymize-storage-requests-request.json
+
+traits:
+  validate: !include raml-util/traits/validation.raml
+
+/anonymize-storage-requests:
+  post:
+    is: [validate]
+    body:
+      application/json:
+        type: anonymize-storage-requests-request
+    responses:
+      200:
+        description: "requests that have been anonymized"
+        body:
+          application/json:
+            type: anonymize-storage-requests-response
+      500:
+        description: "Internal server error, e.g. due to misconfiguration"
+        body:
+          text/plain:
+            example: "Internal server error, contact administrator"

ramls/anonymize-storage-requests-request.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "Request schema for anonymize requests",
+  "type": "object",
+  "properties": {
+    "requestIds": {
+      "description": "request ids to be anonymized",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "additionalProperties": false
+}

ramls/anonymize-storage-requests-response.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "Response schema for anonymize requests request",
+  "type": "object",
+  "properties": {
+    "anonymizedRequests": {
+      "description": "Successfully anonymized request ids",
+      "type": "array",
+      "items":{
+        "type": "string"
+      }
+    },
+    "notAnonymizedRequests": {
+      "description": "Not anonymized request IDs",
+      "type": "array",
+      "items": {
+        "description": "Collection of requests",
+        "type": "object",
+        "properties": {
+          "reason": {
+            "description": "Reason of failure",
+            "type": "string"
+          },
+          "requestIds": {
+            "description": "List of request IDs that have not been anonymized",
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        },
+        "additionalProperties": false
+      }
+    }
+  },
+  "additionalProperties": false
+}