Added message schemas

Author: kevinwang5658

codify-schemas/src/messages/apply-request-data-schema.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://www.codify.com/plan-response-data-schema.json",
+  "title": "Plan Response Schema Data",
+  "description": "Apply the previously generated plan. The plan must already be generated in order for apply to work.",
+  "type": "object",
+  "properties": {
+    "planId": {
+      "description": "The plan uuid. This id is used to look up the generated plan on the plugin side",
+      "type": "string",
+      "format": "uuid"
+    }
+  },
+  "required": ["planId"],
+  "additionalProperties": false
+}

codify-schemas/src/messages/error-response-data-schema.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://www.codify.com/error-response-data-schema.json",
+  "title": "Error Response Schema Data",
+  "type": "object",
+  "properties": {
+    "reason": {
+      "description": "A human read-able reason for the error",
+      "type": "string"
+    }
+  },
+  "required": ["reason"],
+  "additionalProperties": false
+}

codify-schemas/src/messages/plan-request-data-schema.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://www.codify.com/plan-request-data-schema.json",
+  "title": "Plan Request Schema Data",
+  "$ref": "../resource-schema.json"
+}

codify-schemas/src/messages/plan-response-data-schema.json

@@ -0,0 +1,53 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://www.codify.com/plan-response-data-schema.json",
+  "title": "Plan Response Schema Data",
+  "type": "object",
+  "properties": {
+    "planId": {
+      "description": "The id of the plan to look up for the apply operation",
+      "type": "string",
+      "format": "uuid"
+    },
+    "operation": {
+      "description": "The plan operation",
+      "type": "string",
+      "enum" : ["create", "destroy", "modify", "recreate", "noop"]
+    },
+    "resourceType": {
+      "description": "The resource type",
+      "type": "string"
+    },
+    "resourceName": {
+      "description": "The resource name",
+      "type": ["string", "null"]
+    },
+    "parameters": {
+      "description": "The properties come from the provided config and is not necessarily every parameter on the ",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "description": "The property name",
+            "type": "string"
+          },
+          "operation": {
+            "description": "The operation to be performed on the parameter",
+            "type": "string",
+            "enum": ["remove", "add", "modify", "noop"]
+          },
+          "previousValue": {
+            "description": "The value before the change"
+          },
+          "newValue": {
+            "description": "The new value"
+          }
+        },
+        "required": ["name", "operation", "previousValue", "newValue"]
+      }
+    }
+  },
+  "required": ["planId", "operation", "resourceType", "resourceName", "parameters"],
+  "additionalProperties": false
+}

codify-schemas/src/messages/validate-request-data-schema.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://www.codify.com/validate-request-data-schema.json",
+  "title": "Validate Request Schema Data",
+  "type": "array",
+  "items": {
+    "$ref": "../resource-schema.json"
+  }
+}

codify-schemas/src/messages/validate-response-data-schema.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://www.codify.com/validate-response-data-schema.json",
+  "title": "Validate Response Schema Data",
+  "type": "object",
+  "properties": {
+    "type": {
+      "description": "The resource type",
+      "type": "string",
+      "pattern": "^[a-zA-Z-_][\\w-]+$"
+    },
+    "name": {
+      "description": "Optional name. Useful for specifying multiple resources of the same type",
+      "type": "string",
+      "pattern": "^[a-zA-Z-_][\\w-]+$"
+    },
+    "dependsOn": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "uniqueItems": true
+    }
+  },
+  "required": ["type"]
+}