@empire-builder-kit/nx 1.0.0-beta.9 → 1.0.0-rc.2

package/src/schemas/api-contract-baseline-v1.json

@@ -0,0 +1,674 @@
+{
+  "$id": "https://empirebuilderkit.dev/schemas/api-contract-baseline-v1.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$defs": {
+    "conditionalWrite": {
+      "additionalProperties": false,
+      "properties": {
+        "kind": { "const": "etag" },
+        "requestHeader": { "const": "if-match" },
+        "required": { "type": "boolean" },
+        "responseHeader": { "const": "etag" }
+      },
+      "required": ["kind", "requestHeader", "required", "responseHeader"],
+      "type": "object"
+    },
+    "idempotency": {
+      "additionalProperties": false,
+      "properties": {
+        "concurrentDuplicate": { "enum": ["conflict", "wait"] },
+        "keyHeader": { "const": "idempotency-key" },
+        "maxKeyLength": {
+          "maximum": 512,
+          "minimum": 1,
+          "type": "integer"
+        },
+        "mismatch": { "const": "conflict" },
+        "replay": { "const": "same-response" },
+        "required": { "type": "boolean" },
+        "requestFingerprint": { "const": "canonical-json" },
+        "retentionSeconds": { "minimum": 1, "type": "integer" },
+        "scope": { "const": "principal-operation" }
+      },
+      "required": [
+        "concurrentDuplicate",
+        "keyHeader",
+        "maxKeyLength",
+        "mismatch",
+        "replay",
+        "required",
+        "requestFingerprint",
+        "retentionSeconds",
+        "scope"
+      ],
+      "type": "object"
+    },
+    "jsonPrimitive": {
+      "anyOf": [
+        { "type": "boolean" },
+        { "type": "null" },
+        { "type": "number" },
+        { "type": "string" }
+      ]
+    },
+    "jsonSchema": {
+      "additionalProperties": false,
+      "allOf": [
+        {
+          "anyOf": [
+            { "properties": { "const": {} }, "required": ["const"] },
+            { "properties": { "oneOf": {} }, "required": ["oneOf"] },
+            { "properties": { "type": {} }, "required": ["type"] }
+          ]
+        },
+        {
+          "if": {
+            "properties": {
+              "type": {
+                "anyOf": [
+                  { "const": "object" },
+                  {
+                    "contains": { "const": "object" },
+                    "type": "array"
+                  }
+                ]
+              }
+            },
+            "required": ["type"]
+          },
+          "then": {
+            "properties": { "additionalProperties": {} },
+            "required": ["additionalProperties"]
+          }
+        },
+        {
+          "if": { "required": ["oneOf"] },
+          "then": {
+            "propertyNames": {
+              "enum": ["$schema", "description", "oneOf"]
+            }
+          }
+        }
+      ],
+      "properties": {
+        "$schema": {
+          "const": "https://json-schema.org/draft/2020-12/schema"
+        },
+        "additionalProperties": {
+          "oneOf": [{ "type": "boolean" }, { "$ref": "#/$defs/jsonSchema" }]
+        },
+        "const": { "$ref": "#/$defs/jsonPrimitive" },
+        "description": {
+          "maxLength": 1024,
+          "minLength": 1,
+          "type": "string"
+        },
+        "enum": {
+          "items": { "$ref": "#/$defs/jsonPrimitive" },
+          "minItems": 1,
+          "type": "array",
+          "uniqueItems": true
+        },
+        "format": { "maxLength": 256, "minLength": 1, "type": "string" },
+        "items": { "$ref": "#/$defs/jsonSchema" },
+        "maxItems": { "minimum": 0, "type": "integer" },
+        "maxLength": { "minimum": 0, "type": "integer" },
+        "maximum": { "type": "number" },
+        "minItems": { "minimum": 0, "type": "integer" },
+        "minLength": { "minimum": 0, "type": "integer" },
+        "minimum": { "type": "number" },
+        "oneOf": {
+          "items": { "$ref": "#/$defs/jsonSchema" },
+          "minItems": 2,
+          "type": "array"
+        },
+        "properties": {
+          "additionalProperties": { "$ref": "#/$defs/jsonSchema" },
+          "propertyNames": {
+            "not": {
+              "enum": ["__proto__", "constructor", "prototype"]
+            },
+            "pattern": "^[A-Za-z_][A-Za-z0-9_.-]{0,127}$"
+          },
+          "type": "object"
+        },
+        "required": {
+          "items": {
+            "pattern": "^[A-Za-z_][A-Za-z0-9_.-]{0,127}$",
+            "type": "string"
+          },
+          "type": "array",
+          "uniqueItems": true
+        },
+        "type": {
+          "oneOf": [
+            {
+              "enum": [
+                "array",
+                "boolean",
+                "integer",
+                "null",
+                "number",
+                "object",
+                "string"
+              ]
+            },
+            {
+              "items": {
+                "enum": [
+                  "array",
+                  "boolean",
+                  "integer",
+                  "null",
+                  "number",
+                  "object",
+                  "string"
+                ]
+              },
+              "minItems": 2,
+              "type": "array",
+              "uniqueItems": true
+            }
+          ]
+        }
+      },
+      "type": "object"
+    },
+    "lifecycle": {
+      "oneOf": [
+        {
+          "additionalProperties": false,
+          "properties": { "status": { "const": "active" } },
+          "required": ["status"],
+          "type": "object"
+        },
+        {
+          "additionalProperties": false,
+          "properties": {
+            "deprecation": {
+              "additionalProperties": false,
+              "anyOf": [
+                {
+                  "properties": { "earliestRemovalDate": {} },
+                  "required": ["earliestRemovalDate"]
+                },
+                {
+                  "properties": { "earliestRemovalVersion": {} },
+                  "required": ["earliestRemovalVersion"]
+                }
+              ],
+              "properties": {
+                "earliestRemovalDate": {
+                  "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
+                  "type": "string"
+                },
+                "earliestRemovalVersion": {
+                  "maxLength": 256,
+                  "pattern": "^(?:0|[1-9][0-9]*)\\.(?:0|[1-9][0-9]*)\\.(?:0|[1-9][0-9]*)$",
+                  "type": "string"
+                },
+                "evidence": { "$ref": "#/$defs/token" },
+                "firstDeprecatedVersion": {
+                  "maxLength": 256,
+                  "pattern": "^(?:0|[1-9][0-9]*)\\.(?:0|[1-9][0-9]*)\\.(?:0|[1-9][0-9]*)$",
+                  "type": "string"
+                },
+                "knownConsumers": {
+                  "items": { "$ref": "#/$defs/token" },
+                  "type": "array",
+                  "uniqueItems": true
+                },
+                "migration": { "$ref": "#/$defs/token" },
+                "owner": { "$ref": "#/$defs/token" },
+                "replacement": { "$ref": "#/$defs/token" }
+              },
+              "required": [
+                "evidence",
+                "firstDeprecatedVersion",
+                "knownConsumers",
+                "migration",
+                "owner",
+                "replacement"
+              ],
+              "type": "object"
+            },
+            "status": { "const": "deprecated" }
+          },
+          "required": ["deprecation", "status"],
+          "type": "object"
+        }
+      ]
+    },
+    "operation": {
+      "additionalProperties": false,
+      "allOf": [
+        {
+          "if": {
+            "properties": { "authentication": { "const": "anonymous" } },
+            "required": ["authentication"]
+          },
+          "then": {
+            "properties": {
+              "authorizationActions": { "maxItems": 0, "type": "array" }
+            }
+          }
+        },
+        {
+          "if": {
+            "properties": { "idempotency": {} },
+            "required": ["idempotency"]
+          },
+          "then": {
+            "properties": { "method": { "enum": ["PATCH", "POST"] } }
+          }
+        },
+        {
+          "if": {
+            "properties": { "conditionalWrite": {} },
+            "required": ["conditionalWrite"]
+          },
+          "then": {
+            "properties": {
+              "method": { "enum": ["DELETE", "PATCH", "PUT"] }
+            }
+          }
+        },
+        {
+          "if": {
+            "properties": { "method": { "const": "GET" } },
+            "required": ["method"]
+          },
+          "then": {
+            "properties": {
+              "request": {
+                "not": {
+                  "properties": { "body": {} },
+                  "required": ["body"],
+                  "type": "object"
+                }
+              }
+            }
+          }
+        }
+      ],
+      "properties": {
+        "authentication": {
+          "enum": [
+            "anonymous",
+            "customer",
+            "internal",
+            "operator",
+            "product-agent"
+          ]
+        },
+        "authorizationActions": {
+          "items": {
+            "pattern": "^[a-z][a-z0-9-]{0,62}:[a-z][a-z0-9-]{0,62}$",
+            "type": "string"
+          },
+          "type": "array",
+          "uniqueItems": true
+        },
+        "conditionalWrite": { "$ref": "#/$defs/conditionalWrite" },
+        "contractVersion": {
+          "maxLength": 256,
+          "pattern": "^(?:0|[1-9][0-9]*)\\.(?:0|[1-9][0-9]*)\\.(?:0|[1-9][0-9]*)$",
+          "type": "string"
+        },
+        "feature": {
+          "pattern": "^[a-z][a-z0-9-]{0,62}$",
+          "type": "string"
+        },
+        "idempotency": { "$ref": "#/$defs/idempotency" },
+        "lifecycle": { "$ref": "#/$defs/lifecycle" },
+        "method": {
+          "enum": ["DELETE", "GET", "PATCH", "POST", "PUT"]
+        },
+        "operationId": {
+          "pattern": "^[a-z][a-z0-9-]*\\.[a-z][a-z0-9.-]*$",
+          "type": "string"
+        },
+        "pagination": { "$ref": "#/$defs/pagination" },
+        "path": {
+          "maxLength": 512,
+          "pattern": "^/(?:[A-Za-z0-9._~-]+|\\{[a-z][A-Za-z0-9]*\\})(?:/(?:[A-Za-z0-9._~-]+|\\{[a-z][A-Za-z0-9]*\\}))*$",
+          "type": "string"
+        },
+        "problems": {
+          "items": { "$ref": "#/$defs/problem" },
+          "type": "array"
+        },
+        "request": { "$ref": "#/$defs/request" },
+        "response": { "$ref": "#/$defs/response" },
+        "responseProfile": { "const": "ebk-app-v1" },
+        "slice": { "$ref": "#/$defs/slice" },
+        "summary": {
+          "maxLength": 256,
+          "minLength": 1,
+          "type": "string"
+        }
+      },
+      "required": [
+        "authentication",
+        "authorizationActions",
+        "contractVersion",
+        "feature",
+        "lifecycle",
+        "method",
+        "operationId",
+        "path",
+        "problems",
+        "response",
+        "responseProfile",
+        "slice",
+        "summary"
+      ],
+      "type": "object"
+    },
+    "pagination": {
+      "additionalProperties": false,
+      "properties": {
+        "cursorQueryParameter": { "$ref": "#/$defs/token" },
+        "cursorResponseField": { "$ref": "#/$defs/token" },
+        "defaultLimit": { "minimum": 1, "type": "integer" },
+        "expirySeconds": { "minimum": 1, "type": "integer" },
+        "limitQueryParameter": { "$ref": "#/$defs/token" },
+        "maximumLimit": { "minimum": 1, "type": "integer" },
+        "minimumLimit": { "minimum": 1, "type": "integer" },
+        "stability": { "enum": ["eventual", "snapshot"] }
+      },
+      "required": [
+        "cursorQueryParameter",
+        "cursorResponseField",
+        "defaultLimit",
+        "limitQueryParameter",
+        "maximumLimit",
+        "minimumLimit",
+        "stability"
+      ],
+      "type": "object"
+    },
+    "problem": {
+      "additionalProperties": false,
+      "properties": {
+        "code": {
+          "pattern": "^[a-z][a-z0-9_]{2,63}$",
+          "type": "string"
+        },
+        "details": { "$ref": "#/$defs/jsonSchema" },
+        "message": {
+          "maxLength": 256,
+          "minLength": 1,
+          "type": "string"
+        },
+        "retryable": { "type": "boolean" },
+        "status": { "maximum": 599, "minimum": 400, "type": "integer" },
+        "type": { "pattern": "^https://", "type": "string" }
+      },
+      "required": ["code", "message", "retryable", "status", "type"],
+      "type": "object"
+    },
+    "request": {
+      "additionalProperties": false,
+      "properties": {
+        "body": { "$ref": "#/$defs/jsonSchema" },
+        "headers": { "$ref": "#/$defs/transportHeaderObject" },
+        "maxBodyBytes": {
+          "maximum": 262144,
+          "minimum": 1,
+          "type": "integer"
+        },
+        "path": { "$ref": "#/$defs/transportPathObject" },
+        "query": { "$ref": "#/$defs/transportQueryObject" }
+      },
+      "dependentRequired": { "maxBodyBytes": ["body"] },
+      "type": "object"
+    },
+    "response": {
+      "additionalProperties": false,
+      "properties": {
+        "body": { "$ref": "#/$defs/jsonSchema" },
+        "status": {
+          "maximum": 299,
+          "minimum": 200,
+          "not": { "enum": [204, 205] },
+          "type": "integer"
+        }
+      },
+      "required": ["body", "status"],
+      "type": "object"
+    },
+    "slice": {
+      "pattern": "^[a-z][a-z0-9-]{0,62}$",
+      "type": "string"
+    },
+    "transportHeaderObject": {
+      "additionalProperties": false,
+      "properties": {
+        "$schema": {
+          "const": "https://json-schema.org/draft/2020-12/schema"
+        },
+        "additionalProperties": { "const": false },
+        "description": {
+          "maxLength": 1024,
+          "minLength": 1,
+          "type": "string"
+        },
+        "properties": {
+          "additionalProperties": {
+            "$ref": "#/$defs/transportHeaderScalar"
+          },
+          "propertyNames": {
+            "not": {
+              "enum": ["__proto__", "constructor", "prototype"]
+            },
+            "pattern": "^[A-Za-z_][A-Za-z0-9_.-]{0,127}$"
+          },
+          "type": "object"
+        },
+        "required": {
+          "items": {
+            "pattern": "^[A-Za-z_][A-Za-z0-9_.-]{0,127}$",
+            "type": "string"
+          },
+          "type": "array",
+          "uniqueItems": true
+        },
+        "type": { "const": "object" }
+      },
+      "required": ["additionalProperties", "properties", "type"],
+      "type": "object"
+    },
+    "transportHeaderScalar": {
+      "oneOf": [
+        {
+          "allOf": [
+            { "$ref": "#/$defs/jsonSchema" },
+            {
+              "properties": {
+                "type": { "enum": ["boolean", "integer", "number"] }
+              },
+              "required": ["type"],
+              "type": "object"
+            }
+          ]
+        },
+        {
+          "additionalProperties": false,
+          "properties": {
+            "$schema": {
+              "const": "https://json-schema.org/draft/2020-12/schema"
+            },
+            "enum": {
+              "items": {
+                "maxLength": 8192,
+                "minLength": 1,
+                "pattern": "^[!-~](?:[ -~]*[!-~])?(?![\\s\\S])",
+                "type": "string"
+              },
+              "minItems": 1,
+              "type": "array",
+              "uniqueItems": true
+            },
+            "format": { "const": "ebk-http-header-value" },
+            "maxLength": {
+              "maximum": 8192,
+              "minimum": 1,
+              "type": "integer"
+            },
+            "minLength": {
+              "maximum": 8192,
+              "minimum": 1,
+              "type": "integer"
+            },
+            "pattern": {
+              "const": "^[!-~](?:[ -~]*[!-~])?(?![\\s\\S])"
+            },
+            "type": { "const": "string" }
+          },
+          "required": ["format", "maxLength", "minLength", "pattern", "type"],
+          "type": "object"
+        }
+      ]
+    },
+    "transportPathObject": {
+      "allOf": [
+        { "$ref": "#/$defs/jsonSchema" },
+        {
+          "properties": {
+            "additionalProperties": { "const": false },
+            "properties": {
+              "additionalProperties": {
+                "$ref": "#/$defs/transportPathScalar"
+              },
+              "type": "object"
+            },
+            "type": { "const": "object" }
+          },
+          "required": ["additionalProperties", "properties", "type"],
+          "type": "object"
+        }
+      ]
+    },
+    "transportPathScalar": {
+      "allOf": [
+        { "$ref": "#/$defs/transportScalar" },
+        {
+          "if": {
+            "properties": { "type": { "const": "string" } },
+            "required": ["type"]
+          },
+          "then": {
+            "anyOf": [
+              {
+                "properties": {
+                  "minLength": { "minimum": 1, "type": "integer" }
+                },
+                "required": ["minLength"]
+              },
+              {
+                "properties": { "format": { "const": "uuid" } },
+                "required": ["format"]
+              },
+              {
+                "properties": {
+                  "const": { "minLength": 1, "type": "string" }
+                },
+                "required": ["const"]
+              },
+              {
+                "properties": {
+                  "enum": {
+                    "items": { "minLength": 1, "type": "string" },
+                    "minItems": 1,
+                    "type": "array"
+                  }
+                },
+                "required": ["enum"]
+              }
+            ]
+          },
+          "type": "object"
+        }
+      ]
+    },
+    "transportQueryObject": {
+      "allOf": [
+        { "$ref": "#/$defs/jsonSchema" },
+        {
+          "properties": {
+            "additionalProperties": { "const": false },
+            "properties": {
+              "additionalProperties": {
+                "oneOf": [
+                  { "$ref": "#/$defs/transportScalar" },
+                  { "$ref": "#/$defs/transportScalarArray" }
+                ]
+              },
+              "type": "object"
+            },
+            "type": { "const": "object" }
+          },
+          "required": ["additionalProperties", "properties", "type"],
+          "type": "object"
+        }
+      ]
+    },
+    "transportScalar": {
+      "allOf": [
+        { "$ref": "#/$defs/jsonSchema" },
+        {
+          "properties": {
+            "type": { "enum": ["boolean", "integer", "number", "string"] }
+          },
+          "required": ["type"],
+          "type": "object"
+        }
+      ]
+    },
+    "transportScalarArray": {
+      "allOf": [
+        { "$ref": "#/$defs/jsonSchema" },
+        {
+          "properties": {
+            "items": { "$ref": "#/$defs/transportScalar" },
+            "minItems": { "minimum": 1, "type": "integer" },
+            "type": { "const": "array" }
+          },
+          "required": ["items", "minItems", "type"],
+          "type": "object"
+        }
+      ]
+    },
+    "token": {
+      "pattern": "^[A-Za-z0-9][A-Za-z0-9._:/@-]{0,255}$",
+      "type": "string"
+    }
+  },
+  "additionalProperties": false,
+  "properties": {
+    "kind": { "const": "api-contract-baseline" },
+    "operations": {
+      "items": { "$ref": "#/$defs/operation" },
+      "minItems": 1,
+      "type": "array"
+    },
+    "schemaVersion": { "const": 1 },
+    "slice": { "$ref": "#/$defs/slice" },
+    "title": { "maxLength": 256, "minLength": 1, "type": "string" },
+    "version": {
+      "maxLength": 256,
+      "pattern": "^(?:0|[1-9][0-9]*)\\.(?:0|[1-9][0-9]*)\\.(?:0|[1-9][0-9]*)$",
+      "type": "string"
+    }
+  },
+  "required": [
+    "kind",
+    "operations",
+    "schemaVersion",
+    "slice",
+    "title",
+    "version"
+  ],
+  "type": "object"
+}