Add schema for data extension property proposal responses (#119)

* Add schema for data extension property proposal responses. Closes #118. * Fix typo Co-authored-by: Fabian Steeg <[email protected]> --------- Co-authored-by: Fabian Steeg <[email protected]>
reconciliation-api · Jul 13, 2023 · ab97ba9 · ab97ba9
1 parent 954345f
commit ab97ba9
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 0 deletions.
diff --git a/draft/examples/data-extension-property-proposal/invalid/missing-properties.json b/draft/examples/data-extension-property-proposal/invalid/missing-properties.json
@@ -0,0 +1,4 @@
+{
+  "limit": 5,
+  "type": "DifferentiatedPerson"
+}
diff --git a/draft/schemas/data-extension-property-proposal.json b/draft/schemas/data-extension-property-proposal.json
@@ -0,0 +1,43 @@
+{
+  "$schema": "http://json-schema.org/schema#",
+  "$id": "https://reconciliation-api.github.io/specs/draft/schemas/data-extension-property-proposal.json",
+  "type": "object",
+  "description": "This schema can be used to validate the JSON response of a property proposal endpoint (part of the data extension feature).",
+  "properties": {
+    "properties": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Identifier of the suggested property"
+          },
+          "name": {
+            "type": "string",
+            "description": "Name of the suggested property"
+          },
+          "description": {
+            "type": "string",
+            "description": "An optional description which can be provided to disambiguate namesakes, providing more context."
+          }
+        },
+        "required": [
+          "id",
+          "name"
+        ]
+      }
+    },
+    "type": {
+       "type": "string",
+       "description": "The identifier of the type for which those properties are suggested"
+    },
+    "limit": {
+       "type": "number",
+       "description": "The maximum number of results requested."
+    }
+  },
+  "required": [
+    "properties"
+  ]
+}