@8lines/gauntlet-protocol 0.1.0

package/schemas/v1/manifest.schema.json

@@ -0,0 +1,147 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.8lines.dev/gauntlet/v1/manifest.schema.json",
+  "type": "object",
+  "required": [
+    "protocolVersion",
+    "manifestRevision",
+    "schemaDialect",
+    "profiles",
+    "capabilities",
+    "application",
+    "features",
+    "operations",
+    "dataSources"
+  ],
+  "properties": {
+    "protocolVersion": { "$ref": "./common.schema.json#/$defs/protocolVersion" },
+    "manifestRevision": { "$ref": "./common.schema.json#/$defs/sha256Revision" },
+    "schemaDialect": { "const": "https://json-schema.org/draft/2020-12/schema" },
+    "profiles": {
+      "type": "array",
+      "items": { "$ref": "./common.schema.json#/$defs/profileId" },
+      "uniqueItems": true
+    },
+    "capabilities": {
+      "type": "array",
+      "items": { "$ref": "./common.schema.json#/$defs/capabilityId" },
+      "uniqueItems": true
+    },
+    "application": { "$ref": "#/$defs/application" },
+    "features": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/feature" }
+    },
+    "operations": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/operationSummary" }
+    },
+    "dataSources": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/dataSourceDefinition" }
+    },
+    "diagnostics": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/diagnostic" }
+    },
+    "extensions": { "$ref": "./common.schema.json#/$defs/extensions" }
+  },
+  "additionalProperties": false,
+  "$defs": {
+    "application": {
+      "type": "object",
+      "required": ["id", "label", "environment"],
+      "properties": {
+        "id": { "$ref": "./common.schema.json#/$defs/portableId" },
+        "label": { "type": "string", "minLength": 1 },
+        "environment": { "$ref": "./common.schema.json#/$defs/environmentDescriptor" },
+        "extensions": { "$ref": "./common.schema.json#/$defs/extensions" }
+      },
+      "additionalProperties": false
+    },
+    "feature": {
+      "type": "object",
+      "required": ["id", "label"],
+      "properties": {
+        "id": { "$ref": "./common.schema.json#/$defs/portableId" },
+        "label": { "type": "string", "minLength": 1 },
+        "parentId": { "$ref": "./common.schema.json#/$defs/portableId" },
+        "order": { "$ref": "./common.schema.json#/$defs/safeInteger" },
+        "extensions": { "$ref": "./common.schema.json#/$defs/extensions" }
+      },
+      "additionalProperties": false
+    },
+    "availability": {
+      "oneOf": [
+        {
+          "type": "object",
+          "required": ["state"],
+          "properties": { "state": { "const": "available" } },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": ["state", "problem"],
+          "properties": {
+            "state": { "const": "unavailable" },
+            "problem": { "$ref": "./common.schema.json#/$defs/problem" }
+          },
+          "additionalProperties": false
+        }
+      ]
+    },
+    "operationSummary": {
+      "type": "object",
+      "required": ["id", "revision", "label", "featureId", "availability"],
+      "properties": {
+        "id": { "$ref": "./common.schema.json#/$defs/portableId" },
+        "revision": { "$ref": "./common.schema.json#/$defs/sha256Revision" },
+        "label": { "type": "string", "minLength": 1 },
+        "featureId": { "$ref": "./common.schema.json#/$defs/portableId" },
+        "availability": { "$ref": "#/$defs/availability" },
+        "requirements": { "$ref": "./common.schema.json#/$defs/protocolRequirements" },
+        "placements": { "$ref": "./common.schema.json#/$defs/operationPlacements" },
+        "extensions": { "$ref": "./common.schema.json#/$defs/extensions" }
+      },
+      "additionalProperties": false
+    },
+    "dataSourceCapabilities": {
+      "type": "object",
+      "required": ["search", "pagination", "resolve", "defaultLimit", "maxLimit"],
+      "properties": {
+        "search": { "type": "boolean" },
+        "pagination": { "const": "cursor" },
+        "resolve": { "const": true },
+        "defaultLimit": { "$ref": "./common.schema.json#/$defs/positiveSafeInteger" },
+        "maxLimit": { "$ref": "./common.schema.json#/$defs/positiveSafeInteger" }
+      },
+      "additionalProperties": false
+    },
+    "dataSourceDefinition": {
+      "type": "object",
+      "required": ["id", "label", "capabilities"],
+      "properties": {
+        "id": { "$ref": "./common.schema.json#/$defs/portableId" },
+        "label": { "type": "string", "minLength": 1 },
+        "description": { "type": "string" },
+        "capabilities": { "$ref": "#/$defs/dataSourceCapabilities" },
+        "dependencySchema": { "$ref": "./common.schema.json#/$defs/objectJsonSchema" },
+        "contextSchema": { "$ref": "./common.schema.json#/$defs/objectJsonSchema" },
+        "extensions": { "$ref": "./common.schema.json#/$defs/extensions" }
+      },
+      "additionalProperties": false
+    },
+    "diagnostic": {
+      "type": "object",
+      "required": ["severity", "code", "message"],
+      "properties": {
+        "severity": { "enum": ["warning", "error"] },
+        "code": { "type": "string" },
+        "message": { "type": "string" },
+        "operationId": { "$ref": "./common.schema.json#/$defs/portableId" },
+        "extensions": { "$ref": "./common.schema.json#/$defs/extensions" }
+      },
+      "additionalProperties": false
+    }
+  }
+}

package/schemas/v1/operation-definition.schema.json

@@ -0,0 +1,326 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.8lines.dev/gauntlet/v1/operation-definition.schema.json",
+  "type": "object",
+  "required": [
+    "id",
+    "revision",
+    "label",
+    "featureId",
+    "order",
+    "tags",
+    "inputSchema",
+    "dataSources",
+    "presets",
+    "execution",
+    "output"
+  ],
+  "properties": {
+    "id": { "$ref": "./common.schema.json#/$defs/portableId" },
+    "revision": { "$ref": "./common.schema.json#/$defs/sha256Revision" },
+    "label": { "type": "string", "minLength": 1 },
+    "featureId": { "$ref": "./common.schema.json#/$defs/portableId" },
+    "description": { "type": "string" },
+    "icon": { "type": "string" },
+    "order": { "$ref": "./common.schema.json#/$defs/safeInteger" },
+    "tags": {
+      "type": "array",
+      "items": { "type": "string" },
+      "uniqueItems": true
+    },
+    "requirements": { "$ref": "./common.schema.json#/$defs/protocolRequirements" },
+    "placements": { "$ref": "./common.schema.json#/$defs/operationPlacements" },
+    "inputSchema": { "$ref": "./common.schema.json#/$defs/objectJsonSchema" },
+    "inputHandling": { "$ref": "#/$defs/inputHandling" },
+    "contextSchema": { "$ref": "./common.schema.json#/$defs/objectJsonSchema" },
+    "uiSchema": { "$ref": "#/$defs/operationUiSchema" },
+    "dataSources": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/dataSourceReference" }
+    },
+    "presets": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/operationPreset" }
+    },
+    "execution": { "$ref": "#/$defs/executionPolicy" },
+    "output": { "$ref": "#/$defs/operationOutput" },
+    "extensions": { "$ref": "./common.schema.json#/$defs/extensions" }
+  },
+  "additionalProperties": false,
+  "$defs": {
+    "dataSourceReference": {
+      "type": "object",
+      "required": ["id", "inputPointer", "dependencyPointers"],
+      "properties": {
+        "id": { "$ref": "./common.schema.json#/$defs/portableId" },
+        "inputPointer": { "$ref": "./common.schema.json#/$defs/jsonPointer" },
+        "dependencyPointers": {
+          "type": "array",
+          "items": { "$ref": "./common.schema.json#/$defs/jsonPointer" },
+          "uniqueItems": true
+        },
+        "contextPointers": {
+          "type": "array",
+          "items": { "$ref": "./common.schema.json#/$defs/jsonPointer" },
+          "uniqueItems": true
+        },
+        "required": { "type": "boolean" },
+        "extensions": { "$ref": "./common.schema.json#/$defs/extensions" }
+      },
+      "additionalProperties": false
+    },
+    "uiCondition": {
+      "oneOf": [
+        {
+          "type": "object",
+          "required": ["op", "pointer"],
+          "properties": {
+            "op": { "const": "present" },
+            "pointer": { "$ref": "./common.schema.json#/$defs/jsonPointer" }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": ["op", "pointer", "value"],
+          "properties": {
+            "op": { "const": "equals" },
+            "pointer": { "$ref": "./common.schema.json#/$defs/jsonPointer" },
+            "value": { "$ref": "./common.schema.json#/$defs/jsonValue" }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": ["op", "pointer", "values"],
+          "properties": {
+            "op": { "const": "in" },
+            "pointer": { "$ref": "./common.schema.json#/$defs/jsonPointer" },
+            "values": {
+              "type": "array",
+              "items": { "$ref": "./common.schema.json#/$defs/jsonValue" }
+            }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": ["op", "conditions"],
+          "properties": {
+            "op": { "enum": ["all", "any"] },
+            "conditions": {
+              "type": "array",
+              "items": { "$ref": "#/$defs/uiCondition" },
+              "minItems": 1
+            }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": ["op", "condition"],
+          "properties": {
+            "op": { "const": "not" },
+            "condition": { "$ref": "#/$defs/uiCondition" }
+          },
+          "additionalProperties": false
+        }
+      ]
+    },
+    "widget": {
+      "anyOf": [
+        {
+          "enum": [
+            "text",
+            "textarea",
+            "integer",
+            "number",
+            "toggle",
+            "select",
+            "multi-select",
+            "autocomplete",
+            "date",
+            "date-time",
+            "duration",
+            "code",
+            "json",
+            "secret",
+            "file"
+          ]
+        },
+        {
+          "type": "string",
+          "pattern": "^urn:[A-Za-z0-9][A-Za-z0-9:._/-]*$"
+        }
+      ]
+    },
+    "uiNode": {
+      "oneOf": [
+        {
+          "type": "object",
+          "required": ["type", "pointer"],
+          "properties": {
+            "type": { "const": "field" },
+            "pointer": { "$ref": "./common.schema.json#/$defs/jsonPointer" },
+            "widget": { "$ref": "#/$defs/widget" },
+            "dataSourceId": { "$ref": "./common.schema.json#/$defs/portableId" },
+            "label": { "type": "string" },
+            "help": { "type": "string" },
+            "options": { "$ref": "./common.schema.json#/$defs/jsonObject" },
+            "visibleWhen": { "$ref": "#/$defs/uiCondition" },
+            "enabledWhen": { "$ref": "#/$defs/uiCondition" }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": ["type", "children"],
+          "properties": {
+            "type": { "enum": ["group", "columns"] },
+            "label": { "type": "string" },
+            "children": {
+              "type": "array",
+              "items": { "$ref": "#/$defs/uiNode" }
+            },
+            "visibleWhen": { "$ref": "#/$defs/uiCondition" }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": ["type", "tabs"],
+          "properties": {
+            "type": { "const": "tabs" },
+            "tabs": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "required": ["id", "label", "children"],
+                "properties": {
+                  "id": { "$ref": "./common.schema.json#/$defs/portableId" },
+                  "label": { "type": "string" },
+                  "children": {
+                    "type": "array",
+                    "items": { "$ref": "#/$defs/uiNode" }
+                  }
+                },
+                "additionalProperties": false
+              }
+            }
+          },
+          "additionalProperties": false
+        }
+      ]
+    },
+    "operationUiSchema": {
+      "type": "object",
+      "required": ["profile", "root"],
+      "properties": {
+        "profile": { "const": "tc-rich-forms@1" },
+        "root": { "$ref": "#/$defs/uiNode" },
+        "extensions": { "$ref": "./common.schema.json#/$defs/extensions" }
+      },
+      "additionalProperties": false
+    },
+    "operationPreset": {
+      "type": "object",
+      "required": ["id", "label", "input"],
+      "properties": {
+        "id": { "$ref": "./common.schema.json#/$defs/portableId" },
+        "label": { "type": "string" },
+        "description": { "type": "string" },
+        "input": { "$ref": "./common.schema.json#/$defs/jsonObject" },
+        "lockedPointers": {
+          "type": "array",
+          "items": { "$ref": "./common.schema.json#/$defs/jsonPointer" },
+          "uniqueItems": true
+        },
+        "extensions": { "$ref": "./common.schema.json#/$defs/extensions" }
+      },
+      "additionalProperties": false
+    },
+    "secretRule": {
+      "type": "object",
+      "required": ["kind", "schemaPointer", "retention"],
+      "properties": {
+        "kind": { "const": "secret" },
+        "schemaPointer": { "$ref": "./common.schema.json#/$defs/jsonPointer" },
+        "retention": { "const": "none" }
+      },
+      "additionalProperties": false
+    },
+    "fileRule": {
+      "type": "object",
+      "required": ["kind", "schemaPointer", "multiple"],
+      "properties": {
+        "kind": { "const": "file" },
+        "schemaPointer": { "$ref": "./common.schema.json#/$defs/jsonPointer" },
+        "multiple": { "type": "boolean" },
+        "mediaTypes": {
+          "type": "array",
+          "items": { "type": "string", "minLength": 1 },
+          "uniqueItems": true
+        },
+        "maxBytes": { "$ref": "./common.schema.json#/$defs/positiveSafeInteger" }
+      },
+      "additionalProperties": false
+    },
+    "inputHandling": {
+      "type": "object",
+      "required": ["rules"],
+      "properties": {
+        "rules": {
+          "type": "array",
+          "items": {
+            "oneOf": [
+              { "$ref": "#/$defs/secretRule" },
+              { "$ref": "#/$defs/fileRule" }
+            ]
+          }
+        },
+        "extensions": { "$ref": "./common.schema.json#/$defs/extensions" }
+      },
+      "additionalProperties": false
+    },
+    "executionPolicy": {
+      "type": "object",
+      "required": [
+        "impact",
+        "confirmationRequired",
+        "dryRunSupported",
+        "idempotency",
+        "cancellationSupported"
+      ],
+      "properties": {
+        "impact": { "$ref": "./common.schema.json#/$defs/operationImpact" },
+        "confirmationRequired": { "type": "boolean" },
+        "dryRunSupported": { "type": "boolean" },
+        "idempotency": { "enum": ["none", "optional", "required"] },
+        "cancellationSupported": { "type": "boolean" },
+        "timeoutSeconds": { "$ref": "./common.schema.json#/$defs/positiveSafeInteger" },
+        "concurrency": { "enum": ["allow", "forbid", "queue"] },
+        "extensions": { "$ref": "./common.schema.json#/$defs/extensions" }
+      },
+      "additionalProperties": false
+    },
+    "resultPresentation": {
+      "type": "object",
+      "required": ["profile"],
+      "properties": {
+        "profile": { "const": "tc-rich-results@1" },
+        "defaultView": { "enum": ["summary", "details", "artifacts"] }
+      },
+      "additionalProperties": false
+    },
+    "operationOutput": {
+      "type": "object",
+      "required": ["schema"],
+      "properties": {
+        "schema": { "$ref": "./common.schema.json#/$defs/jsonSchema" },
+        "presentation": { "$ref": "#/$defs/resultPresentation" },
+        "extensions": { "$ref": "./common.schema.json#/$defs/extensions" }
+      },
+      "additionalProperties": false
+    }
+  }
+}

package/schemas/v1/problem.schema.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.8lines.dev/gauntlet/v1/problem.schema.json",
+  "$ref": "./common.schema.json#/$defs/problem"
+}

package/schemas/v1/run-event.schema.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.8lines.dev/gauntlet/v1/run-event.schema.json",
+  "type": "object",
+  "required": ["id", "sequence", "occurredAt", "type", "run"],
+  "properties": {
+    "id": { "$ref": "./common.schema.json#/$defs/portableId" },
+    "sequence": { "$ref": "./common.schema.json#/$defs/nonNegativeSafeInteger" },
+    "occurredAt": { "$ref": "./common.schema.json#/$defs/rfc3339Timestamp" },
+    "type": { "const": "run.updated" },
+    "run": { "$ref": "./run.schema.json" },
+    "extensions": { "$ref": "./common.schema.json#/$defs/extensions" }
+  },
+  "additionalProperties": false
+}

package/schemas/v1/run.schema.json

@@ -0,0 +1,95 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.8lines.dev/gauntlet/v1/run.schema.json",
+  "type": "object",
+  "required": [
+    "id",
+    "operationId",
+    "operationRevision",
+    "sequence",
+    "state",
+    "createdAt",
+    "updatedAt",
+    "artifacts",
+    "actions"
+  ],
+  "properties": {
+    "id": { "$ref": "./common.schema.json#/$defs/portableId" },
+    "operationId": { "$ref": "./common.schema.json#/$defs/portableId" },
+    "operationRevision": { "$ref": "./common.schema.json#/$defs/sha256Revision" },
+    "sequence": { "$ref": "./common.schema.json#/$defs/nonNegativeSafeInteger" },
+    "state": {
+      "enum": ["queued", "running", "succeeded", "failed", "partial", "cancelled", "timed_out", "expired"]
+    },
+    "createdAt": { "$ref": "./common.schema.json#/$defs/rfc3339Timestamp" },
+    "updatedAt": { "$ref": "./common.schema.json#/$defs/rfc3339Timestamp" },
+    "startedAt": { "$ref": "./common.schema.json#/$defs/rfc3339Timestamp" },
+    "completedAt": { "$ref": "./common.schema.json#/$defs/rfc3339Timestamp" },
+    "progress": { "$ref": "./common.schema.json#/$defs/runProgress" },
+    "summary": { "$ref": "./common.schema.json#/$defs/runSummary" },
+    "output": { "$ref": "./common.schema.json#/$defs/jsonValue" },
+    "artifacts": {
+      "type": "array",
+      "items": { "$ref": "./common.schema.json#/$defs/artifact" }
+    },
+    "actions": {
+      "type": "array",
+      "items": { "$ref": "./common.schema.json#/$defs/followUpAction" }
+    },
+    "problem": { "$ref": "./common.schema.json#/$defs/problem" },
+    "extensions": { "$ref": "./common.schema.json#/$defs/extensions" }
+  },
+  "additionalProperties": false,
+  "oneOf": [
+    {
+      "properties": {
+        "state": { "enum": ["queued", "running"] },
+        "completedAt": false,
+        "problem": false
+      }
+    },
+    {
+      "required": ["completedAt"],
+      "properties": {
+        "state": { "const": "succeeded" },
+        "problem": false
+      }
+    },
+    {
+      "required": ["completedAt", "problem"],
+      "properties": {
+        "state": { "enum": ["failed", "partial", "expired"] }
+      }
+    },
+    {
+      "required": ["completedAt", "problem"],
+      "properties": {
+        "state": { "const": "cancelled" },
+        "problem": {
+          "type": "object",
+          "required": ["type", "title", "status"],
+          "properties": {
+            "type": { "const": "urn:gauntlet:problem:run-cancelled" },
+            "title": { "const": "Run cancelled" },
+            "status": { "const": 409 }
+          }
+        }
+      }
+    },
+    {
+      "required": ["completedAt", "problem"],
+      "properties": {
+        "state": { "const": "timed_out" },
+        "problem": {
+          "type": "object",
+          "required": ["type", "title", "status"],
+          "properties": {
+            "type": { "const": "urn:gauntlet:problem:run-timed-out" },
+            "title": { "const": "Run timed out" },
+            "status": { "const": 504 }
+          }
+        }
+      }
+    }
+  ]
+}

package/schemas/v1/session-launch.schema.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.8lines.dev/gauntlet/v1/session-launch.schema.json",
+  "type": "object",
+  "required": ["url", "expiresAt", "singleUse"],
+  "properties": {
+    "url": { "$ref": "./common.schema.json#/$defs/httpUrl" },
+    "expiresAt": { "$ref": "./common.schema.json#/$defs/rfc3339Timestamp" },
+    "singleUse": { "const": true },
+    "extensions": { "$ref": "./common.schema.json#/$defs/extensions" }
+  },
+  "additionalProperties": false
+}

package/schemas/v1/upload.schema.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.8lines.dev/gauntlet/v1/upload.schema.json",
+  "type": "object",
+  "required": ["file"],
+  "properties": {
+    "file": { "$ref": "./common.schema.json#/$defs/fileReference" },
+    "extensions": { "$ref": "./common.schema.json#/$defs/extensions" }
+  },
+  "additionalProperties": false
+}