add anonymizawtion-settings.json and anonymization-settings-response.json

yuntianhu · yuntianhu · commit d942581da345 · 2025-10-10T09:14:08.000-04:00
diff --git a/ramls/anonymization-settings-response.json b/ramls/anonymization-settings-response.json
@@ -0,0 +1,39 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "AnonymizationSettingsResponse",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "id": {
+      "description": "Identifier of this settings record.",
+      "type": "string",
+      "pattern": "^[0-9a-fA-F-]{36}$"
+    },
+    "enabled": {
+      "type": "boolean"
+    },
+    "retentionDays": {
+      "type": "integer",
+      "minimum": 0
+    },
+    "fields": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "type": "string"
+      }
+    },
+    "metadata": {
+      "description": "Optional audit metadata.",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "createdDate": { "type": "string", "format": "date-time" },
+        "createdByUserId": { "type": "string", "pattern": "^[0-9a-fA-F-]{36}$" },
+        "updatedDate": { "type": "string", "format": "date-time" },
+        "updatedByUserId": { "type": "string", "pattern": "^[0-9a-fA-F-]{36}$" }
+      }
+    }
+  },
+  "required": ["id", "enabled"]
+}
diff --git a/ramls/anonymization-settings.json b/ramls/anonymization-settings.json
@@ -0,0 +1,29 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "AnonymizationSettings",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "enabled": {
+      "description": "Turn request anonymization on/off.",
+      "type": "boolean"
+    },
+    "retentionDays": {
+      "description": "Keep request data for this many days before anonymizing.",
+      "type": "integer",
+      "minimum": 0
+    },
+    "fields": {
+      "description": "Request fields to anonymize when policy triggers.",
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "type": "string"
+      },
+      "examples": [
+        ["requesterId", "proxyUserId", "pickupServicePointId"]
+      ]
+    }
+  },
+  "required": ["enabled"]
+}
diff --git a/ramls/request-storage.raml b/ramls/request-storage.raml
@@ -15,8 +15,10 @@ types:
   parameters: !include raml-util/schemas/parameters.schema
   location: !include locations/location.json
   locations: !include locations/locations.json
-  AnonymizationSettings: !include raml-util/anonymize-storage-requests-request.json
-  AnonymizationSettingsResponse: !include raml-util/anonymize-storage-requests-response.json
+  anonymize-requests-request: !include anonymize-storage-requests-request.json
+  anonymize-requests-response: !include anonymize-storage-requests-response.json
+  AnonymizationSettings: !include anonymization-settings.json
+  AnonymizationSettingsResponse: !include anonymization-settings-response.json
 
 traits:
   pageable: !include raml-util/traits/pageable.raml
