@nylorun/runtime 0.17.0-beta → 0.19.0-beta

package/dist/admin-openapi.json

@@ -1,904 +0,0 @@
-{
-  "openapi": "3.2.0",
-  "info": {
-    "title": "Nylorun Runtime: Admin API",
-    "version": "0.17.0-beta",
-    "description": "The Host's status, its Tenant's state, shutdown and the Tenant's operator keys, with the admin key. Served on the operator listener when the Host has one; the public listener answers these routes with the opaque 404.",
-    "x-nylorun-protocol": {
-      "min": 4,
-      "max": 7,
-      "features": [
-        "runtime-tenants",
-        "admin-status",
-        "studio-principal",
-        "action-endpoints",
-        "artifacts",
-        "tenant-fixture-model",
-        "transcript-events",
-        "subject-headers",
-        "ag-ui-endpoint",
-        "a2a-endpoint",
-        "action-endpoints",
-        "sandboxes",
-        "sandbox-pods",
-        "trusted-issuers",
-        "operator-keys"
-      ]
-    }
-  },
-  "servers": [
-    {
-      "url": "{origin}",
-      "description": "The operator listener: a local Tenant's, or where yours runs",
-      "variables": {
-        "origin": {
-          "default": "http://localhost:8788"
-        }
-      }
-    }
-  ],
-  "components": {
-    "securitySchemes": {
-      "adminKey": {
-        "type": "http",
-        "scheme": "bearer",
-        "description": "The Host's admin key (`host-credentials.json`). Never a Tenant bearer."
-      }
-    },
-    "schemas": {
-      "AdminStatus": {
-        "type": "object",
-        "properties": {
-          "service": {
-            "type": "string",
-            "minLength": 1
-          },
-          "version": {
-            "type": "string",
-            "minLength": 1
-          },
-          "protocol": {
-            "type": "object",
-            "properties": {
-              "min": {
-                "type": "integer"
-              },
-              "max": {
-                "type": "integer"
-              },
-              "features": {
-                "type": "array",
-                "items": {
-                  "type": "string"
-                }
-              }
-            },
-            "required": [
-              "min",
-              "max",
-              "features"
-            ],
-            "additionalProperties": false
-          },
-          "tenant": {
-            "type": "object",
-            "properties": {
-              "id": {
-                "type": [
-                  "string",
-                  "null"
-                ],
-                "minLength": 1
-              },
-              "name": {
-                "type": [
-                  "string",
-                  "null"
-                ]
-              },
-              "state": {
-                "type": "string",
-                "enum": [
-                  "open",
-                  "unavailable"
-                ]
-              },
-              "envelope": {
-                "type": [
-                  "object",
-                  "null"
-                ],
-                "properties": {
-                  "id": {
-                    "type": "string",
-                    "minLength": 1
-                  },
-                  "name": {
-                    "type": "string",
-                    "minLength": 1
-                  },
-                  "createdAt": {
-                    "type": "string",
-                    "minLength": 1
-                  },
-                  "updatedAt": {
-                    "type": "string",
-                    "minLength": 1
-                  },
-                  "schemaVersion": {
-                    "type": "integer"
-                  }
-                },
-                "required": [
-                  "id",
-                  "name",
-                  "createdAt",
-                  "updatedAt",
-                  "schemaVersion"
-                ],
-                "additionalProperties": false
-              },
-              "cause": {
-                "type": "object",
-                "properties": {
-                  "code": {
-                    "type": "string",
-                    "enum": [
-                      "kek-missing",
-                      "corrupt",
-                      "schema-too-new",
-                      "migration-failed",
-                      "envelope-invalid",
-                      "open-timeout",
-                      "open-failed",
-                      "database-layout-old"
-                    ]
-                  },
-                  "message": {
-                    "type": "string"
-                  },
-                  "repair": {
-                    "type": "string"
-                  }
-                },
-                "required": [
-                  "code",
-                  "message",
-                  "repair"
-                ],
-                "additionalProperties": false
-              }
-            },
-            "required": [
-              "id",
-              "name",
-              "state",
-              "envelope"
-            ],
-            "additionalProperties": false
-          },
-          "aggregate": {
-            "type": "object",
-            "properties": {
-              "runningSessions": {
-                "type": "integer",
-                "minimum": 0
-              },
-              "inFlightDeliveries": {
-                "type": "integer",
-                "minimum": 0
-              },
-              "pendingActions": {
-                "type": "integer",
-                "minimum": 0
-              },
-              "uncertainEffects": {
-                "type": "integer",
-                "minimum": 0
-              },
-              "relay": {
-                "type": "object",
-                "properties": {
-                  "active": {
-                    "type": "boolean"
-                  },
-                  "pendingTxs": {
-                    "type": "integer",
-                    "minimum": 0
-                  },
-                  "pendingRows": {
-                    "type": "integer",
-                    "minimum": 0
-                  },
-                  "confirmed": {
-                    "type": [
-                      "string",
-                      "null"
-                    ]
-                  },
-                  "reconciliations": {
-                    "type": "integer",
-                    "minimum": 0
-                  },
-                  "lastError": {
-                    "type": [
-                      "string",
-                      "null"
-                    ]
-                  },
-                  "lagBytes": {
-                    "type": "number",
-                    "minimum": 0
-                  }
-                },
-                "required": [
-                  "active",
-                  "pendingTxs",
-                  "pendingRows",
-                  "confirmed",
-                  "reconciliations",
-                  "lastError"
-                ],
-                "additionalProperties": false
-              },
-              "harness": {
-                "type": "object",
-                "properties": {
-                  "mode": {
-                    "type": "string",
-                    "enum": [
-                      "in-process",
-                      "remote"
-                    ]
-                  },
-                  "connected": {
-                    "type": "integer",
-                    "minimum": 0
-                  },
-                  "workspace": {
-                    "type": "boolean"
-                  }
-                },
-                "required": [
-                  "mode",
-                  "connected",
-                  "workspace"
-                ],
-                "additionalProperties": false
-              }
-            },
-            "required": [
-              "runningSessions",
-              "inFlightDeliveries",
-              "pendingActions",
-              "uncertainEffects"
-            ],
-            "additionalProperties": false
-          },
-          "host": {
-            "type": "object",
-            "properties": {
-              "hostId": {
-                "type": "string",
-                "minLength": 1
-              },
-              "url": {
-                "type": "string",
-                "minLength": 1
-              },
-              "pid": {
-                "type": "integer"
-              }
-            },
-            "required": [
-              "hostId",
-              "url",
-              "pid"
-            ],
-            "additionalProperties": false
-          }
-        },
-        "required": [
-          "service",
-          "version",
-          "protocol",
-          "tenant",
-          "aggregate"
-        ],
-        "additionalProperties": false
-      },
-      "Rejected": {
-        "type": "object",
-        "properties": {
-          "status": {
-            "type": "string",
-            "enum": [
-              "rejected"
-            ]
-          },
-          "code": {
-            "type": "string",
-            "enum": [
-              "not_found",
-              "protocol_unsupported",
-              "host_rejected",
-              "origin_rejected",
-              "unsupported_media_type",
-              "connection_missing",
-              "incompatible_host",
-              "subject_invalid",
-              "scope_required",
-              "token_expired",
-              "limit_exceeded",
-              "request_rejected",
-              "invalid_request",
-              "subject_required",
-              "sandbox_not_granted",
-              "sandbox_busy",
-              "sandbox_unavailable",
-              "placement_refused",
-              "sandbox_lost",
-              "sandbox_expired",
-              "issuer_unavailable",
-              "oauth_client_required",
-              "oauth_state_invalid",
-              "oauth_failed",
-              "internal_error"
-            ]
-          },
-          "message": {
-            "type": "string"
-          },
-          "details": {},
-          "activeTurnId": {
-            "type": "string"
-          },
-          "requestId": {
-            "type": "string"
-          }
-        },
-        "required": [
-          "status",
-          "code",
-          "message"
-        ]
-      },
-      "ProtocolRejected": {
-        "type": "object",
-        "properties": {
-          "status": {
-            "type": "string",
-            "enum": [
-              "rejected"
-            ]
-          },
-          "code": {
-            "type": "string",
-            "enum": [
-              "protocol_unsupported"
-            ]
-          },
-          "protocol": {
-            "type": "object",
-            "properties": {
-              "min": {
-                "type": "integer"
-              },
-              "max": {
-                "type": "integer"
-              },
-              "features": {
-                "type": "array",
-                "items": {
-                  "type": "string"
-                }
-              }
-            },
-            "required": [
-              "min",
-              "max",
-              "features"
-            ],
-            "additionalProperties": false
-          }
-        },
-        "required": [
-          "status",
-          "code",
-          "protocol"
-        ],
-        "additionalProperties": false
-      },
-      "HostShutdownResponse": {
-        "type": "object",
-        "properties": {
-          "status": {
-            "type": "string",
-            "enum": [
-              "shutting_down"
-            ]
-          }
-        },
-        "required": [
-          "status"
-        ],
-        "additionalProperties": false
-      },
-      "ListOperatorKeysResponse": {
-        "type": "object",
-        "properties": {
-          "keys": {
-            "type": "array",
-            "items": {
-              "type": "object",
-              "properties": {
-                "id": {
-                  "type": "string",
-                  "minLength": 1
-                },
-                "role": {
-                  "type": "string",
-                  "minLength": 1
-                },
-                "createdAt": {
-                  "type": "string",
-                  "minLength": 1
-                }
-              },
-              "required": [
-                "id",
-                "role",
-                "createdAt"
-              ],
-              "additionalProperties": false
-            }
-          }
-        },
-        "required": [
-          "keys"
-        ],
-        "additionalProperties": false
-      },
-      "PutOperatorKeyResponse": {
-        "type": "object",
-        "properties": {
-          "id": {
-            "type": "string",
-            "minLength": 1
-          },
-          "role": {
-            "type": "string",
-            "minLength": 1
-          },
-          "createdAt": {
-            "type": "string",
-            "minLength": 1
-          },
-          "key": {
-            "type": "string",
-            "pattern": "^[0-9a-f]{64}$"
-          },
-          "rotated": {
-            "type": "boolean"
-          }
-        },
-        "required": [
-          "id",
-          "role",
-          "createdAt",
-          "key",
-          "rotated"
-        ],
-        "additionalProperties": false
-      },
-      "DeleteOperatorKeyResponse": {
-        "type": "object",
-        "properties": {
-          "id": {
-            "type": "string",
-            "minLength": 1
-          },
-          "deleted": {
-            "type": "boolean",
-            "enum": [
-              true
-            ]
-          }
-        },
-        "required": [
-          "id",
-          "deleted"
-        ],
-        "additionalProperties": false
-      }
-    },
-    "parameters": {}
-  },
-  "paths": {
-    "/v1/admin/status": {
-      "get": {
-        "summary": "Get the Host's status",
-        "tags": [
-          "Admin"
-        ],
-        "security": [
-          {
-            "adminKey": []
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "Version, protocol, the Tenant and the Host",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/AdminStatus"
-                }
-              }
-            }
-          },
-          "404": {
-            "description": "Not found: an unknown admin key, or the public listener",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/Rejected"
-                }
-              }
-            }
-          },
-          "426": {
-            "description": "`Nylorun-Protocol` missing or unsupported",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/ProtocolRejected"
-                }
-              }
-            }
-          }
-        }
-      }
-    },
-    "/v1/admin/host": {
-      "get": {
-        "summary": "Get the Host's status (alias)",
-        "tags": [
-          "Admin"
-        ],
-        "security": [
-          {
-            "adminKey": []
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "Version, protocol, the Tenant and the Host",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/AdminStatus"
-                }
-              }
-            }
-          },
-          "404": {
-            "description": "Not found: an unknown admin key, or the public listener",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/Rejected"
-                }
-              }
-            }
-          },
-          "426": {
-            "description": "`Nylorun-Protocol` missing or unsupported",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/ProtocolRejected"
-                }
-              }
-            }
-          }
-        }
-      }
-    },
-    "/v1/admin/host/shutdown": {
-      "post": {
-        "summary": "Shut the Host down",
-        "description": "Answers, then stops the Host. Served by a self-hosted Runtime only.",
-        "tags": [
-          "Admin"
-        ],
-        "security": [
-          {
-            "adminKey": []
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "The Host is stopping",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/HostShutdownResponse"
-                }
-              }
-            }
-          },
-          "404": {
-            "description": "Not found: an unknown admin key, or the public listener",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/Rejected"
-                }
-              }
-            }
-          },
-          "426": {
-            "description": "`Nylorun-Protocol` missing or unsupported",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/ProtocolRejected"
-                }
-              }
-            }
-          }
-        }
-      }
-    },
-    "/v1/admin/keys": {
-      "get": {
-        "summary": "List the Tenant's keys",
-        "description": "Every application key of the Tenant by name, with its role and when it was issued. Keys themselves are never shown again.",
-        "tags": [
-          "Admin"
-        ],
-        "security": [
-          {
-            "adminKey": []
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "The keys, by id",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/ListOperatorKeysResponse"
-                }
-              }
-            }
-          },
-          "404": {
-            "description": "Not found: an unknown admin key, or the public listener",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/Rejected"
-                }
-              }
-            }
-          },
-          "426": {
-            "description": "`Nylorun-Protocol` missing or unsupported",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/ProtocolRejected"
-                }
-              }
-            }
-          },
-          "503": {
-            "description": "The Tenant is not open",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/Rejected"
-                }
-              }
-            }
-          }
-        }
-      }
-    },
-    "/v1/admin/keys/{id}": {
-      "put": {
-        "summary": "Create or rotate a key",
-        "description": "Issues a new key named `id` and returns it this once. A key of that name is replaced: the old one stops authenticating at once. `studio` is refused.",
-        "tags": [
-          "Admin"
-        ],
-        "security": [
-          {
-            "adminKey": []
-          }
-        ],
-        "parameters": [
-          {
-            "schema": {
-              "type": "string",
-              "description": "The key's name: `^[a-z][a-z0-9-]{0,31}$`, never `studio`"
-            },
-            "required": true,
-            "description": "The key's name: `^[a-z][a-z0-9-]{0,31}$`, never `studio`",
-            "name": "id",
-            "in": "path"
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "The new key, shown once",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/PutOperatorKeyResponse"
-                }
-              }
-            }
-          },
-          "400": {
-            "description": "Not a key name, or `studio`",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/Rejected"
-                }
-              }
-            }
-          },
-          "404": {
-            "description": "Not found: an unknown admin key, or the public listener",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/Rejected"
-                }
-              }
-            }
-          },
-          "426": {
-            "description": "`Nylorun-Protocol` missing or unsupported",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/ProtocolRejected"
-                }
-              }
-            }
-          },
-          "503": {
-            "description": "The Tenant is not open",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/Rejected"
-                }
-              }
-            }
-          }
-        }
-      },
-      "delete": {
-        "summary": "Delete a key",
-        "description": "The key stops authenticating at once. `studio` is refused.",
-        "tags": [
-          "Admin"
-        ],
-        "security": [
-          {
-            "adminKey": []
-          }
-        ],
-        "parameters": [
-          {
-            "schema": {
-              "type": "string",
-              "description": "The key's name: `^[a-z][a-z0-9-]{0,31}$`, never `studio`"
-            },
-            "required": true,
-            "description": "The key's name: `^[a-z][a-z0-9-]{0,31}$`, never `studio`",
-            "name": "id",
-            "in": "path"
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "The key is deleted",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/DeleteOperatorKeyResponse"
-                }
-              }
-            }
-          },
-          "400": {
-            "description": "Not a key name, or `studio`",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/Rejected"
-                }
-              }
-            }
-          },
-          "404": {
-            "description": "No key of that name; or an unknown admin key, or the public listener",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/Rejected"
-                }
-              }
-            }
-          },
-          "426": {
-            "description": "`Nylorun-Protocol` missing or unsupported",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/ProtocolRejected"
-                }
-              }
-            }
-          },
-          "503": {
-            "description": "The Tenant is not open",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/Rejected"
-                }
-              }
-            }
-          }
-        }
-      }
-    },
-    "/v1/admin/openapi.json": {
-      "get": {
-        "summary": "Get this document",
-        "tags": [
-          "Admin"
-        ],
-        "security": [
-          {
-            "adminKey": []
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "The Admin API's OpenAPI document"
-          },
-          "404": {
-            "description": "Not found: an unknown admin key, or the public listener",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/Rejected"
-                }
-              }
-            }
-          },
-          "426": {
-            "description": "`Nylorun-Protocol` missing or unsupported",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/ProtocolRejected"
-                }
-              }
-            }
-          }
-        }
-      }
-    }
-  },
-  "webhooks": {}
-}