@everfur/cli 0.1.0

package/schema/sandbox-create.v1.schema.json

@@ -0,0 +1,74 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://everfur.com/contracts/cli-sandbox-create/v1",
+  "title": "Everfur CLI sandbox create document",
+  "description": "The committed output contract of `everfur sandbox create --json`. The load-bearing clause is `secretDisclosed: {const: false}`: this document may never carry a raw credential, and a machine reading it can assert that rather than trusting prose. Any change that made the field true would fail tests/contract before it shipped. `status: claim_unavailable` is a complete, valid document, not an error: the key WAS provisioned and there is simply no way to claim its secret, which exits 8.",
+  "type": "object",
+  "required": [
+    "schemaVersion",
+    "kind",
+    "generatedBy",
+    "status",
+    "requestId",
+    "clientId",
+    "keyId",
+    "label",
+    "createdAt",
+    "claimUrl",
+    "claimExpiresAt",
+    "secretDisclosed",
+    "secretDiscarded",
+    "orphanedKey",
+    "nextActions"
+  ],
+  "properties": {
+    "schemaVersion": { "const": 1 },
+    "kind": { "const": "everfur.sandbox-create" },
+    "generatedBy": {
+      "type": "object",
+      "required": ["name", "version"],
+      "properties": {
+        "name": { "type": "string", "minLength": 1 },
+        "version": { "type": "string", "minLength": 1 }
+      }
+    },
+    "status": { "enum": ["claim_issued", "claim_unavailable"] },
+    "requestId": { "oneOf": [{ "type": "null" }, { "type": "string", "minLength": 1 }] },
+    "clientId": { "type": "string" },
+    "keyId": { "type": "string", "minLength": 1 },
+    "label": { "oneOf": [{ "type": "null" }, { "type": "string" }] },
+    "createdAt": { "oneOf": [{ "type": "null" }, { "type": "string" }] },
+    "claimUrl": {
+      "description": "Where a human claims the secret in a browser. Null exactly when status is claim_unavailable.",
+      "oneOf": [{ "type": "null" }, { "type": "string", "minLength": 1 }]
+    },
+    "claimExpiresAt": { "oneOf": [{ "type": "null" }, { "type": "string" }] },
+    "secretDisclosed": {
+      "description": "Always false. The CLI does not print, log, or return a raw secret in any mode.",
+      "const": false
+    },
+    "secretDiscarded": {
+      "description": "True when the server returned a raw secret inline and the CLI discarded it unread, which leaves a live credential nobody holds.",
+      "type": "boolean"
+    },
+    "orphanedKey": {
+      "description": "What became of an unclaimable key. `not_needed` means a claim URL was issued and the key is wanted. `revoked` means the CLI minted an unclaimable key and revoked it again immediately, leaving nothing live behind. `revoke_failed` is the ONLY value that means a live credential nobody holds still exists.",
+      "enum": ["not_needed", "revoked", "revoke_failed"]
+    },
+    "nextActions": {
+      "type": "array",
+      "minItems": 1,
+      "items": { "type": "string", "minLength": 1 }
+    }
+  },
+  "allOf": [
+    {
+      "if": { "properties": { "status": { "const": "claim_unavailable" } }, "required": ["status"] },
+      "then": { "properties": { "claimUrl": { "type": "null" } } }
+    },
+    {
+      "if": { "properties": { "status": { "const": "claim_issued" } }, "required": ["status"] },
+      "then": { "properties": { "claimUrl": { "type": "string", "minLength": 1 } } }
+    }
+  ]
+}

package/schema/verification.v1.schema.json

@@ -0,0 +1,54 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://everfur.com/contracts/cli-verification/v1",
+  "title": "Everfur CLI verification document",
+  "description": "The committed output contract of `everfur verify --json`. Every step carries a result AND a reason, including a passing one: this command never reports a bare exit code as its result, and `reason` having minLength 1 on every step is that rule expressed where a machine can check it. `requestId` is null only for a step that made no call, which is what makes a SKIP legible in a support ticket.",
+  "type": "object",
+  "required": ["schemaVersion", "kind", "generatedBy", "status", "baseUrl", "summary", "steps"],
+  "properties": {
+    "schemaVersion": { "const": 1 },
+    "kind": { "const": "everfur.verification" },
+    "generatedBy": {
+      "type": "object",
+      "required": ["name", "version"],
+      "properties": {
+        "name": { "type": "string", "minLength": 1 },
+        "version": { "type": "string", "minLength": 1 }
+      }
+    },
+    "status": {
+      "description": "passed = every step PASSed. failed = at least one FAILed (exit 7). incomplete = nothing failed but a step was skipped (exit 3).",
+      "enum": ["passed", "failed", "incomplete"]
+    },
+    "baseUrl": { "type": "string", "minLength": 1 },
+    "summary": {
+      "type": "object",
+      "required": ["passed", "failed", "skipped"],
+      "properties": {
+        "passed": { "type": "integer", "minimum": 0 },
+        "failed": { "type": "integer", "minimum": 0 },
+        "skipped": { "type": "integer", "minimum": 0 }
+      }
+    },
+    "steps": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "object",
+        "required": ["id", "title", "result", "reason", "requestId", "details"],
+        "properties": {
+          "id": { "type": "string", "minLength": 1 },
+          "title": { "type": "string", "minLength": 1 },
+          "result": { "enum": ["PASS", "FAIL", "SKIP"] },
+          "reason": {
+            "description": "Always populated, for every result. A bare PASS is not a report.",
+            "type": "string",
+            "minLength": 1
+          },
+          "requestId": { "oneOf": [{ "type": "null" }, { "type": "string", "minLength": 1 }] },
+          "details": { "type": "array", "items": { "type": "string" } }
+        }
+      }
+    }
+  }
+}