{
  "components": {
    "headers": {
      "CacheControl": {
        "description": "public, max-age=3600: the document of a released version is public and does not change.",
        "schema": {
          "type": "string"
        }
      },
      "ETag": {
        "description": "The entity tag of the document: its checksum. A matching If-None-Match answers 304.",
        "schema": {
          "type": "string"
        }
      },
      "HiveRequestId": {
        "description": "req_ plus 26 characters; on every response (API-STD-R-029).",
        "schema": {
          "pattern": "^req_[0-9a-hjkmnp-tv-z]{26}$",
          "type": "string"
        }
      },
      "HiveVersion": {
        "description": "The effective API version.",
        "schema": {
          "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
          "type": "string"
        }
      }
    },
    "parameters": {
      "ApiKeyPath": {
        "description": "The ID of an API key of the tenant. Any other ID answers like a missing one.",
        "in": "path",
        "name": "id",
        "required": true,
        "schema": {
          "type": "string",
          "x-hive-prefix": "key"
        }
      },
      "ApiVersionPath": {
        "description": "A dated API version (API-VER)",
        "in": "path",
        "name": "version",
        "required": true,
        "schema": {
          "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
          "type": "string"
        }
      },
      "AssetCascade": {
        "description": "true also deletes every asset below this one; without it an asset with children is refused.",
        "in": "query",
        "name": "cascade",
        "required": false,
        "schema": {
          "default": false,
          "type": "boolean"
        }
      },
      "AssetDescendantDepth": {
        "description": "How many levels below the asset to list, 1 to 7; all of them when absent.",
        "in": "query",
        "name": "depth",
        "required": false,
        "schema": {
          "maximum": 7,
          "minimum": 1,
          "type": "integer"
        }
      },
      "AssetIncludeDeleted": {
        "description": "true also lists deleted assets; it needs asset.delete.",
        "in": "query",
        "name": "include_deleted",
        "required": false,
        "schema": {
          "default": false,
          "type": "boolean"
        }
      },
      "AssetPath": {
        "description": "The ID of an asset of the tenant. Any other ID answers like a missing one.",
        "in": "path",
        "name": "id",
        "required": true,
        "schema": {
          "type": "string",
          "x-hive-prefix": "ast"
        }
      },
      "AssetQuery": {
        "description": "Assets whose name or key starts with this text, without regard to case.",
        "in": "query",
        "name": "q",
        "required": false,
        "schema": {
          "maxLength": 100,
          "minLength": 1,
          "type": "string"
        }
      },
      "AssetTreeDepth": {
        "description": "How many levels below the asset to nest, 1 to 7; the default is 3.",
        "in": "query",
        "name": "depth",
        "required": false,
        "schema": {
          "default": 3,
          "maximum": 7,
          "minimum": 1,
          "type": "integer"
        }
      },
      "AssetUnder": {
        "description": "The root of a subtree: only this asset and the assets below it are listed. An ID of another tenant, or an unknown one, answers 404.",
        "in": "query",
        "name": "under",
        "required": false,
        "schema": {
          "type": "string",
          "x-hive-prefix": "ast"
        }
      },
      "ClockStatusPath": {
        "description": "The ID of a gateway or connection of the tenant (gwy or cnx). Any other ID answers like a missing one.",
        "in": "path",
        "name": "id",
        "required": true,
        "schema": {
          "pattern": "^(gwy|cnx)_[0-9a-hjkmnp-tv-z]{26}$",
          "type": "string"
        }
      },
      "HiveClientRequestId": {
        "description": "Client correlation ID, up to 128 printable ASCII characters. Echoed and logged (header registry, API-STD).",
        "in": "header",
        "name": "Hive-Client-Request-Id",
        "required": false,
        "schema": {
          "pattern": "^[\\x21-\\x7e]([\\x20-\\x7e]{0,126}[\\x21-\\x7e])?$",
          "type": "string"
        }
      },
      "HiveVersion": {
        "description": "Dated API version (API-VER). Absent means the tenant pin.",
        "in": "header",
        "name": "Hive-Version",
        "required": false,
        "schema": {
          "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
          "type": "string"
        }
      },
      "IdempotencyKey": {
        "description": "Client-chosen key making a create or action safe to retry (API-IDEM).",
        "in": "header",
        "name": "Idempotency-Key",
        "required": false,
        "schema": {
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        }
      },
      "IfMatch": {
        "description": "The version of the record the client read, as an ETag; a mismatch answers 412 version_mismatch (API-STD, API-IDEM).",
        "in": "header",
        "name": "If-Match",
        "required": false,
        "schema": {
          "maxLength": 64,
          "type": "string"
        }
      },
      "Limit": {
        "description": "The page size of a list, 1 to 500; the default is 50 (API-PAGE).",
        "in": "query",
        "name": "limit",
        "required": false,
        "schema": {
          "default": 50,
          "maximum": 500,
          "minimum": 1,
          "type": "integer"
        }
      },
      "MembershipUserId": {
        "description": "The user of the membership (IAM-SSO).",
        "in": "path",
        "name": "user_id",
        "required": true,
        "schema": {
          "type": "string",
          "x-hive-prefix": "usr"
        }
      },
      "ServiceAccountPath": {
        "description": "The ID of a service account of the tenant. Any other ID answers like a missing one.",
        "in": "path",
        "name": "id",
        "required": true,
        "schema": {
          "type": "string",
          "x-hive-prefix": "sva"
        }
      },
      "ShiftAt": {
        "description": "The instant, RFC 3339 with Z or a numeric offset.",
        "in": "query",
        "name": "at",
        "required": true,
        "schema": {
          "format": "date-time",
          "type": "string"
        }
      },
      "ShiftFromOn": {
        "description": "The first local date, inclusive.",
        "in": "query",
        "name": "from_on",
        "required": true,
        "schema": {
          "format": "date",
          "type": "string"
        }
      },
      "ShiftSitePath": {
        "description": "The ID of a site asset of the tenant. Any other ID answers like a missing one.",
        "in": "path",
        "name": "id",
        "required": true,
        "schema": {
          "type": "string",
          "x-hive-prefix": "ast"
        }
      },
      "ShiftToOn": {
        "description": "The last local date, inclusive. At most 62 days after from_on.",
        "in": "query",
        "name": "to_on",
        "required": true,
        "schema": {
          "format": "date",
          "type": "string"
        }
      },
      "SiteId": {
        "description": "The asset of kind site (GRAPH-HIER).",
        "in": "path",
        "name": "id",
        "required": true,
        "schema": {
          "type": "string",
          "x-hive-prefix": "ast"
        }
      },
      "SpecVersion": {
        "description": "A released dated version (YYYY-MM-DD). Absent means the latest released version (API-GOV-R-010).",
        "in": "query",
        "name": "version",
        "required": false,
        "schema": {
          "example": "2026-11-01",
          "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
          "type": "string"
        }
      },
      "TenantPath": {
        "description": "A tenant ID. Only the tenant of the request is readable: any other ID answers like a missing one.",
        "in": "path",
        "name": "id",
        "required": true,
        "schema": {
          "type": "string",
          "x-hive-prefix": "ten"
        }
      },
      "UnitsKind": {
        "description": "Only the units of this quantity kind (a slug of GET /v1/quantity-kinds).",
        "in": "query",
        "name": "kind",
        "required": false,
        "schema": {
          "maxLength": 64,
          "pattern": "^[a-z][a-z0-9_]{0,63}$",
          "type": "string"
        }
      }
    },
    "responses": {
      "Problem": {
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Problem"
            }
          }
        },
        "description": "Error (application/problem+json, API-ERR).",
        "headers": {
          "Hive-Request-Id": {
            "$ref": "#/components/headers/HiveRequestId"
          },
          "Hive-Version": {
            "$ref": "#/components/headers/HiveVersion"
          }
        }
      }
    },
    "schemas": {
      "ApiKey": {
        "additionalProperties": false,
        "description": "An API key. The key string is never part of this object after it was created.",
        "properties": {
          "allowed_cidrs": {
            "description": "The address ranges the key may be used from; empty means any address (at most 20).",
            "example": [
              "203.0.113.0/24"
            ],
            "items": {
              "type": "string"
            },
            "maxItems": 20,
            "type": "array"
          },
          "created_at": {
            "description": "When the key was created.",
            "example": "2026-11-11T09:30:00Z",
            "format": "date-time",
            "type": "string",
            "x-hive-index": "api_key_created_idx",
            "x-hive-sortable": true
          },
          "created_by": {
            "description": "The user who created the key.",
            "example": "usr_01m71xxng7fzrvspnkgtw1t2kg",
            "type": "string",
            "x-hive-prefix": "usr"
          },
          "env": {
            "description": "The environment of the key: live or test.",
            "enum": [
              "live",
              "test"
            ],
            "example": "live",
            "type": "string",
            "x-hive-open": false
          },
          "expires_at": {
            "description": "When the key stops working; at most 730 days after it was created.",
            "example": "2027-11-11T09:30:00Z",
            "format": "date-time",
            "type": "string"
          },
          "hint": {
            "description": "The last four characters of the secret, to recognise a key; the secret itself is never shown again.",
            "example": "EzXy",
            "maxLength": 4,
            "minLength": 4,
            "type": "string"
          },
          "id": {
            "description": "The key ID. It is part of the key string and is not a secret.",
            "example": "key_01m71xxng7fzrvspnkgtw1t2km",
            "type": "string",
            "x-hive-prefix": "key"
          },
          "last_used_at": {
            "description": "When the key was last used, within a minute.",
            "example": null,
            "format": "date-time",
            "type": [
              "string",
              "null"
            ]
          },
          "name": {
            "description": "A name for the key, for example the system that uses it.",
            "example": "MES feed",
            "maxLength": 100,
            "minLength": 1,
            "type": "string"
          },
          "object": {
            "const": "api_key",
            "description": "The object type name (canon 4).",
            "example": "api_key",
            "type": "string"
          },
          "previous_secret_expires_at": {
            "description": "Until when the secret before the last rotation still works, or null.",
            "example": null,
            "format": "date-time",
            "type": [
              "string",
              "null"
            ]
          },
          "rotated_at": {
            "description": "When the secret was last rotated.",
            "example": null,
            "format": "date-time",
            "type": [
              "string",
              "null"
            ]
          },
          "scopes": {
            "description": "The permissions the key can use at most: a ceiling over what the service account is granted. Patterns such as work_order.* are stored expanded, without human-only permissions.",
            "example": [
              "asset.read",
              "signal.query"
            ],
            "items": {
              "type": "string"
            },
            "minItems": 1,
            "type": "array"
          },
          "service_account_id": {
            "description": "The service account the key belongs to.",
            "example": "sva_01m71xxng7fzrvspnkgtw1t2kj",
            "type": "string",
            "x-hive-filterable": [
              "eq"
            ],
            "x-hive-index": "api_key_service_account",
            "x-hive-prefix": "sva"
          },
          "status": {
            "description": "The state of the key: active, revoked (by a person) or compromised (a leak was reported). Revoked and compromised are final.",
            "enum": [
              "active",
              "revoked",
              "compromised"
            ],
            "example": "active",
            "type": "string",
            "x-hive-open": false,
            "x-hive-state-machine": true
          },
          "updated_at": {
            "description": "When the key last changed.",
            "example": "2026-11-11T09:30:00Z",
            "format": "date-time",
            "type": "string"
          },
          "version": {
            "description": "The version of the key; send it in If-Match to update.",
            "example": 1,
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "service_account_id",
          "name",
          "env",
          "hint",
          "scopes",
          "allowed_cidrs",
          "status",
          "expires_at",
          "created_by",
          "created_at",
          "updated_at",
          "rotated_at",
          "previous_secret_expires_at",
          "last_used_at",
          "version"
        ],
        "type": "object",
        "x-hive-data-class": "personal",
        "x-hive-object-kind": "resource"
      },
      "ApiKeyCreate": {
        "additionalProperties": false,
        "description": "A new API key.",
        "properties": {
          "allowed_cidrs": {
            "description": "The address ranges the key may be used from; empty means any address (at most 20).",
            "example": [
              "203.0.113.0/24"
            ],
            "items": {
              "type": "string"
            },
            "maxItems": 20,
            "type": "array"
          },
          "env": {
            "description": "The environment of the key: live or test.",
            "enum": [
              "live",
              "test"
            ],
            "example": "live",
            "type": "string",
            "x-hive-open": false
          },
          "expires_at": {
            "description": "When the key stops working; 365 days from now when omitted, at most 730 days.",
            "example": "2027-11-11T09:30:00Z",
            "format": "date-time",
            "type": "string"
          },
          "name": {
            "description": "A name for the key, for example the system that uses it.",
            "example": "MES feed",
            "maxLength": 100,
            "minLength": 1,
            "type": "string"
          },
          "scopes": {
            "description": "The permissions the key can use at most; patterns such as work_order.* expand without human-only permissions, an explicit human-only permission is refused.",
            "example": [
              "signal.query",
              "asset.read",
              "work_order.*"
            ],
            "items": {
              "type": "string"
            },
            "minItems": 1,
            "type": "array"
          },
          "service_account_id": {
            "description": "The service account the key belongs to.",
            "example": "sva_01m71xxng7fzrvspnkgtw1t2kj",
            "type": "string",
            "x-hive-prefix": "sva"
          }
        },
        "required": [
          "service_account_id",
          "name",
          "env",
          "scopes"
        ],
        "type": "object"
      },
      "ApiKeyCreated": {
        "additionalProperties": false,
        "description": "An API key at the moment it is created or rotated: the only response that carries the secret.",
        "properties": {
          "allowed_cidrs": {
            "description": "The address ranges the key may be used from; empty means any address (at most 20).",
            "example": [
              "203.0.113.0/24"
            ],
            "items": {
              "type": "string"
            },
            "maxItems": 20,
            "type": "array"
          },
          "created_at": {
            "description": "When the key was created.",
            "example": "2026-11-11T09:30:00Z",
            "format": "date-time",
            "type": "string",
            "x-hive-index": "api_key_created_idx",
            "x-hive-sortable": true
          },
          "created_by": {
            "description": "The user who created the key.",
            "example": "usr_01m71xxng7fzrvspnkgtw1t2kg",
            "type": "string",
            "x-hive-prefix": "usr"
          },
          "env": {
            "description": "The environment of the key: live or test.",
            "enum": [
              "live",
              "test"
            ],
            "example": "live",
            "type": "string",
            "x-hive-open": false
          },
          "expires_at": {
            "description": "When the key stops working; at most 730 days after it was created.",
            "example": "2027-11-11T09:30:00Z",
            "format": "date-time",
            "type": "string"
          },
          "hint": {
            "description": "The last four characters of the secret, to recognise a key; the secret itself is never shown again.",
            "example": "EzXy",
            "maxLength": 4,
            "minLength": 4,
            "type": "string"
          },
          "id": {
            "description": "The key ID. It is part of the key string and is not a secret.",
            "example": "key_01m71xxng7fzrvspnkgtw1t2km",
            "type": "string",
            "x-hive-prefix": "key"
          },
          "last_used_at": {
            "description": "When the key was last used, within a minute.",
            "example": null,
            "format": "date-time",
            "type": [
              "string",
              "null"
            ]
          },
          "name": {
            "description": "A name for the key, for example the system that uses it.",
            "example": "MES feed",
            "maxLength": 100,
            "minLength": 1,
            "type": "string"
          },
          "object": {
            "const": "api_key",
            "description": "The object type name (canon 4).",
            "example": "api_key",
            "type": "string"
          },
          "previous_secret_expires_at": {
            "description": "Until when the secret before the last rotation still works, or null.",
            "example": null,
            "format": "date-time",
            "type": [
              "string",
              "null"
            ]
          },
          "rotated_at": {
            "description": "When the secret was last rotated.",
            "example": null,
            "format": "date-time",
            "type": [
              "string",
              "null"
            ]
          },
          "scopes": {
            "description": "The permissions the key can use at most: a ceiling over what the service account is granted. Patterns such as work_order.* are stored expanded, without human-only permissions.",
            "example": [
              "asset.read",
              "signal.query"
            ],
            "items": {
              "type": "string"
            },
            "minItems": 1,
            "type": "array"
          },
          "secret": {
            "description": "The full key. It is shown once, in this response, and never again.",
            "example": "hive_live_01m71xxng7fzrvspnkgtw1t2km_Zk3p9Qd7LmW2xVb8Nc4TgYh6JrAe1UoSi5Fa0KwDqEzXy",
            "type": "string",
            "x-hive-data-class": "secret"
          },
          "service_account_id": {
            "description": "The service account the key belongs to.",
            "example": "sva_01m71xxng7fzrvspnkgtw1t2kj",
            "type": "string",
            "x-hive-prefix": "sva"
          },
          "status": {
            "description": "The state of the key: active, revoked (by a person) or compromised (a leak was reported). Revoked and compromised are final.",
            "enum": [
              "active",
              "revoked",
              "compromised"
            ],
            "example": "active",
            "type": "string",
            "x-hive-open": false,
            "x-hive-state-machine": true
          },
          "updated_at": {
            "description": "When the key last changed.",
            "example": "2026-11-11T09:30:00Z",
            "format": "date-time",
            "type": "string"
          },
          "version": {
            "description": "The version of the key; send it in If-Match to update.",
            "example": 1,
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "service_account_id",
          "name",
          "env",
          "hint",
          "scopes",
          "allowed_cidrs",
          "status",
          "expires_at",
          "created_by",
          "created_at",
          "updated_at",
          "rotated_at",
          "previous_secret_expires_at",
          "last_used_at",
          "version",
          "secret"
        ],
        "type": "object",
        "x-hive-data-class": "personal",
        "x-hive-object-kind": "resource"
      },
      "ApiKeyList": {
        "additionalProperties": false,
        "description": "A page of API keys.",
        "properties": {
          "data": {
            "description": "One page of API keys.",
            "example": [],
            "items": {
              "$ref": "#/components/schemas/ApiKey"
            },
            "type": "array"
          },
          "has_more": {
            "description": "True when another page follows.",
            "example": false,
            "type": "boolean"
          },
          "next_cursor": {
            "description": "The cursor of the next page, or null on the last page.",
            "example": null,
            "type": [
              "string",
              "null"
            ]
          },
          "object": {
            "const": "list",
            "description": "The object type name (canon 4).",
            "example": "list",
            "type": "string"
          },
          "total_count": {
            "description": "The number of API keys, exact up to 10,000; null unless the request sends count=true.",
            "example": null,
            "minimum": 0,
            "type": [
              "integer",
              "null"
            ]
          },
          "total_count_is_lower_bound": {
            "description": "True when total_count stopped at its cap of 10,000; null unless the request sends count=true.",
            "example": null,
            "type": [
              "boolean",
              "null"
            ]
          }
        },
        "required": [
          "object",
          "data",
          "has_more",
          "next_cursor",
          "total_count",
          "total_count_is_lower_bound"
        ],
        "type": "object",
        "x-hive-object-kind": "list"
      },
      "ApiKeyRotate": {
        "additionalProperties": false,
        "description": "How long the old secret keeps working.",
        "properties": {
          "grace": {
            "description": "The grace period as an ISO 8601 duration, from one minute to 30 days; PT24H when omitted.",
            "example": "PT24H",
            "pattern": "^P(T(\\d+H)?(\\d+M)?|\\d+D)$",
            "type": "string"
          }
        },
        "type": "object"
      },
      "ApiKeyUpdate": {
        "additionalProperties": false,
        "description": "A change of an API key; send only what changes. Scopes and expiry never change: create a new key.",
        "minProperties": 1,
        "properties": {
          "allowed_cidrs": {
            "description": "The address ranges the key may be used from; empty means any address (at most 20).",
            "example": [
              "203.0.113.0/24"
            ],
            "items": {
              "type": "string"
            },
            "maxItems": 20,
            "type": "array"
          },
          "name": {
            "description": "A name for the key, for example the system that uses it.",
            "example": "MES feed",
            "maxLength": 100,
            "minLength": 1,
            "type": "string"
          }
        },
        "type": "object"
      },
      "ApiVersion": {
        "additionalProperties": false,
        "properties": {
          "changelog_url": {
            "description": "The public page that lists the changes of the version.",
            "example": "https://docs.hive.clerktree.com/changes/2026-11-01",
            "format": "uri",
            "type": "string"
          },
          "deprecated_on": {
            "description": "The announcement of the deprecation",
            "example": null,
            "format": "date",
            "type": [
              "string",
              "null"
            ]
          },
          "object": {
            "const": "api_version",
            "description": "The object type name (canon 4).",
            "type": "string"
          },
          "pinned_by_tenant": {
            "description": "True for the version the calling tenant is pinned to",
            "example": true,
            "type": "boolean"
          },
          "released_on": {
            "description": "The date the version was released.",
            "example": "2026-11-01",
            "format": "date",
            "type": "string"
          },
          "status": {
            "description": "Lifecycle state: current, supported, deprecated or retired (API-VER-R-017).",
            "enum": [
              "current",
              "supported",
              "deprecated",
              "retired"
            ],
            "example": "current",
            "type": "string",
            "x-hive-open": true
          },
          "sunset_on": {
            "description": "The date the version stops being served; null until a sunset is announced.",
            "example": null,
            "format": "date",
            "type": [
              "string",
              "null"
            ]
          },
          "version": {
            "description": "The identifier is the date; a version has no id (a slug, canon 2.3)",
            "example": "2026-11-01",
            "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
            "type": "string"
          }
        },
        "required": [
          "object",
          "version",
          "status",
          "released_on",
          "deprecated_on",
          "sunset_on",
          "changelog_url",
          "pinned_by_tenant"
        ],
        "type": "object",
        "x-hive-object-kind": "view"
      },
      "ApiVersionChange": {
        "additionalProperties": false,
        "description": "One breaking change of a dated version (API-VER-R-011)",
        "properties": {
          "affected_objects": {
            "description": "The object types the change rewrites wherever they appear.",
            "example": [
              "alarm"
            ],
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "affected_operations": {
            "description": "The operationIds whose requests or responses the change rewrites.",
            "example": [
              "alarm_list"
            ],
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "description": {
            "description": "What changed and why, for the changelog.",
            "example": "The priority of an alarm is the string low, medium, high or critical instead of the integer 1 to 4.",
            "type": "string"
          },
          "id": {
            "description": "The identifier of the change: its date and a slug.",
            "example": "2027-04-01-alarm-priority-enum",
            "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}-[a-z0-9]+(-[a-z0-9]+)*$",
            "type": "string"
          },
          "is_security_exception": {
            "description": "A breaking change made without the 24-month notice because a vulnerability could not otherwise be closed (API-VER-R-024)",
            "example": false,
            "type": "boolean"
          },
          "reversible": {
            "description": "True when a pure transformer can turn the new shape back into the old one.",
            "example": true,
            "type": "boolean"
          },
          "title": {
            "description": "In the language of the request (Accept-Language de or en)",
            "example": "Alarm priority is now an enumeration",
            "type": "string"
          },
          "title_i18n": {
            "additionalProperties": false,
            "description": "The title in both product languages.",
            "example": {
              "de": "Alarmpriorität ist jetzt eine Aufzählung",
              "en": "Alarm priority is now an enumeration"
            },
            "properties": {
              "de": {
                "description": "The German text.",
                "example": "Alarmpriorität ist jetzt eine Aufzählung",
                "type": "string"
              },
              "en": {
                "description": "The English text.",
                "example": "Alarm priority is now an enumeration",
                "type": "string"
              }
            },
            "required": [
              "en",
              "de"
            ],
            "type": "object"
          }
        },
        "required": [
          "id",
          "title",
          "title_i18n",
          "description",
          "affected_operations",
          "affected_objects",
          "reversible",
          "is_security_exception"
        ],
        "type": "object"
      },
      "ApiVersionDetail": {
        "additionalProperties": false,
        "properties": {
          "changelog_url": {
            "description": "The public page that lists the changes of the version.",
            "example": "https://docs.hive.clerktree.com/changes/2026-11-01",
            "format": "uri",
            "type": "string"
          },
          "changes": {
            "description": "The breaking changes of the version, oldest first.",
            "example": [],
            "items": {
              "$ref": "#/components/schemas/ApiVersionChange"
            },
            "type": "array"
          },
          "deprecated_on": {
            "description": "The announcement of the deprecation",
            "example": null,
            "format": "date",
            "type": [
              "string",
              "null"
            ]
          },
          "object": {
            "const": "api_version",
            "description": "The object type name (canon 4).",
            "type": "string"
          },
          "pinned_by_tenant": {
            "description": "True for the version the calling tenant is pinned to",
            "example": true,
            "type": "boolean"
          },
          "released_on": {
            "description": "The date the version was released.",
            "example": "2026-11-01",
            "format": "date",
            "type": "string"
          },
          "status": {
            "description": "Lifecycle state: current, supported, deprecated or retired (API-VER-R-017).",
            "enum": [
              "current",
              "supported",
              "deprecated",
              "retired"
            ],
            "example": "current",
            "type": "string",
            "x-hive-open": true
          },
          "sunset_on": {
            "description": "The date the version stops being served; null until a sunset is announced.",
            "example": null,
            "format": "date",
            "type": [
              "string",
              "null"
            ]
          },
          "version": {
            "description": "The identifier is the date; a version has no id (a slug, canon 2.3)",
            "example": "2026-11-01",
            "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
            "type": "string"
          }
        },
        "required": [
          "object",
          "version",
          "status",
          "released_on",
          "deprecated_on",
          "sunset_on",
          "changelog_url",
          "pinned_by_tenant",
          "changes"
        ],
        "type": "object",
        "x-hive-object-kind": "view"
      },
      "ApiVersionList": {
        "additionalProperties": false,
        "description": "Every version of the registry. The registry is small and closed, so the list is never paged: has_more is false and next_cursor null (RECONCILE 148)",
        "properties": {
          "data": {
            "description": "The versions, newest first.",
            "example": [],
            "items": {
              "$ref": "#/components/schemas/ApiVersion"
            },
            "type": "array"
          },
          "has_more": {
            "const": false,
            "description": "Always false: the registry is small and closed, so the list is never paged.",
            "example": false,
            "type": "boolean"
          },
          "next_cursor": {
            "description": "Always null: the list is never paged.",
            "example": null,
            "type": "null"
          },
          "object": {
            "const": "list",
            "description": "The object type name (canon 4).",
            "type": "string"
          }
        },
        "required": [
          "object",
          "data",
          "has_more",
          "next_cursor"
        ],
        "type": "object",
        "x-hive-object-kind": "view"
      },
      "ApiVersionPinPreview": {
        "additionalProperties": false,
        "properties": {
          "affected_calls_last_30_days": {
            "description": "The calls of the last 30 days, by credential, operation and version, that the changes affect. Only the credentials of the calling tenant are listed (API-VER-R-030).",
            "example": [
              {
                "calls": 42,
                "operation_id": "alarm_list",
                "principal_id": "sva_01jc8z3k5me9rt7q2v4x6b0dnh",
                "version": "2026-11-01"
              }
            ],
            "items": {
              "additionalProperties": false,
              "properties": {
                "calls": {
                  "description": "The number of calls in the last 30 days.",
                  "example": 42,
                  "minimum": 0,
                  "type": "integer"
                },
                "operation_id": {
                  "description": "The operationId that was called.",
                  "example": "alarm_list",
                  "type": "string"
                },
                "principal_id": {
                  "description": "The service account that made the calls.",
                  "example": "sva_01jc8z3k5me9rt7q2v4x6b0dnh",
                  "type": "string",
                  "x-hive-prefix": "sva"
                },
                "version": {
                  "description": "A dated API version, YYYY-MM-DD (API-VER-R-002).",
                  "example": "2027-04-01",
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
                  "type": "string"
                }
              },
              "required": [
                "principal_id",
                "operation_id",
                "version",
                "calls"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "changes": {
            "description": "The breaking changes of the version, oldest first.",
            "example": [
              {
                "id": "2027-04-01-alarm-priority-enum",
                "title": "Alarm priority is now an enumeration"
              }
            ],
            "items": {
              "additionalProperties": false,
              "properties": {
                "id": {
                  "description": "The identifier of the change: its date and a slug.",
                  "example": "2027-04-01-alarm-priority-enum",
                  "type": "string"
                },
                "title": {
                  "description": "The title in the language of the request (Accept-Language de or en).",
                  "example": "Alarm priority is now an enumeration",
                  "type": "string"
                }
              },
              "required": [
                "id",
                "title"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "from_version": {
            "description": "The version the tenant is pinned to now.",
            "example": "2026-11-01",
            "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
            "type": "string"
          },
          "object": {
            "const": "api_version_pin_preview",
            "description": "The object type name (canon 4).",
            "type": "string"
          },
          "to_version": {
            "description": "The version the tenant asked to pin.",
            "example": "2027-04-01",
            "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
            "type": "string"
          }
        },
        "required": [
          "object",
          "from_version",
          "to_version",
          "changes",
          "affected_calls_last_30_days"
        ],
        "type": "object",
        "x-hive-object-kind": "view"
      },
      "ApiVersionPinRequest": {
        "additionalProperties": false,
        "properties": {
          "dry_run": {
            "default": false,
            "description": "True lists the changes and the calls of the last 30 days they affect, and changes nothing",
            "example": true,
            "type": "boolean"
          },
          "version": {
            "description": "A served version of the registry, newer or older than the current pin",
            "example": "2027-04-01",
            "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
            "type": "string"
          }
        },
        "required": [
          "version"
        ],
        "type": "object"
      },
      "ApiVersionPinResponse": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/ApiVersionPinPreview"
          },
          {
            "$ref": "#/components/schemas/ApiVersionPinResult"
          }
        ]
      },
      "ApiVersionPinResult": {
        "additionalProperties": false,
        "properties": {
          "effective_at": {
            "description": "The latest time by which every gateway uses the new pin (at most 60 seconds after the change)",
            "example": "2026-11-16T09:15:00Z",
            "format": "date-time",
            "type": "string"
          },
          "object": {
            "const": "api_version_pin",
            "description": "The object type name (canon 4).",
            "type": "string"
          },
          "version": {
            "description": "A dated API version, YYYY-MM-DD (API-VER-R-002).",
            "example": "2027-04-01",
            "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
            "type": "string"
          }
        },
        "required": [
          "object",
          "version",
          "effective_at"
        ],
        "type": "object",
        "x-hive-object-kind": "view"
      },
      "Asset": {
        "additionalProperties": false,
        "description": "A node of the asset hierarchy: a site, area, line, work unit, machine or component. It names no person (GRAPH-HIER-R-023).",
        "properties": {
          "asset_type_id": {
            "description": "The asset type (GRAPH-TYPE), or null.",
            "example": "aty_01m71xxqhkf9avn6dq2sfgzgym",
            "type": [
              "string",
              "null"
            ],
            "x-hive-filterable": [
              "eq",
              "in",
              "is_null"
            ],
            "x-hive-index": "asset_type_ix",
            "x-hive-prefix": "aty"
          },
          "asset_type_version": {
            "description": "The version of the asset type the asset follows, or null.",
            "example": 3,
            "minimum": 1,
            "type": [
              "integer",
              "null"
            ]
          },
          "build_year": {
            "description": "The year the equipment was built.",
            "example": 2019,
            "maximum": 2200,
            "minimum": 1900,
            "type": [
              "integer",
              "null"
            ]
          },
          "commissioned_on": {
            "description": "The date the equipment was first put into service.",
            "example": "2019-09-02",
            "format": "date",
            "type": [
              "string",
              "null"
            ]
          },
          "created_at": {
            "description": "When the asset was created.",
            "example": "2025-11-03T09:00:00Z",
            "format": "date-time",
            "type": "string",
            "x-hive-index": "asset_created_ix",
            "x-hive-sortable": true
          },
          "deleted_at": {
            "description": "When the asset was deleted, or null. Deleted assets appear only with include_deleted.",
            "example": null,
            "format": "date-time",
            "type": [
              "string",
              "null"
            ]
          },
          "description_i18n": {
            "additionalProperties": {
              "maxLength": 2000,
              "type": "string"
            },
            "description": "A description per language tag (BCP 47), for example de and en.",
            "example": {
              "de": "5-Achs-Bearbeitungszentrum",
              "en": "5-axis machining centre"
            },
            "type": [
              "object",
              "null"
            ],
            "x-hive-open": true
          },
          "external_refs": {
            "description": "The links to the records of this asset in other systems. They are read from GRAPH-IDRES and never stored here.",
            "example": [
              {
                "id": "10004711",
                "system": "sap-pm/equipment",
                "url": null
              }
            ],
            "items": {
              "additionalProperties": false,
              "properties": {
                "id": {
                  "description": "The ID in that system.",
                  "example": "10004711",
                  "type": "string"
                },
                "system": {
                  "description": "The system and record type.",
                  "example": "sap-pm/equipment",
                  "type": "string"
                },
                "url": {
                  "description": "A link to the record, or null.",
                  "example": null,
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "required": [
                "system",
                "id",
                "url"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "id": {
            "description": "The ID of the asset (ast prefix).",
            "example": "ast_01m71xxng7fzrvspnkgtw1t2kg",
            "type": "string",
            "x-hive-prefix": "ast"
          },
          "key": {
            "description": "The human key (CNC-07), 1 to 64 characters from A-Z a-z 0-9 . _ / space and hyphen, unique in the tenant without regard to case among assets that are not deleted.",
            "example": "CNC-07",
            "maxLength": 64,
            "minLength": 1,
            "pattern": "^[A-Za-z0-9._/ -]+$",
            "type": [
              "string",
              "null"
            ],
            "x-hive-filterable": [
              "eq",
              "prefix"
            ],
            "x-hive-index": "asset_key_ix",
            "x-hive-text-searchable": true
          },
          "kind": {
            "description": "The kind of node in the hierarchy: site, area, line, work_unit, machine or component. It cannot be changed.",
            "enum": [
              "site",
              "area",
              "line",
              "work_unit",
              "machine",
              "component"
            ],
            "example": "machine",
            "type": "string",
            "x-hive-filterable": [
              "eq",
              "in"
            ],
            "x-hive-index": "asset_kind_ix",
            "x-hive-open": false
          },
          "lifecycle_changed_at": {
            "description": "When the lifecycle state was last set (or the effective time given).",
            "example": "2026-01-12T07:00:00Z",
            "format": "date-time",
            "type": "string"
          },
          "lifecycle_state": {
            "description": "The lifecycle: planned, commissioning, active, standby or decommissioned. It is metadata and never changes a machine (GRAPH-HIER-R-025).",
            "enum": [
              "planned",
              "commissioning",
              "active",
              "standby",
              "decommissioned"
            ],
            "example": "active",
            "type": "string",
            "x-hive-filterable": [
              "eq",
              "in"
            ],
            "x-hive-index": "asset_lifecycle_ix",
            "x-hive-open": false,
            "x-hive-state-machine": true
          },
          "manufacturer": {
            "description": "The manufacturer.",
            "example": "Kessler Werkzeugmaschinen AG",
            "maxLength": 200,
            "type": [
              "string",
              "null"
            ]
          },
          "model": {
            "description": "The model.",
            "example": "KM 500",
            "maxLength": 200,
            "type": [
              "string",
              "null"
            ]
          },
          "name": {
            "description": "The display name.",
            "example": "CNC-07 5-axis machining centre",
            "maxLength": 200,
            "minLength": 1,
            "type": "string"
          },
          "object": {
            "const": "asset",
            "description": "The object type name (canon 4).",
            "example": "asset",
            "type": "string"
          },
          "parent_id": {
            "description": "The parent asset; null only for a site. Moving changes it, a PATCH does not.",
            "example": "ast_01m71xxpcwfz1snpsm3pqdqrjc",
            "type": [
              "string",
              "null"
            ],
            "x-hive-filterable": [
              "eq",
              "in",
              "is_null"
            ],
            "x-hive-index": "asset_parent_ix",
            "x-hive-prefix": "ast"
          },
          "path_keys": {
            "description": "The names of the asset and of its ancestors from the site down, for display. It is computed on read.",
            "example": [
              "Musterwerk Esslingen",
              "Halle 1",
              "Line 2",
              "CNC-07"
            ],
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "properties": {
            "additionalProperties": true,
            "description": "Free properties of the asset, at most 16 KiB. When the asset has a type they validate against its property schema.",
            "example": {
              "rated_spindle_speed": {
                "unit": "1/min",
                "value": 12000
              }
            },
            "type": "object",
            "x-hive-open": true
          },
          "serial_number": {
            "description": "The serial number of the manufacturer.",
            "example": "KM500-190412",
            "maxLength": 200,
            "type": [
              "string",
              "null"
            ]
          },
          "site_id": {
            "description": "The site at the root of this asset's tree; equal to id for a site.",
            "example": "ast_01m71xxn9ze26b4pq3dnxee9ms",
            "type": "string",
            "x-hive-filterable": [
              "eq",
              "in"
            ],
            "x-hive-index": "asset_site_ix",
            "x-hive-prefix": "ast"
          },
          "site_profile": {
            "additionalProperties": false,
            "description": "The time zone, country and address of a site; null for every other kind.",
            "example": {
              "address": null,
              "country": "DE",
              "time_zone": "Europe/Berlin"
            },
            "properties": {
              "address": {
                "additionalProperties": true,
                "description": "The postal address of the site as the customer enters it; free form.",
                "example": {
                  "city": "Esslingen am Neckar",
                  "postal_code": "73730",
                  "street": "Plochinger Strasse 12"
                },
                "type": [
                  "object",
                  "null"
                ],
                "x-hive-open": true
              },
              "country": {
                "description": "The ISO 3166-1 alpha-2 country code of the site.",
                "example": "DE",
                "pattern": "^[A-Z]{2}$",
                "type": "string"
              },
              "time_zone": {
                "description": "The IANA time zone of the site, for German sites Europe/Berlin. It is validated against the time zone database and never defaults to UTC.",
                "example": "Europe/Berlin",
                "maxLength": 64,
                "minLength": 1,
                "type": "string"
              }
            },
            "required": [
              "time_zone",
              "country",
              "address"
            ],
            "type": [
              "object",
              "null"
            ]
          },
          "sort_order": {
            "description": "The position among the siblings; ties break by name.",
            "example": 0,
            "maximum": 2147483647,
            "minimum": -2147483648,
            "type": "integer",
            "x-hive-index": "asset_parent_ix",
            "x-hive-sortable": true
          },
          "updated_at": {
            "description": "When the asset last changed.",
            "example": "2026-01-12T07:00:00Z",
            "format": "date-time",
            "type": "string"
          },
          "variant": {
            "description": "The variant.",
            "example": null,
            "maxLength": 200,
            "type": [
              "string",
              "null"
            ]
          },
          "version": {
            "description": "The version of the asset; send it in If-Match to update.",
            "example": 5,
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "kind",
          "parent_id",
          "site_id",
          "key",
          "name",
          "description_i18n",
          "asset_type_id",
          "asset_type_version",
          "lifecycle_state",
          "lifecycle_changed_at",
          "manufacturer",
          "model",
          "variant",
          "serial_number",
          "build_year",
          "commissioned_on",
          "properties",
          "sort_order",
          "path_keys",
          "external_refs",
          "site_profile",
          "version",
          "created_at",
          "updated_at",
          "deleted_at"
        ],
        "type": "object"
      },
      "AssetAncestorList": {
        "additionalProperties": false,
        "description": "The ancestors of an asset, nearest first and ending with the site. The list is never paged (a tree has at most 8 levels).",
        "properties": {
          "data": {
            "description": "The ancestors, nearest first.",
            "example": [],
            "items": {
              "$ref": "#/components/schemas/Asset"
            },
            "type": "array"
          },
          "has_more": {
            "const": false,
            "description": "Always false: the list is never paged.",
            "example": false,
            "type": "boolean"
          },
          "next_cursor": {
            "description": "Always null: the list is never paged.",
            "example": null,
            "type": "null"
          },
          "object": {
            "const": "list",
            "description": "The object type name (canon 4).",
            "example": "list",
            "type": "string"
          }
        },
        "required": [
          "object",
          "data",
          "has_more",
          "next_cursor"
        ],
        "type": "object",
        "x-hive-object-kind": "view"
      },
      "AssetCreate": {
        "additionalProperties": false,
        "description": "A new asset. The tenant comes from the credential and the ID is generated by the server; a field that names either is refused.",
        "properties": {
          "asset_type_id": {
            "description": "The asset type (GRAPH-TYPE), or null.",
            "example": "aty_01m71xxqhkf9avn6dq2sfgzgym",
            "type": [
              "string",
              "null"
            ],
            "x-hive-prefix": "aty"
          },
          "build_year": {
            "description": "The year the equipment was built.",
            "example": 2019,
            "maximum": 2200,
            "minimum": 1900,
            "type": [
              "integer",
              "null"
            ]
          },
          "commissioned_on": {
            "description": "The date the equipment was first put into service.",
            "example": "2019-09-02",
            "format": "date",
            "type": [
              "string",
              "null"
            ]
          },
          "description_i18n": {
            "additionalProperties": {
              "maxLength": 2000,
              "type": "string"
            },
            "description": "A description per language tag (BCP 47), for example de and en.",
            "example": {
              "de": "5-Achs-Bearbeitungszentrum",
              "en": "5-axis machining centre"
            },
            "type": [
              "object",
              "null"
            ],
            "x-hive-open": true
          },
          "external_refs": {
            "description": "Accepted only as an empty list: the external references of an asset are written through GRAPH-IDRES, not here.",
            "example": [],
            "items": {
              "additionalProperties": true,
              "type": "object",
              "x-hive-open": true
            },
            "maxItems": 0,
            "type": "array"
          },
          "key": {
            "description": "The human key (CNC-07), 1 to 64 characters from A-Z a-z 0-9 . _ / space and hyphen, unique in the tenant without regard to case among assets that are not deleted.",
            "example": "CNC-07",
            "maxLength": 64,
            "minLength": 1,
            "pattern": "^[A-Za-z0-9._/ -]+$",
            "type": [
              "string",
              "null"
            ]
          },
          "kind": {
            "description": "The kind of node in the hierarchy: site, area, line, work_unit, machine or component. It cannot be changed.",
            "enum": [
              "site",
              "area",
              "line",
              "work_unit",
              "machine",
              "component"
            ],
            "example": "machine",
            "type": "string",
            "x-hive-open": false
          },
          "manufacturer": {
            "description": "The manufacturer.",
            "example": "Kessler Werkzeugmaschinen AG",
            "maxLength": 200,
            "type": [
              "string",
              "null"
            ]
          },
          "model": {
            "description": "The model.",
            "example": "KM 500",
            "maxLength": 200,
            "type": [
              "string",
              "null"
            ]
          },
          "name": {
            "description": "The display name.",
            "example": "CNC-07 5-axis machining centre",
            "maxLength": 200,
            "minLength": 1,
            "type": "string"
          },
          "parent_id": {
            "description": "The parent asset. Required for every kind except a site, which has none.",
            "example": "ast_01m71xxpcwfz1snpsm3pqdqrjc",
            "type": [
              "string",
              "null"
            ],
            "x-hive-prefix": "ast"
          },
          "properties": {
            "additionalProperties": true,
            "description": "Free properties of the asset, at most 16 KiB. When the asset has a type they validate against its property schema.",
            "example": {
              "rated_spindle_speed": {
                "unit": "1/min",
                "value": 12000
              }
            },
            "type": "object",
            "x-hive-open": true
          },
          "serial_number": {
            "description": "The serial number of the manufacturer.",
            "example": "KM500-190412",
            "maxLength": 200,
            "type": [
              "string",
              "null"
            ]
          },
          "site_profile": {
            "additionalProperties": false,
            "description": "Required for a site: the time zone and country, with an optional address. Refused for every other kind.",
            "example": {
              "country": "DE",
              "time_zone": "Europe/Berlin"
            },
            "properties": {
              "address": {
                "additionalProperties": true,
                "description": "The postal address of the site as the customer enters it; free form.",
                "example": {
                  "city": "Esslingen am Neckar",
                  "postal_code": "73730",
                  "street": "Plochinger Strasse 12"
                },
                "type": [
                  "object",
                  "null"
                ],
                "x-hive-open": true
              },
              "country": {
                "description": "The ISO 3166-1 alpha-2 country code of the site.",
                "example": "DE",
                "pattern": "^[A-Z]{2}$",
                "type": "string"
              },
              "time_zone": {
                "description": "The IANA time zone of the site, for German sites Europe/Berlin. It is validated against the time zone database and never defaults to UTC.",
                "example": "Europe/Berlin",
                "maxLength": 64,
                "minLength": 1,
                "type": "string"
              }
            },
            "type": [
              "object",
              "null"
            ]
          },
          "sort_order": {
            "description": "The position among the siblings; ties break by name.",
            "example": 0,
            "maximum": 2147483647,
            "minimum": -2147483648,
            "type": "integer"
          },
          "variant": {
            "description": "The variant.",
            "example": null,
            "maxLength": 200,
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "kind",
          "name"
        ],
        "type": "object"
      },
      "AssetLifecycleChange": {
        "additionalProperties": false,
        "description": "A lifecycle transition. It records metadata only and starts no action on a machine.",
        "properties": {
          "effective_at": {
            "description": "When the change took effect, possibly in the past; it only labels lifecycle_changed_at. Null means now.",
            "example": null,
            "format": "date-time",
            "type": [
              "string",
              "null"
            ]
          },
          "reason": {
            "description": "Why, in a sentence; it is not logged.",
            "example": "Planned stop for spindle work",
            "maxLength": 500,
            "type": [
              "string",
              "null"
            ]
          },
          "to": {
            "description": "The state to go to.",
            "enum": [
              "planned",
              "commissioning",
              "active",
              "standby",
              "decommissioned"
            ],
            "example": "standby",
            "type": "string",
            "x-hive-open": false
          }
        },
        "required": [
          "to"
        ],
        "type": "object"
      },
      "AssetList": {
        "additionalProperties": false,
        "description": "A page of assets.",
        "properties": {
          "data": {
            "description": "One page of assets.",
            "example": [],
            "items": {
              "$ref": "#/components/schemas/Asset"
            },
            "type": "array"
          },
          "has_more": {
            "description": "True when another page follows.",
            "example": false,
            "type": "boolean"
          },
          "next_cursor": {
            "description": "The cursor of the next page, or null on the last page.",
            "example": null,
            "type": [
              "string",
              "null"
            ]
          },
          "object": {
            "const": "list",
            "description": "The object type name (canon 4).",
            "example": "list",
            "type": "string"
          },
          "total_count": {
            "description": "The number of assets, exact up to 10,000; null unless the request sends count=true.",
            "example": null,
            "minimum": 0,
            "type": [
              "integer",
              "null"
            ]
          },
          "total_count_is_lower_bound": {
            "description": "True when total_count stopped at its cap of 10,000; null unless the request sends count=true.",
            "example": null,
            "type": [
              "boolean",
              "null"
            ]
          }
        },
        "required": [
          "object",
          "data",
          "has_more",
          "next_cursor",
          "total_count",
          "total_count_is_lower_bound"
        ],
        "type": "object",
        "x-hive-object-kind": "list"
      },
      "AssetMove": {
        "additionalProperties": false,
        "description": "The new place of an asset with its whole subtree.",
        "properties": {
          "new_parent_id": {
            "description": "The new parent asset, in the same tenant.",
            "example": "ast_01m71xxpcwfz1snpsm3pqdqrjc",
            "type": "string",
            "x-hive-prefix": "ast"
          },
          "sort_order": {
            "description": "The position among the new siblings; the current one is kept when absent.",
            "example": 0,
            "maximum": 2147483647,
            "minimum": -2147483648,
            "type": "integer"
          }
        },
        "required": [
          "new_parent_id"
        ],
        "type": "object"
      },
      "AssetOperationAccepted": {
        "additionalProperties": false,
        "description": "The operation that carries out a move or delete of more than 2,000 assets (API-LRO). The change is all or nothing from the reader's view.",
        "properties": {
          "created_at": {
            "description": "When the operation started.",
            "example": "2026-11-10T05:12:03Z",
            "format": "date-time",
            "type": "string"
          },
          "id": {
            "description": "The ID of the operation.",
            "example": "opn_01m71xxqhkf9avn6dq2sfgzgym",
            "type": "string",
            "x-hive-prefix": "opn"
          },
          "kind": {
            "description": "What the operation does.",
            "enum": [
              "asset_move"
            ],
            "example": "asset_move",
            "type": "string",
            "x-hive-open": true
          },
          "object": {
            "const": "operation",
            "description": "The object type name (canon 4).",
            "example": "operation",
            "type": "string"
          },
          "status": {
            "description": "The state of the operation.",
            "enum": [
              "running",
              "succeeded",
              "failed"
            ],
            "example": "running",
            "type": "string",
            "x-hive-open": true
          },
          "updated_at": {
            "description": "When the operation last changed.",
            "example": "2026-11-10T05:12:03Z",
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "object",
          "id",
          "kind",
          "status",
          "created_at",
          "updated_at"
        ],
        "type": "object"
      },
      "AssetTree": {
        "additionalProperties": false,
        "description": "A nested tree below an asset, at most 2,000 nodes.",
        "properties": {
          "depth": {
            "description": "The depth that was read below the root.",
            "example": 3,
            "maximum": 7,
            "minimum": 1,
            "type": "integer"
          },
          "node_count": {
            "description": "The number of nodes, the root included.",
            "example": 11,
            "minimum": 1,
            "type": "integer"
          },
          "object": {
            "const": "asset_tree",
            "description": "The object type name (canon 4).",
            "example": "asset_tree",
            "type": "string"
          },
          "root": {
            "$ref": "#/components/schemas/AssetTreeNode"
          }
        },
        "required": [
          "object",
          "depth",
          "node_count",
          "root"
        ],
        "type": "object",
        "x-hive-object-kind": "view"
      },
      "AssetTreeNode": {
        "additionalProperties": false,
        "description": "One node of a nested tree: the asset in short form and its children ordered by sort order and name.",
        "properties": {
          "children": {
            "description": "The children, empty at the depth limit or for a leaf.",
            "example": [],
            "items": {
              "additionalProperties": true,
              "description": "A node of the same shape as this one (the schema does not refer to itself: a recursive reference makes the contract comparison of API-GOV unbounded).",
              "type": "object",
              "x-hive-open": true
            },
            "type": "array"
          },
          "id": {
            "description": "The ID of the asset.",
            "example": "ast_01m71xxng7fzrvspnkgtw1t2kg",
            "type": "string",
            "x-hive-prefix": "ast"
          },
          "key": {
            "description": "The human key.",
            "example": "CNC-07",
            "type": [
              "string",
              "null"
            ]
          },
          "kind": {
            "description": "The kind of node.",
            "enum": [
              "site",
              "area",
              "line",
              "work_unit",
              "machine",
              "component"
            ],
            "example": "machine",
            "type": "string",
            "x-hive-open": false
          },
          "lifecycle_state": {
            "description": "The lifecycle state.",
            "enum": [
              "planned",
              "commissioning",
              "active",
              "standby",
              "decommissioned"
            ],
            "example": "active",
            "type": "string",
            "x-hive-open": false
          },
          "name": {
            "description": "The display name.",
            "example": "CNC-07 5-axis machining centre",
            "type": "string"
          },
          "object": {
            "const": "asset_tree_node",
            "description": "The object type name (canon 4).",
            "example": "asset_tree_node",
            "type": "string"
          },
          "sort_order": {
            "description": "The position among the siblings.",
            "example": 0,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "kind",
          "key",
          "name",
          "lifecycle_state",
          "sort_order",
          "children"
        ],
        "type": "object",
        "x-hive-object-kind": "view"
      },
      "AssetUpdate": {
        "additionalProperties": false,
        "description": "A change of an asset; send only what changes. kind, parent_id and the lifecycle cannot be changed here: use move and lifecycle.",
        "minProperties": 1,
        "properties": {
          "asset_type_id": {
            "description": "The asset type (GRAPH-TYPE), or null.",
            "example": "aty_01m71xxqhkf9avn6dq2sfgzgym",
            "type": [
              "string",
              "null"
            ],
            "x-hive-prefix": "aty"
          },
          "build_year": {
            "description": "The year the equipment was built.",
            "example": 2019,
            "maximum": 2200,
            "minimum": 1900,
            "type": [
              "integer",
              "null"
            ]
          },
          "commissioned_on": {
            "description": "The date the equipment was first put into service.",
            "example": "2019-09-02",
            "format": "date",
            "type": [
              "string",
              "null"
            ]
          },
          "description_i18n": {
            "additionalProperties": {
              "maxLength": 2000,
              "type": "string"
            },
            "description": "A description per language tag (BCP 47), for example de and en.",
            "example": {
              "de": "5-Achs-Bearbeitungszentrum",
              "en": "5-axis machining centre"
            },
            "type": [
              "object",
              "null"
            ],
            "x-hive-open": true
          },
          "key": {
            "description": "The human key (CNC-07), 1 to 64 characters from A-Z a-z 0-9 . _ / space and hyphen, unique in the tenant without regard to case among assets that are not deleted.",
            "example": "CNC-07",
            "maxLength": 64,
            "minLength": 1,
            "pattern": "^[A-Za-z0-9._/ -]+$",
            "type": [
              "string",
              "null"
            ]
          },
          "manufacturer": {
            "description": "The manufacturer.",
            "example": "Kessler Werkzeugmaschinen AG",
            "maxLength": 200,
            "type": [
              "string",
              "null"
            ]
          },
          "model": {
            "description": "The model.",
            "example": "KM 500",
            "maxLength": 200,
            "type": [
              "string",
              "null"
            ]
          },
          "name": {
            "description": "The display name.",
            "example": "CNC-07 5-axis machining centre",
            "maxLength": 200,
            "minLength": 1,
            "type": "string"
          },
          "properties": {
            "additionalProperties": true,
            "description": "Free properties of the asset, at most 16 KiB. When the asset has a type they validate against its property schema.",
            "example": {
              "rated_spindle_speed": {
                "unit": "1/min",
                "value": 12000
              }
            },
            "type": "object",
            "x-hive-open": true
          },
          "serial_number": {
            "description": "The serial number of the manufacturer.",
            "example": "KM500-190412",
            "maxLength": 200,
            "type": [
              "string",
              "null"
            ]
          },
          "site_profile": {
            "additionalProperties": false,
            "description": "Changes the site profile of a site; refused for every other kind. Changing the time zone emits asset.updated and consumers react.",
            "example": {
              "country": "DE",
              "time_zone": "Europe/Berlin"
            },
            "properties": {
              "address": {
                "additionalProperties": true,
                "description": "The postal address of the site as the customer enters it; free form.",
                "example": {
                  "city": "Esslingen am Neckar",
                  "postal_code": "73730",
                  "street": "Plochinger Strasse 12"
                },
                "type": [
                  "object",
                  "null"
                ],
                "x-hive-open": true
              },
              "country": {
                "description": "The ISO 3166-1 alpha-2 country code of the site.",
                "example": "DE",
                "pattern": "^[A-Z]{2}$",
                "type": "string"
              },
              "time_zone": {
                "description": "The IANA time zone of the site, for German sites Europe/Berlin. It is validated against the time zone database and never defaults to UTC.",
                "example": "Europe/Berlin",
                "maxLength": 64,
                "minLength": 1,
                "type": "string"
              }
            },
            "type": [
              "object",
              "null"
            ]
          },
          "sort_order": {
            "description": "The position among the siblings; ties break by name.",
            "example": 0,
            "maximum": 2147483647,
            "minimum": -2147483648,
            "type": "integer"
          },
          "variant": {
            "description": "The variant.",
            "example": null,
            "maxLength": 200,
            "type": [
              "string",
              "null"
            ]
          }
        },
        "type": "object"
      },
      "AsyncApiDocument": {
        "additionalProperties": true,
        "description": "A AsyncAPI 3 document, served as published. The members listed are the ones every document has; a document also carries components and extensions.",
        "properties": {
          "asyncapi": {
            "description": "The AsyncAPI 3 specification version of the document.",
            "example": "3.0.0",
            "type": "string"
          },
          "channels": {
            "description": "The channels of the public events, by name.",
            "example": {},
            "type": "object",
            "x-hive-open": true
          },
          "info": {
            "description": "Title, description and the dated API version of the document.",
            "example": {
              "title": "HIVE API",
              "version": "2026-11-01"
            },
            "type": "object",
            "x-hive-open": true
          }
        },
        "required": [
          "asyncapi",
          "info",
          "channels"
        ],
        "type": "object",
        "x-hive-object-kind": "view",
        "x-hive-open": true
      },
      "ClockStatus": {
        "additionalProperties": false,
        "description": "The clock status of a gateway or a connection (DATA-TIME-R-010). Its id is the gwy or cnx ID of the thing it describes, so it is a view of that object (tools/RECONCILE.md, DATA-TIME entry).",
        "properties": {
          "created_at": {
            "description": "When the status row was created.",
            "example": "2026-11-01T08:00:00Z",
            "format": "date-time",
            "type": "string"
          },
          "drift_ppm": {
            "description": "The drift the gateway reports, in parts per million; null when it reports none.",
            "example": null,
            "type": [
              "number",
              "null"
            ]
          },
          "gateway_id": {
            "description": "The gateway that the status is of, or that carries the connection.",
            "example": "gwy_01jc8z1abcdef0123456789xyz",
            "type": "string",
            "x-hive-prefix": "gwy"
          },
          "id": {
            "description": "The gateway or connection ID the status describes.",
            "example": "cnx_01jc8z3k5me9rt7q2v4x6b0dnh",
            "pattern": "^(gwy|cnx)_[0-9a-hjkmnp-tv-z]{26}$",
            "type": "string"
          },
          "measured_at": {
            "description": "When the offset was last measured.",
            "example": "2026-11-10T05:12:00Z",
            "format": "date-time",
            "type": "string"
          },
          "object": {
            "const": "clock_status",
            "description": "The object type name (canon 4).",
            "example": "clock_status",
            "type": "string"
          },
          "offset_ms": {
            "description": "A gateway: the gateway clock minus the cloud clock. A connection: the median of the gateway time minus the source time of its live samples. Rounded to a millisecond; null before the first measurement.",
            "example": -41200,
            "type": [
              "integer",
              "null"
            ]
          },
          "rtt_ms": {
            "description": "The round-trip time of the last gateway measurement, rounded to a millisecond; null for a connection.",
            "example": null,
            "type": [
              "integer",
              "null"
            ]
          },
          "sample_count": {
            "description": "The live samples in the 5-minute window (connections); 0 for a gateway.",
            "example": 300,
            "minimum": 0,
            "type": "integer"
          },
          "source_kind": {
            "description": "What the status describes: a gateway or a connection.",
            "enum": [
              "gateway",
              "connection"
            ],
            "example": "connection",
            "type": "string",
            "x-hive-filterable": [
              "eq",
              "in"
            ],
            "x-hive-index": "clock_status_kind_idx",
            "x-hive-open": false
          },
          "state": {
            "description": "ok, warn, skewed, unsynchronised or unknown (DATA-TIME-R-010). Unknown is doubt, never ok.",
            "enum": [
              "ok",
              "warn",
              "skewed",
              "unsynchronised",
              "unknown"
            ],
            "example": "skewed",
            "type": "string",
            "x-hive-filterable": [
              "eq",
              "in"
            ],
            "x-hive-index": "clock_status_state_idx",
            "x-hive-open": false,
            "x-hive-state-machine": true
          },
          "state_since": {
            "description": "When the status entered its present state.",
            "example": "2026-11-10T04:55:00Z",
            "format": "date-time",
            "type": "string",
            "x-hive-index": "clock_status_since_idx",
            "x-hive-sortable": true
          },
          "step": {
            "description": "The last clock step in milliseconds, positive when the offset grew (DATA-TIME-R-013); null when none was seen.",
            "example": null,
            "type": [
              "integer",
              "null"
            ]
          },
          "step_at": {
            "description": "When the last step was detected.",
            "example": null,
            "format": "date-time",
            "type": [
              "string",
              "null"
            ]
          },
          "stratum": {
            "description": "The stratum the gateway reports; null when it reports none.",
            "example": null,
            "maximum": 16,
            "minimum": 0,
            "type": [
              "integer",
              "null"
            ]
          },
          "sync_source": {
            "description": "How the gateway clock is kept: chrony:ntp, chrony:ptp or none; null for a connection.",
            "example": null,
            "type": [
              "string",
              "null"
            ]
          },
          "updated_at": {
            "description": "When the status last changed.",
            "example": "2026-11-10T05:12:00Z",
            "format": "date-time",
            "type": "string"
          },
          "version": {
            "description": "The version of the status; it increases on every change and is the ETag.",
            "example": 14,
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "source_kind",
          "gateway_id",
          "state",
          "state_since",
          "offset_ms",
          "rtt_ms",
          "drift_ppm",
          "sync_source",
          "stratum",
          "sample_count",
          "step",
          "step_at",
          "measured_at",
          "created_at",
          "updated_at",
          "version"
        ],
        "type": "object",
        "x-hive-object-kind": "view"
      },
      "ClockStatusList": {
        "additionalProperties": false,
        "description": "A page of clock statuses.",
        "properties": {
          "data": {
            "description": "Clock statuses.",
            "example": [],
            "items": {
              "$ref": "#/components/schemas/ClockStatus"
            },
            "type": "array"
          },
          "has_more": {
            "description": "True when another page follows.",
            "example": false,
            "type": "boolean"
          },
          "next_cursor": {
            "description": "The cursor of the next page, or null on the last page.",
            "example": null,
            "type": [
              "string",
              "null"
            ]
          },
          "object": {
            "const": "list",
            "description": "The object type name (canon 4).",
            "example": "list",
            "type": "string"
          },
          "total_count": {
            "description": "The number of items, exact up to 10,000; null unless the request sends count=true.",
            "example": null,
            "minimum": 0,
            "type": [
              "integer",
              "null"
            ]
          },
          "total_count_is_lower_bound": {
            "description": "True when total_count stopped at its cap of 10,000; null unless the request sends count=true.",
            "example": null,
            "type": [
              "boolean",
              "null"
            ]
          }
        },
        "required": [
          "object",
          "data",
          "has_more",
          "next_cursor",
          "total_count",
          "total_count_is_lower_bound"
        ],
        "type": "object",
        "x-hive-object-kind": "list"
      },
      "FailedPrecondition": {
        "additionalProperties": false,
        "description": "One failed business rule inside a 422 precondition_failed (API-ERR-R-011). Generated from schemas/errors/errors.yaml (layers 2b and 2c under precondition_failed).",
        "properties": {
          "code": {
            "enum": [
              "approval_expired",
              "approval_missing",
              "asset_decommissioned",
              "command_expired",
              "gateway_offline",
              "has_dependents",
              "kill_switch_active",
              "remote_enable_off",
              "state_not_allowed",
              "step_limit_exceeded",
              "value_outside_envelope",
              "aas_package_rejected",
              "aas_unsupported_version",
              "aas_validation_failed",
              "account_mapping_missing",
              "acknowledgement_required",
              "acl_unknown",
              "agent_disabled",
              "agent_trifecta_violation",
              "aggregate_not_supported",
              "alarm_not_shelvable",
              "alarm_shelved",
              "already_in_incident",
              "approval_needs_second_person",
              "approval_rejected",
              "archive_limit_exceeded",
              "as_of_out_of_range",
              "assessment_missing",
              "assessment_review_missing",
              "asset_not_deletable",
              "asset_required_for_answer",
              "attachment_limit",
              "automation_not_allowed",
              "binding_incomplete",
              "binding_invalid_range",
              "binding_missing",
              "binding_required",
              "binding_unknown_type",
              "bundle_not_allowed",
              "cad_preview_unavailable",
              "capability_missing",
              "case_wrong_state",
              "channel_not_enabled",
              "classification_lowering_requires_reason",
              "clock_not_ok",
              "command_rate_exceeded",
              "commissioning_missing",
              "component_unresolved",
              "confirm_requires_human",
              "connector_never_writable",
              "connector_planned",
              "control_gate_missing",
              "credential_kind_not_allowed",
              "credential_missing",
              "credential_revoked",
              "credential_undecryptable",
              "cross_cell_unsupported",
              "current_value_unavailable",
              "cycle_detected",
              "dataset_locked",
              "definition_incomplete",
              "definition_invalid",
              "definition_not_approved",
              "definition_not_released",
              "definition_not_startable",
              "definition_suspended",
              "definition_unknown",
              "depth_exceeded",
              "destination_blocked",
              "destination_not_verified",
              "dexpi_invalid",
              "document_quarantined",
              "draft_stale",
              "edc_version_unsupported",
              "encrypted_file",
              "environment_not_supported",
              "eval_gate_missing",
              "expression_invalid",
              "extension_already_used",
              "factor_overlap",
              "factor_source_missing",
              "field_owned_by_external",
              "file_content_mismatch",
              "file_too_large",
              "file_type_not_allowed",
              "fill_not_supported",
              "format_not_supported",
              "gates_not_passed",
              "gateway_outdated",
              "gateway_required",
              "guardrail_blocked",
              "gxp_prerequisite_missing",
              "history_unavailable",
              "host_not_allowed",
              "identity_kind_unsupported",
              "identity_not_verified",
              "import_file_rejected",
              "import_has_errors",
              "input_invalid",
              "input_not_allowed",
              "insufficient_variation",
              "invalid_lifecycle_transition",
              "invalid_parent_kind",
              "invitation_expired",
              "invoice_invalid",
              "ip_allow_self_lockout",
              "key_unavailable",
              "kind_not_allowed",
              "language_not_supported",
              "language_pair_not_supported",
              "legal_hold_active",
              "link_not_readable",
              "macro_content_refused",
              "malware_detected",
              "mapping_address_invalid",
              "mapping_not_active",
              "mapping_type_mismatch",
              "max_depth_exceeded",
              "merge_conflict",
              "merge_not_allowed",
              "move_cycle",
              "mtp_unsupported_version",
              "no_asset_context",
              "not_in_catalog",
              "note_rejected",
              "operation_in_progress",
              "operation_not_enabled",
              "operation_unverified",
              "outcome_required",
              "outside_share_terms",
              "outside_support",
              "partner_not_active",
              "pattern_unsafe",
              "plant_not_ready",
              "policy_invalid",
              "precondition_not_met",
              "precondition_unverifiable",
              "presence_missing",
              "prohibited_target",
              "protected_token_lost",
              "purpose_not_shareable",
              "range_too_large",
              "reason_required",
              "recipient_not_allowed",
              "recommendation_invalid",
              "region_not_allowed",
              "relationship_degree_limit",
              "relationship_endpoint_invalid",
              "relationship_prohibited",
              "relationship_type_not_writable",
              "relay_not_approved",
              "release_not_approved",
              "remote_enable_unreadable",
              "reopen_window_passed",
              "residency_violation",
              "restore_in_progress",
              "restore_quarantine",
              "retention_out_of_bounds",
              "retrofit_signoff_missing",
              "revision_not_processed",
              "run_not_resumable",
              "scenario_not_allowed",
              "scope_not_restorable",
              "sequence_invalid",
              "share_not_active",
              "share_revoked",
              "shelve_duration_exceeded",
              "signal_person_not_allowed",
              "signal_type_mismatch",
              "signing_unavailable",
              "snapshot_required",
              "source_not_allowed",
              "source_not_tested",
              "state_changed",
              "statement_not_read_only",
              "statutory_retention",
              "step_not_allowed",
              "store_not_covered",
              "stream_blocked",
              "target_not_active",
              "template_invalid",
              "template_subject_mismatch",
              "tenant_not_ready_for_deletion",
              "terms_mismatch",
              "timestamp_out_of_range",
              "too_many_eligible_revisions",
              "too_many_links",
              "transition_not_allowed",
              "type_deprecated",
              "type_inheritance_invalid",
              "type_not_published",
              "type_validation_failed",
              "unconfirmed_value",
              "unit_incompatible",
              "unsupported_file_type",
              "url_not_allowed",
              "variable_not_allowed",
              "work_in_progress",
              "works_agreement_required",
              "worm_not_available",
              "write_budget_exhausted"
            ],
            "type": "string",
            "x-hive-open": true
          },
          "detail": {
            "type": "string"
          },
          "meta": {
            "type": "object",
            "x-hive-open": true
          }
        },
        "required": [
          "code",
          "detail"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "FieldError": {
        "additionalProperties": false,
        "description": "One violation inside a 400 invalid_request, or an item of the errors member of a 409 conflict (API-ERR-R-009). Generated from schemas/errors/errors.yaml (layer 2a). pointer is an RFC 6901 JSON pointer into the body; parameter names a query parameter or header.",
        "properties": {
          "code": {
            "enum": [
              "above_maximum",
              "below_minimum",
              "duplicate_item",
              "human_only_permission",
              "invalid_enum",
              "invalid_expand",
              "invalid_field_selection",
              "invalid_filter_field",
              "invalid_filter_operator",
              "invalid_format",
              "invalid_header",
              "invalid_limit",
              "invalid_reference",
              "invalid_sort_field",
              "invalid_timestamp",
              "invalid_type",
              "invalid_unit",
              "malformed_json",
              "mutually_exclusive",
              "not_cancellable",
              "pattern_mismatch",
              "preview_header_required",
              "purpose_required",
              "quantity_not_finite",
              "read_only_field",
              "required",
              "requires_field",
              "scope_invalid",
              "timestamp_requires_offset",
              "too_few_items",
              "too_long",
              "too_many_items",
              "too_short",
              "unit_alias_not_allowed",
              "unit_not_in_kind",
              "unit_unknown",
              "unknown_field",
              "unknown_permission",
              "unknown_section"
            ],
            "type": "string",
            "x-hive-open": true
          },
          "detail": {
            "type": "string"
          },
          "meta": {
            "type": "object",
            "x-hive-open": true
          },
          "parameter": {
            "type": "string"
          },
          "pointer": {
            "type": "string"
          }
        },
        "required": [
          "code",
          "detail"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "FormattedQuantity": {
        "additionalProperties": false,
        "description": "A quantity as text. The number and the unit are joined by U+00A0, so the two never wrap onto separate lines.",
        "properties": {
          "locale": {
            "description": "The locale used, de or en. It differs from the requested tag when that had to fall back.",
            "enum": [
              "de",
              "en"
            ],
            "example": "de",
            "type": "string",
            "x-hive-open": false
          },
          "object": {
            "const": "formatted_quantity",
            "description": "The object type name (canon 4).",
            "example": "formatted_quantity",
            "type": "string"
          },
          "text": {
            "description": "The number and the unit label, for example 7,8 mm/s in German (with U+00A0 between).",
            "example": "7,8 mm/s",
            "type": "string"
          },
          "unit_label": {
            "description": "The unit label alone; empty for a count without a noun.",
            "example": "mm/s",
            "type": "string"
          },
          "value_text": {
            "description": "The number alone.",
            "example": "7,8",
            "type": "string"
          }
        },
        "required": [
          "object",
          "text",
          "locale",
          "value_text",
          "unit_label"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "Health": {
        "additionalProperties": false,
        "properties": {
          "object": {
            "const": "health",
            "description": "The object type name (canon 4).",
            "type": "string"
          },
          "status": {
            "description": "ok when the process serves requests, unavailable when it does not.",
            "enum": [
              "ok",
              "unavailable"
            ],
            "example": "ok",
            "type": "string",
            "x-hive-open": true
          }
        },
        "required": [
          "object",
          "status"
        ],
        "type": "object",
        "x-hive-object-kind": "singleton"
      },
      "MeTenant": {
        "additionalProperties": false,
        "description": "One tenant the caller may select with Hive-Tenant.",
        "properties": {
          "display_name": {
            "description": "The name of the tenant.",
            "example": "Musterwerk Esslingen",
            "maxLength": 200,
            "type": "string"
          },
          "id": {
            "description": "The tenant ID.",
            "example": "ten_01jc8z3k5me9rt7q2v4x6b0dnh",
            "type": "string",
            "x-hive-prefix": "ten"
          },
          "object": {
            "const": "me_tenant",
            "description": "The object type name (canon 4).",
            "example": "me_tenant",
            "type": "string"
          },
          "status": {
            "description": "The status of the caller's membership of this tenant; only active memberships are listed.",
            "enum": [
              "active"
            ],
            "example": "active",
            "type": "string",
            "x-hive-open": true
          }
        },
        "required": [
          "object",
          "id",
          "display_name",
          "status"
        ],
        "type": "object",
        "x-hive-object-kind": "view"
      },
      "MeTenantList": {
        "additionalProperties": false,
        "description": "The tenants of the caller. It is small and closed, so it is never paged (RECONCILE 188).",
        "properties": {
          "data": {
            "description": "The caller's tenants, ordered by display name.",
            "example": [
              {
                "display_name": "Musterwerk Esslingen",
                "id": "ten_01jc8z3k5me9rt7q2v4x6b0dnh",
                "object": "me_tenant",
                "status": "active"
              }
            ],
            "items": {
              "$ref": "#/components/schemas/MeTenant"
            },
            "type": "array"
          },
          "has_more": {
            "const": false,
            "description": "Always false: a person belongs to few tenants, so the list is never paged.",
            "example": false,
            "type": "boolean"
          },
          "next_cursor": {
            "description": "Always null: the list is never paged.",
            "example": null,
            "type": "null"
          },
          "object": {
            "const": "list",
            "description": "The object type name (canon 4).",
            "example": "list",
            "type": "string"
          }
        },
        "required": [
          "object",
          "data",
          "has_more",
          "next_cursor"
        ],
        "type": "object",
        "x-hive-object-kind": "view"
      },
      "Membership": {
        "additionalProperties": false,
        "description": "The fact that a user belongs to the tenant. It exists only in this tenant: the same user may have a different status in another tenant.",
        "properties": {
          "created_at": {
            "description": "When the membership was created.",
            "example": "2026-09-01T08:00:00Z",
            "format": "date-time",
            "type": "string",
            "x-hive-index": "membership_created_idx",
            "x-hive-sortable": true
          },
          "object": {
            "const": "membership",
            "description": "The object type name (canon 4).",
            "example": "membership",
            "type": "string"
          },
          "source": {
            "description": "Where the membership came from: sso, scim, invite or local.",
            "enum": [
              "sso",
              "scim",
              "invite",
              "local"
            ],
            "example": "sso",
            "type": "string",
            "x-hive-open": true
          },
          "status": {
            "description": "The state of the membership: invited, active, suspended or removed.",
            "enum": [
              "invited",
              "active",
              "suspended",
              "removed"
            ],
            "example": "active",
            "type": "string",
            "x-hive-filterable": [
              "eq",
              "in"
            ],
            "x-hive-index": "membership_status_idx",
            "x-hive-open": false,
            "x-hive-state-machine": true
          },
          "updated_at": {
            "description": "When the membership last changed.",
            "example": "2026-11-01T09:30:00Z",
            "format": "date-time",
            "type": "string"
          },
          "user_id": {
            "description": "The user (IAM-SSO).",
            "example": "usr_01m71xxng7fzrvspnkgtw1t2kg",
            "type": "string",
            "x-hive-prefix": "usr"
          },
          "version": {
            "description": "The version of the membership; send it in If-Match to update.",
            "example": 2,
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "object",
          "user_id",
          "status",
          "source",
          "created_at",
          "updated_at",
          "version"
        ],
        "type": "object",
        "x-hive-data-class": "personal",
        "x-hive-object-kind": "view"
      },
      "MembershipList": {
        "additionalProperties": false,
        "description": "A page of memberships of the current tenant.",
        "properties": {
          "data": {
            "description": "One page of memberships.",
            "example": [],
            "items": {
              "$ref": "#/components/schemas/Membership"
            },
            "type": "array"
          },
          "has_more": {
            "description": "True when another page follows.",
            "example": false,
            "type": "boolean"
          },
          "next_cursor": {
            "description": "The cursor of the next page, or null on the last page.",
            "example": null,
            "type": [
              "string",
              "null"
            ]
          },
          "object": {
            "const": "list",
            "description": "The object type name (canon 4).",
            "example": "list",
            "type": "string"
          },
          "total_count": {
            "description": "The number of memberships, exact up to 10,000; null unless the request sends count=true.",
            "example": null,
            "minimum": 0,
            "type": [
              "integer",
              "null"
            ]
          },
          "total_count_is_lower_bound": {
            "description": "True when total_count stopped at its cap of 10,000; null unless the request sends count=true.",
            "example": null,
            "type": [
              "boolean",
              "null"
            ]
          }
        },
        "required": [
          "object",
          "data",
          "has_more",
          "next_cursor",
          "total_count",
          "total_count_is_lower_bound"
        ],
        "type": "object",
        "x-hive-object-kind": "list"
      },
      "MembershipUpdate": {
        "additionalProperties": false,
        "properties": {
          "status": {
            "description": "The new status. A member can be suspended or made active again; removal of a user goes through user management (IAM-SSO).",
            "enum": [
              "active",
              "suspended"
            ],
            "example": "suspended",
            "type": "string",
            "x-hive-open": false
          }
        },
        "required": [
          "status"
        ],
        "type": "object"
      },
      "OpenApiDocument": {
        "additionalProperties": true,
        "description": "A OpenAPI 3.1 document, served as published. The members listed are the ones every document has; a document also carries components and extensions.",
        "properties": {
          "info": {
            "description": "Title, description and the dated API version of the document.",
            "example": {
              "title": "HIVE API",
              "version": "2026-11-01"
            },
            "type": "object",
            "x-hive-open": true
          },
          "openapi": {
            "description": "The OpenAPI 3.1 specification version of the document.",
            "example": "3.1.0",
            "type": "string"
          },
          "paths": {
            "description": "The operations of the public API, by path.",
            "example": {},
            "type": "object",
            "x-hive-open": true
          }
        },
        "required": [
          "openapi",
          "info",
          "paths"
        ],
        "type": "object",
        "x-hive-object-kind": "view",
        "x-hive-open": true
      },
      "Problem": {
        "description": "RFC 9457 problem details with the HIVE members (API-ERR). One branch per registered top-level code, discriminated on code; generated from schemas/errors/errors.yaml. Clients fall back to the HTTP status class for a code they do not know (API-ERR-R-020).",
        "discriminator": {
          "propertyName": "code"
        },
        "oneOf": [
          {
            "$ref": "#/components/schemas/ProblemIdempotencyKeyRequired"
          },
          {
            "$ref": "#/components/schemas/ProblemInvalidCursor"
          },
          {
            "$ref": "#/components/schemas/ProblemInvalidRequest"
          },
          {
            "$ref": "#/components/schemas/ProblemTenantRequired"
          },
          {
            "$ref": "#/components/schemas/ProblemUnsupportedVersion"
          },
          {
            "$ref": "#/components/schemas/ProblemStepUpRequired"
          },
          {
            "$ref": "#/components/schemas/ProblemTokenExpired"
          },
          {
            "$ref": "#/components/schemas/ProblemUnauthenticated"
          },
          {
            "$ref": "#/components/schemas/ProblemEntitlementRequired"
          },
          {
            "$ref": "#/components/schemas/ProblemFeatureDisabled"
          },
          {
            "$ref": "#/components/schemas/ProblemFeatureNotEntitled"
          },
          {
            "$ref": "#/components/schemas/ProblemIpNotAllowed"
          },
          {
            "$ref": "#/components/schemas/ProblemMfaEnrollmentRequired"
          },
          {
            "$ref": "#/components/schemas/ProblemPermissionDenied"
          },
          {
            "$ref": "#/components/schemas/ProblemPrincipalNotAllowed"
          },
          {
            "$ref": "#/components/schemas/ProblemPurposeNotAllowed"
          },
          {
            "$ref": "#/components/schemas/ProblemSsoRequired"
          },
          {
            "$ref": "#/components/schemas/ProblemTenantSuspended"
          },
          {
            "$ref": "#/components/schemas/ProblemNotFound"
          },
          {
            "$ref": "#/components/schemas/ProblemMethodNotAllowed"
          },
          {
            "$ref": "#/components/schemas/ProblemNotAcceptable"
          },
          {
            "$ref": "#/components/schemas/ProblemAlreadyExists"
          },
          {
            "$ref": "#/components/schemas/ProblemConflict"
          },
          {
            "$ref": "#/components/schemas/ProblemIdempotencyKeyReused"
          },
          {
            "$ref": "#/components/schemas/ProblemRequestInProgress"
          },
          {
            "$ref": "#/components/schemas/ProblemVersionMismatch"
          },
          {
            "$ref": "#/components/schemas/ProblemPayloadTooLarge"
          },
          {
            "$ref": "#/components/schemas/ProblemUnsupportedMediaType"
          },
          {
            "$ref": "#/components/schemas/ProblemLimitExceeded"
          },
          {
            "$ref": "#/components/schemas/ProblemPreconditionFailed"
          },
          {
            "$ref": "#/components/schemas/ProblemPreconditionRequired"
          },
          {
            "$ref": "#/components/schemas/ProblemQuotaExceeded"
          },
          {
            "$ref": "#/components/schemas/ProblemRateLimited"
          },
          {
            "$ref": "#/components/schemas/ProblemInternal"
          },
          {
            "$ref": "#/components/schemas/ProblemNotImplemented"
          },
          {
            "$ref": "#/components/schemas/ProblemUpstreamError"
          },
          {
            "$ref": "#/components/schemas/ProblemUnavailable"
          },
          {
            "$ref": "#/components/schemas/ProblemTimeout"
          }
        ],
        "x-hive-object-kind": "transient"
      },
      "ProblemAlreadyExists": {
        "additionalProperties": false,
        "description": "Problem for code already_exists (HTTP 409, owner API-ERR).",
        "properties": {
          "code": {
            "const": "already_exists",
            "type": "string"
          },
          "conflicting_field": {
            "type": [
              "string",
              "null"
            ]
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 409,
            "type": "integer"
          },
          "title": {
            "const": "Resource already exists",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/already_exists",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable",
          "conflicting_field"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemConflict": {
        "additionalProperties": false,
        "description": "Problem for code conflict (HTTP 409, owner API-ERR).",
        "properties": {
          "code": {
            "const": "conflict",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "detail_code": {
            "enum": [
              "already_decided",
              "asset_has_children",
              "asset_key_conflict",
              "base_version_changed",
              "external_ref_conflict",
              "grants_exist",
              "import_commit_in_progress",
              "mapping_address_conflict",
              "merge_not_revertable",
              "reidentification_pending",
              "relationship_cardinality",
              "run_active",
              "signal_key_conflict",
              "signal_unit_immutable",
              "sync_in_progress",
              "type_in_use"
            ],
            "type": "string",
            "x-hive-open": true
          },
          "errors": {
            "items": {
              "$ref": "#/components/schemas/FieldError"
            },
            "type": "array"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 409,
            "type": "integer"
          },
          "title": {
            "const": "State conflict",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/conflict",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemEntitlementRequired": {
        "additionalProperties": false,
        "description": "Problem for code entitlement_required (HTTP 403, owner TEN-ENT). Deprecated: superseded, never emitted.",
        "properties": {
          "code": {
            "const": "entitlement_required",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "entitlement": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 403,
            "type": "integer"
          },
          "title": {
            "const": "Not included in the current plan",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/entitlement_required",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable",
          "entitlement"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemFeatureDisabled": {
        "additionalProperties": false,
        "description": "Problem for code feature_disabled (HTTP 403, owner GRAPH-PEOPLE).",
        "properties": {
          "code": {
            "const": "feature_disabled",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 403,
            "type": "integer"
          },
          "title": {
            "const": "Feature is switched off",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/feature_disabled",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemFeatureNotEntitled": {
        "additionalProperties": false,
        "description": "Problem for code feature_not_entitled (HTTP 403, owner TEN-ENT).",
        "properties": {
          "code": {
            "const": "feature_not_entitled",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 403,
            "type": "integer"
          },
          "title": {
            "const": "Not included in your contract",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/feature_not_entitled",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemIdempotencyKeyRequired": {
        "additionalProperties": false,
        "description": "Problem for code idempotency_key_required (HTTP 400, owner API-IDEM).",
        "properties": {
          "code": {
            "const": "idempotency_key_required",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 400,
            "type": "integer"
          },
          "title": {
            "const": "Idempotency-Key header required",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/idempotency_key_required",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemIdempotencyKeyReused": {
        "additionalProperties": false,
        "description": "Problem for code idempotency_key_reused (HTTP 409, owner API-IDEM).",
        "properties": {
          "code": {
            "const": "idempotency_key_reused",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 409,
            "type": "integer"
          },
          "title": {
            "const": "Idempotency key reused with a different request",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/idempotency_key_reused",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemInternal": {
        "additionalProperties": false,
        "description": "Problem for code internal (HTTP 500, owner API-ERR).",
        "properties": {
          "code": {
            "const": "internal",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 500,
            "type": "integer"
          },
          "title": {
            "const": "Internal error",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/internal",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemInvalidCursor": {
        "additionalProperties": false,
        "description": "Problem for code invalid_cursor (HTTP 400, owner API-PAGE).",
        "properties": {
          "code": {
            "const": "invalid_cursor",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 400,
            "type": "integer"
          },
          "title": {
            "const": "Cursor is invalid or expired",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/invalid_cursor",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemInvalidRequest": {
        "additionalProperties": false,
        "description": "Problem for code invalid_request (HTTP 400, owner API-ERR).",
        "properties": {
          "code": {
            "const": "invalid_request",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "errors": {
            "items": {
              "$ref": "#/components/schemas/FieldError"
            },
            "type": "array"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 400,
            "type": "integer"
          },
          "title": {
            "const": "Request validation failed",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/invalid_request",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable",
          "errors"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemIpNotAllowed": {
        "additionalProperties": false,
        "description": "Problem for code ip_not_allowed (HTTP 403, owner SEC-CUST).",
        "properties": {
          "code": {
            "const": "ip_not_allowed",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 403,
            "type": "integer"
          },
          "title": {
            "const": "Source address not allowed",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/ip_not_allowed",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemLimitExceeded": {
        "additionalProperties": false,
        "description": "Problem for code limit_exceeded (HTTP 422, owner TEN-ENT).",
        "properties": {
          "code": {
            "const": "limit_exceeded",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 422,
            "type": "integer"
          },
          "title": {
            "const": "Limit exceeded",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/limit_exceeded",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemMethodNotAllowed": {
        "additionalProperties": false,
        "description": "Problem for code method_not_allowed (HTTP 405, owner API-STD).",
        "properties": {
          "code": {
            "const": "method_not_allowed",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 405,
            "type": "integer"
          },
          "title": {
            "const": "Method not allowed",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/method_not_allowed",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemMfaEnrollmentRequired": {
        "additionalProperties": false,
        "description": "Problem for code mfa_enrollment_required (HTTP 403, owner IAM-SESS).",
        "properties": {
          "code": {
            "const": "mfa_enrollment_required",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 403,
            "type": "integer"
          },
          "title": {
            "const": "Multi-factor enrolment required",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/mfa_enrollment_required",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemNotAcceptable": {
        "additionalProperties": false,
        "description": "Problem for code not_acceptable (HTTP 406, owner API-STD).",
        "properties": {
          "code": {
            "const": "not_acceptable",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 406,
            "type": "integer"
          },
          "title": {
            "const": "Not acceptable",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/not_acceptable",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemNotFound": {
        "additionalProperties": false,
        "description": "Problem for code not_found (HTTP 404, owner API-STD).",
        "properties": {
          "code": {
            "const": "not_found",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 404,
            "type": "integer"
          },
          "title": {
            "const": "Resource not found",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/not_found",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemNotImplemented": {
        "additionalProperties": false,
        "description": "Problem for code not_implemented (HTTP 501, owner API-ERR).",
        "properties": {
          "code": {
            "const": "not_implemented",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 501,
            "type": "integer"
          },
          "title": {
            "const": "Not implemented in this deployment",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/not_implemented",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemPayloadTooLarge": {
        "additionalProperties": false,
        "description": "Problem for code payload_too_large (HTTP 413, owner API-STD).",
        "properties": {
          "code": {
            "const": "payload_too_large",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "max_bytes": {
            "minimum": 0,
            "type": "integer"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 413,
            "type": "integer"
          },
          "title": {
            "const": "Payload too large",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/payload_too_large",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable",
          "max_bytes"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemPermissionDenied": {
        "additionalProperties": false,
        "description": "Problem for code permission_denied (HTTP 403, owner API-AUTH).",
        "properties": {
          "code": {
            "const": "permission_denied",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "detail_code": {
            "enum": [
              "engaged_by_other_party",
              "four_eyes_required",
              "separation_of_duties"
            ],
            "type": "string",
            "x-hive-open": true
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "required_permission": {
            "type": "string"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 403,
            "type": "integer"
          },
          "title": {
            "const": "Permission denied",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/permission_denied",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemPreconditionFailed": {
        "additionalProperties": false,
        "description": "Problem for code precondition_failed (HTTP 422, owner any).",
        "properties": {
          "code": {
            "const": "precondition_failed",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "failed_preconditions": {
            "items": {
              "$ref": "#/components/schemas/FailedPrecondition"
            },
            "type": "array"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 422,
            "type": "integer"
          },
          "title": {
            "const": "A business rule blocks this request",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/precondition_failed",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable",
          "failed_preconditions"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemPreconditionRequired": {
        "additionalProperties": false,
        "description": "Problem for code precondition_required (HTTP 428, owner API-IDEM).",
        "properties": {
          "code": {
            "const": "precondition_required",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 428,
            "type": "integer"
          },
          "title": {
            "const": "If-Match header required",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/precondition_required",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemPrincipalNotAllowed": {
        "additionalProperties": false,
        "description": "Problem for code principal_not_allowed (HTTP 403, owner API-AUTH).",
        "properties": {
          "code": {
            "const": "principal_not_allowed",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "principal_kind": {
            "enum": [
              "user",
              "service_account",
              "gateway",
              "agent",
              "support",
              "system"
            ],
            "type": "string",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 403,
            "type": "integer"
          },
          "title": {
            "const": "This kind of principal may not do this",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/principal_not_allowed",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable",
          "principal_kind"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemPurposeNotAllowed": {
        "additionalProperties": false,
        "description": "Problem for code purpose_not_allowed (HTTP 403, owner SEC-PRIV).",
        "properties": {
          "code": {
            "const": "purpose_not_allowed",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 403,
            "type": "integer"
          },
          "title": {
            "const": "Purpose not allowed for this operation",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/purpose_not_allowed",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemQuotaExceeded": {
        "additionalProperties": false,
        "description": "Problem for code quota_exceeded (HTTP 429, owner API-RATE).",
        "properties": {
          "code": {
            "const": "quota_exceeded",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "quota": {
            "type": "string"
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "resets_at": {
            "format": "date-time",
            "type": "string"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 429,
            "type": "integer"
          },
          "title": {
            "const": "Quota exhausted",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/quota_exceeded",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable",
          "quota",
          "resets_at"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemRateLimited": {
        "additionalProperties": false,
        "description": "Problem for code rate_limited (HTTP 429, owner API-RATE).",
        "properties": {
          "code": {
            "const": "rate_limited",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "limit_scope": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 429,
            "type": "integer"
          },
          "title": {
            "const": "Too many requests",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/rate_limited",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable",
          "limit_scope",
          "retry_after_ms"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemRequestInProgress": {
        "additionalProperties": false,
        "description": "Problem for code request_in_progress (HTTP 409, owner API-IDEM).",
        "properties": {
          "code": {
            "const": "request_in_progress",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 409,
            "type": "integer"
          },
          "title": {
            "const": "Original request still running",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/request_in_progress",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemSsoRequired": {
        "additionalProperties": false,
        "description": "Problem for code sso_required (HTTP 403, owner IAM-SSO).",
        "properties": {
          "code": {
            "const": "sso_required",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 403,
            "type": "integer"
          },
          "title": {
            "const": "Single sign-on required",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/sso_required",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemStepUpRequired": {
        "additionalProperties": false,
        "description": "Problem for code step_up_required (HTTP 401, owner API-AUTH).",
        "properties": {
          "acr_values": {
            "type": "string"
          },
          "code": {
            "const": "step_up_required",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 401,
            "type": "integer"
          },
          "title": {
            "const": "Stronger authentication required",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/step_up_required",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable",
          "acr_values"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemTenantRequired": {
        "additionalProperties": false,
        "description": "Problem for code tenant_required (HTTP 400, owner API-AUTH).",
        "properties": {
          "code": {
            "const": "tenant_required",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 400,
            "type": "integer"
          },
          "title": {
            "const": "Tenant must be selected",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/tenant_required",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemTenantSuspended": {
        "additionalProperties": false,
        "description": "Problem for code tenant_suspended (HTTP 403, owner TEN-LIFE).",
        "properties": {
          "code": {
            "const": "tenant_suspended",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 403,
            "type": "integer"
          },
          "title": {
            "const": "Tenant is suspended",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/tenant_suspended",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemTimeout": {
        "additionalProperties": false,
        "description": "Problem for code timeout (HTTP 504, owner API-ERR).",
        "properties": {
          "code": {
            "const": "timeout",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 504,
            "type": "integer"
          },
          "title": {
            "const": "Request timed out",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/timeout",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemTokenExpired": {
        "additionalProperties": false,
        "description": "Problem for code token_expired (HTTP 401, owner API-AUTH).",
        "properties": {
          "code": {
            "const": "token_expired",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 401,
            "type": "integer"
          },
          "title": {
            "const": "Access token expired",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/token_expired",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemUnauthenticated": {
        "additionalProperties": false,
        "description": "Problem for code unauthenticated (HTTP 401, owner API-AUTH).",
        "properties": {
          "code": {
            "const": "unauthenticated",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 401,
            "type": "integer"
          },
          "title": {
            "const": "Authentication required",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/unauthenticated",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemUnavailable": {
        "additionalProperties": false,
        "description": "Problem for code unavailable (HTTP 503, owner API-ERR).",
        "properties": {
          "capability": {
            "type": "string"
          },
          "code": {
            "const": "unavailable",
            "type": "string"
          },
          "dependency": {
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "detail_code": {
            "enum": [
              "degraded_capability",
              "dependency_unavailable",
              "model_unavailable",
              "restore_in_progress",
              "search_unavailable",
              "shed",
              "tenant_key_unavailable"
            ],
            "type": "string",
            "x-hive-open": true
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 503,
            "type": "integer"
          },
          "title": {
            "const": "Temporarily unavailable",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/unavailable",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable",
          "retry_after_ms"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemUnsupportedMediaType": {
        "additionalProperties": false,
        "description": "Problem for code unsupported_media_type (HTTP 415, owner API-STD).",
        "properties": {
          "code": {
            "const": "unsupported_media_type",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 415,
            "type": "integer"
          },
          "title": {
            "const": "Unsupported media type",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/unsupported_media_type",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemUnsupportedVersion": {
        "additionalProperties": false,
        "description": "Problem for code unsupported_version (HTTP 400, owner API-VER).",
        "properties": {
          "code": {
            "const": "unsupported_version",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 400,
            "type": "integer"
          },
          "supported_versions": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "title": {
            "const": "API version not supported",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/unsupported_version",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable",
          "supported_versions"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemUpstreamError": {
        "additionalProperties": false,
        "description": "Problem for code upstream_error (HTTP 502, owner API-ERR).",
        "properties": {
          "code": {
            "const": "upstream_error",
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 502,
            "type": "integer"
          },
          "title": {
            "const": "An external system failed",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/upstream_error",
            "type": "string"
          },
          "upstream": {
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable",
          "upstream"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "ProblemVersionMismatch": {
        "additionalProperties": false,
        "description": "Problem for code version_mismatch (HTTP 412, owner API-IDEM).",
        "properties": {
          "code": {
            "const": "version_mismatch",
            "type": "string"
          },
          "current_version": {
            "type": "integer"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "meta": {
            "description": "meta.truncated is true when errors[] was cut (API-ERR-R-024).",
            "type": "object",
            "x-hive-open": true
          },
          "request_id": {
            "type": "string",
            "x-hive-prefix": "req"
          },
          "retry_after_ms": {
            "minimum": 0,
            "type": "integer"
          },
          "retryable": {
            "type": "boolean"
          },
          "status": {
            "const": 412,
            "type": "integer"
          },
          "title": {
            "const": "Resource changed since you read it",
            "type": "string"
          },
          "type": {
            "const": "https://docs.hive.clerktree.com/errors/version_mismatch",
            "type": "string"
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance",
          "code",
          "request_id",
          "retryable",
          "current_version"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "QuantityKind": {
        "additionalProperties": false,
        "description": "A quantity kind: the set of units that may be converted into each other. Dimension alone is not a kind: newton metre (torque) and joule (energy) share a dimension and are different kinds.",
        "properties": {
          "canonical_unit": {
            "description": "The unit new data is stored in for this kind.",
            "example": "bar",
            "type": "string"
          },
          "created_at": {
            "description": "The registry release date.",
            "example": "2026-11-01T00:00:00Z",
            "format": "date-time",
            "type": "string"
          },
          "default_decimals": {
            "description": "The number of decimals of a display when neither the request nor the signal names a precision.",
            "example": 1,
            "maximum": 10,
            "minimum": 0,
            "type": "integer"
          },
          "id": {
            "description": "The kind slug; the same as the slug of the registry.",
            "example": "pressure",
            "type": "string"
          },
          "is_deprecated": {
            "description": "True for a kind that is still accepted and is going to be retired.",
            "example": false,
            "type": "boolean"
          },
          "is_reference_conditions_required": {
            "description": "True when a signal of this kind must carry reference conditions (compressed-air volume flow, DATA-UNITS-R-017).",
            "example": false,
            "type": "boolean"
          },
          "name_i18n": {
            "additionalProperties": false,
            "description": "The name of the kind.",
            "example": {
              "de": "Druck",
              "en": "Pressure"
            },
            "properties": {
              "de": {
                "description": "The German text.",
                "example": "Druck",
                "minLength": 1,
                "type": "string"
              },
              "en": {
                "description": "The English text.",
                "example": "Pressure",
                "minLength": 1,
                "type": "string"
              }
            },
            "required": [
              "de",
              "en"
            ],
            "type": "object"
          },
          "object": {
            "const": "quantity_kind",
            "description": "The object type name (canon 4).",
            "example": "quantity_kind",
            "type": "string"
          },
          "registry_version": {
            "description": "The registry version, release and hash.",
            "example": "2026.11.1+5dbe9dd356f6",
            "type": "string"
          },
          "units": {
            "description": "The units allowed for the kind; the first is the canonical unit.",
            "example": [
              "bar",
              "mbar",
              "Pa",
              "kPa",
              "MPa",
              "[psi]"
            ],
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "updated_at": {
            "description": "The registry release date.",
            "example": "2026-11-01T00:00:00Z",
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "id",
          "object",
          "name_i18n",
          "canonical_unit",
          "units",
          "default_decimals",
          "is_reference_conditions_required",
          "is_deprecated",
          "registry_version",
          "created_at",
          "updated_at"
        ],
        "type": "object",
        "x-hive-object-kind": "view"
      },
      "QuantityKindList": {
        "additionalProperties": false,
        "description": "The quantity kinds of the registry. The registry is small and fixed, so the list is never paged.",
        "properties": {
          "data": {
            "description": "The whole list, in registry order.",
            "example": [],
            "items": {
              "$ref": "#/components/schemas/QuantityKind"
            },
            "type": "array"
          },
          "has_more": {
            "const": false,
            "description": "Always false: the registry is small and fixed, so the list is never paged.",
            "example": false,
            "type": "boolean"
          },
          "next_cursor": {
            "description": "Always null: the list is never paged.",
            "example": null,
            "type": "null"
          },
          "object": {
            "const": "list",
            "description": "The object type name (canon 4).",
            "example": "list",
            "type": "string"
          }
        },
        "required": [
          "object",
          "data",
          "has_more",
          "next_cursor"
        ],
        "type": "object",
        "x-hive-object-kind": "view"
      },
      "SecretScanningReport": {
        "description": "The tokens a secret scanner found, as the scanner sends them.",
        "example": [],
        "items": {
          "additionalProperties": false,
          "description": "One token that a scanner found in a public place.",
          "properties": {
            "source": {
              "description": "The kind of place: content, commit, and so on.",
              "example": "content",
              "maxLength": 64,
              "type": "string"
            },
            "token": {
              "description": "The token the scanner found.",
              "example": "hive_live_01m71xxng7fzrvspnkgtw1t2km_NotARealSecretNotARealSecretNotARealSecrXXXXXX",
              "maxLength": 512,
              "type": "string"
            },
            "type": {
              "description": "The token type the scanner reports.",
              "example": "hive_api_key",
              "maxLength": 128,
              "type": "string"
            },
            "url": {
              "description": "Where the token was found.",
              "example": "https://github.com/example/musterwerk-integration/blob/main/.env",
              "maxLength": 2048,
              "type": "string"
            }
          },
          "required": [
            "token",
            "type"
          ],
          "type": "object"
        },
        "maxItems": 1000,
        "type": "array"
      },
      "SecretScanningResult": {
        "description": "One verdict per reported token, in the same order.",
        "example": [],
        "items": {
          "additionalProperties": false,
          "description": "The verdict for one reported token.",
          "properties": {
            "label": {
              "description": "true_positive for a live key that was revoked and marked compromised, false_positive for anything else.",
              "enum": [
                "true_positive",
                "false_positive"
              ],
              "example": "false_positive",
              "type": "string",
              "x-hive-open": false
            },
            "token_raw": {
              "description": "The token as it was reported.",
              "example": "hive_live_01m71xxng7fzrvspnkgtw1t2km_NotARealSecretNotARealSecretNotARealSecrXXXXXX",
              "maxLength": 512,
              "type": "string"
            },
            "token_type": {
              "description": "The token type as it was reported.",
              "example": "hive_api_key",
              "maxLength": 128,
              "type": "string"
            }
          },
          "required": [
            "token_raw",
            "token_type",
            "label"
          ],
          "type": "object"
        },
        "maxItems": 1000,
        "type": "array"
      },
      "ServerTime": {
        "additionalProperties": false,
        "description": "The cloud time (a view: it has no id).",
        "properties": {
          "now": {
            "description": "The cloud time, UTC with Z, to the microsecond.",
            "example": "2026-11-10T05:12:03.482391Z",
            "format": "date-time",
            "type": "string"
          },
          "object": {
            "const": "server_time",
            "description": "The object type name (canon 4).",
            "example": "server_time",
            "type": "string"
          },
          "time_zone_default": {
            "description": "The IANA zone of a site that names none.",
            "example": "Europe/Berlin",
            "maxLength": 64,
            "type": "string"
          },
          "tzdata_version": {
            "description": "The release of the time zone data in use (DATA-TIME-R-023).",
            "example": "2025c",
            "maxLength": 32,
            "type": "string"
          }
        },
        "required": [
          "object",
          "now",
          "tzdata_version",
          "time_zone_default"
        ],
        "type": "object",
        "x-hive-object-kind": "view"
      },
      "ServiceAccount": {
        "additionalProperties": false,
        "description": "A machine principal of one tenant. It has no permission of its own: permissions come from role grants (IAM-AUTHZ).",
        "properties": {
          "created_at": {
            "description": "When the account was created.",
            "example": "2026-11-11T09:30:00Z",
            "format": "date-time",
            "type": "string",
            "x-hive-index": "service_account_created_idx",
            "x-hive-sortable": true
          },
          "description": {
            "description": "What the account is used for.",
            "example": "Feeds work orders from the MES of Musterwerk Esslingen.",
            "maxLength": 500,
            "type": [
              "string",
              "null"
            ]
          },
          "id": {
            "description": "The service account ID.",
            "example": "sva_01m71xxng7fzrvspnkgtw1t2kj",
            "type": "string",
            "x-hive-prefix": "sva"
          },
          "name": {
            "description": "The name of the account, unique among the live accounts of the tenant (compared without case).",
            "example": "integration-mes",
            "maxLength": 100,
            "minLength": 1,
            "type": "string"
          },
          "object": {
            "const": "service_account",
            "description": "The object type name (canon 4).",
            "example": "service_account",
            "type": "string"
          },
          "owner_user_id": {
            "description": "The user who is notified when a key of the account expires.",
            "example": "usr_01m71xxng7fzrvspnkgtw1t2kg",
            "type": "string",
            "x-hive-prefix": "usr"
          },
          "status": {
            "description": "The state of the account: active, or disabled (all its keys and tokens stop working until it is enabled).",
            "enum": [
              "active",
              "disabled"
            ],
            "example": "active",
            "type": "string",
            "x-hive-open": false,
            "x-hive-state-machine": true
          },
          "updated_at": {
            "description": "When the account last changed.",
            "example": "2026-11-11T09:30:00Z",
            "format": "date-time",
            "type": "string"
          },
          "version": {
            "description": "The version of the account; send it in If-Match to update.",
            "example": 1,
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "name",
          "description",
          "status",
          "owner_user_id",
          "created_at",
          "updated_at",
          "version"
        ],
        "type": "object",
        "x-hive-data-class": "personal",
        "x-hive-object-kind": "resource"
      },
      "ServiceAccountCreate": {
        "additionalProperties": false,
        "description": "A new service account.",
        "properties": {
          "description": {
            "description": "What the account is used for.",
            "example": "Feeds work orders from the MES of Musterwerk Esslingen.",
            "maxLength": 500,
            "type": [
              "string",
              "null"
            ]
          },
          "name": {
            "description": "The name of the account, unique among the live accounts of the tenant (compared without case).",
            "example": "integration-mes",
            "maxLength": 100,
            "minLength": 1,
            "type": "string"
          },
          "owner_user_id": {
            "description": "The user who is notified when a key expires; the caller when omitted.",
            "example": "usr_01m71xxng7fzrvspnkgtw1t2kg",
            "type": "string",
            "x-hive-prefix": "usr"
          }
        },
        "required": [
          "name"
        ],
        "type": "object"
      },
      "ServiceAccountList": {
        "additionalProperties": false,
        "description": "A page of service accounts.",
        "properties": {
          "data": {
            "description": "One page of service accounts.",
            "example": [],
            "items": {
              "$ref": "#/components/schemas/ServiceAccount"
            },
            "type": "array"
          },
          "has_more": {
            "description": "True when another page follows.",
            "example": false,
            "type": "boolean"
          },
          "next_cursor": {
            "description": "The cursor of the next page, or null on the last page.",
            "example": null,
            "type": [
              "string",
              "null"
            ]
          },
          "object": {
            "const": "list",
            "description": "The object type name (canon 4).",
            "example": "list",
            "type": "string"
          },
          "total_count": {
            "description": "The number of service accounts, exact up to 10,000; null unless the request sends count=true.",
            "example": null,
            "minimum": 0,
            "type": [
              "integer",
              "null"
            ]
          },
          "total_count_is_lower_bound": {
            "description": "True when total_count stopped at its cap of 10,000; null unless the request sends count=true.",
            "example": null,
            "type": [
              "boolean",
              "null"
            ]
          }
        },
        "required": [
          "object",
          "data",
          "has_more",
          "next_cursor",
          "total_count",
          "total_count_is_lower_bound"
        ],
        "type": "object",
        "x-hive-object-kind": "list"
      },
      "ServiceAccountUpdate": {
        "additionalProperties": false,
        "description": "A change of a service account; send only what changes.",
        "minProperties": 1,
        "properties": {
          "description": {
            "description": "What the account is used for.",
            "example": "Feeds work orders from the MES of Musterwerk Esslingen.",
            "maxLength": 500,
            "type": [
              "string",
              "null"
            ]
          },
          "name": {
            "description": "The name of the account, unique among the live accounts of the tenant (compared without case).",
            "example": "integration-mes",
            "maxLength": 100,
            "minLength": 1,
            "type": "string"
          },
          "owner_user_id": {
            "description": "The user who is notified when a key of the account expires.",
            "example": "usr_01m71xxng7fzrvspnkgtw1t2kg",
            "type": "string",
            "x-hive-prefix": "usr"
          },
          "status": {
            "description": "active enables a disabled account.",
            "enum": [
              "active"
            ],
            "example": "active",
            "type": "string",
            "x-hive-open": false
          }
        },
        "type": "object"
      },
      "ShiftWindow": {
        "additionalProperties": false,
        "description": "A shift window of a site, or the null window when no shift runs (a view: it has no id).",
        "properties": {
          "end_at": {
            "description": "The end of the window, exclusive, in UTC.",
            "example": "2026-11-10T13:00:00Z",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ]
          },
          "object": {
            "const": "shift_window",
            "description": "The object type name (canon 4).",
            "example": "shift_window",
            "type": "string"
          },
          "shift_key": {
            "description": "The key of the shift (A, B, C); null when no shift runs at the instant.",
            "example": "A",
            "maxLength": 64,
            "type": [
              "string",
              "null"
            ]
          },
          "shift_on": {
            "description": "The local date on which the shift starts (a night shift belongs to the date it starts on). The specification calls the member shift_date; canon section 4 names a date without time with the suffix _on.",
            "example": "2026-11-10",
            "format": "date",
            "type": [
              "string",
              "null"
            ]
          },
          "site_id": {
            "description": "The site the shift belongs to.",
            "example": "ast_01jc8z3k5me9rt7q2v4x6b0dnh",
            "type": "string",
            "x-hive-prefix": "ast"
          },
          "start_at": {
            "description": "The start of the window, inclusive, in UTC.",
            "example": "2026-11-10T05:00:00Z",
            "format": "date-time",
            "type": [
              "string",
              "null"
            ]
          },
          "time_zone": {
            "description": "The IANA time zone of the site.",
            "example": "Europe/Berlin",
            "maxLength": 64,
            "type": "string"
          }
        },
        "required": [
          "object",
          "site_id",
          "shift_key",
          "shift_on",
          "start_at",
          "end_at",
          "time_zone"
        ],
        "type": "object",
        "x-hive-object-kind": "view"
      },
      "ShiftWindowList": {
        "additionalProperties": false,
        "description": "The shift windows of a site, ordered by start.",
        "properties": {
          "data": {
            "description": "The shift windows of a site, ordered by start.",
            "example": [],
            "items": {
              "$ref": "#/components/schemas/ShiftWindow"
            },
            "type": "array"
          },
          "has_more": {
            "const": false,
            "description": "Always false: the list is never paged.",
            "example": false,
            "type": "boolean"
          },
          "next_cursor": {
            "description": "Always null: the list is never paged.",
            "example": null,
            "type": "null"
          },
          "object": {
            "const": "list",
            "description": "The object type name (canon 4).",
            "example": "list",
            "type": "string"
          }
        },
        "required": [
          "object",
          "data",
          "has_more",
          "next_cursor"
        ],
        "type": "object",
        "x-hive-object-kind": "view"
      },
      "SiteProfile": {
        "additionalProperties": false,
        "description": "The tenant-facing profile of a site. The site itself is an asset (GRAPH-HIER); the profile adds its time zone, country and address.",
        "properties": {
          "address": {
            "additionalProperties": true,
            "description": "The postal address of the site as the customer enters it; free form.",
            "example": {
              "city": "Esslingen am Neckar",
              "postal_code": "73730",
              "street": "Plochinger Strasse 12"
            },
            "type": [
              "object",
              "null"
            ],
            "x-hive-open": true
          },
          "asset_id": {
            "description": "The asset of kind site that the profile belongs to (GRAPH-HIER).",
            "example": "ast_01m71xxng7fzrvspnkgtw1t2kg",
            "type": "string",
            "x-hive-prefix": "ast"
          },
          "country_code": {
            "description": "The ISO 3166 alpha-2 country code of the site.",
            "example": "DE",
            "pattern": "^[A-Z]{2}$",
            "type": "string"
          },
          "created_at": {
            "description": "When the profile was created.",
            "example": "2026-09-01T08:00:00Z",
            "format": "date-time",
            "type": "string"
          },
          "object": {
            "const": "site",
            "description": "The object type name (canon 4).",
            "example": "site",
            "type": "string"
          },
          "time_zone": {
            "description": "The IANA time zone of the site.",
            "example": "Europe/Berlin",
            "maxLength": 64,
            "minLength": 1,
            "type": "string"
          },
          "updated_at": {
            "description": "When the profile last changed.",
            "example": "2026-11-01T09:30:00Z",
            "format": "date-time",
            "type": "string"
          },
          "version": {
            "description": "The version of the profile; send it in If-Match to update.",
            "example": 1,
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "object",
          "asset_id",
          "time_zone",
          "country_code",
          "address",
          "created_at",
          "updated_at",
          "version"
        ],
        "type": "object",
        "x-hive-object-kind": "view"
      },
      "SiteProfileList": {
        "additionalProperties": false,
        "description": "The site profiles of the current tenant. A tenant has few sites, so the list is never paged (RECONCILE 188).",
        "properties": {
          "data": {
            "description": "The site profiles of the tenant, ordered by ID.",
            "example": [],
            "items": {
              "$ref": "#/components/schemas/SiteProfile"
            },
            "type": "array"
          },
          "has_more": {
            "const": false,
            "description": "Always false: a tenant has few sites, so the list is never paged.",
            "example": false,
            "type": "boolean"
          },
          "next_cursor": {
            "description": "Always null: the list is never paged.",
            "example": null,
            "type": "null"
          },
          "object": {
            "const": "list",
            "description": "The object type name (canon 4).",
            "example": "list",
            "type": "string"
          }
        },
        "required": [
          "object",
          "data",
          "has_more",
          "next_cursor"
        ],
        "type": "object",
        "x-hive-object-kind": "view"
      },
      "SiteProfileUpdate": {
        "additionalProperties": false,
        "description": "The fields of a site profile a customer may change. The profile is created by the first update of a site that has none; the site must be an asset of kind site.",
        "properties": {
          "address": {
            "additionalProperties": true,
            "description": "The postal address; free form. Null clears it.",
            "example": {
              "city": "Esslingen am Neckar",
              "postal_code": "73730",
              "street": "Plochinger Strasse 12"
            },
            "type": [
              "object",
              "null"
            ],
            "x-hive-open": true
          },
          "country_code": {
            "description": "The ISO 3166 alpha-2 country code.",
            "example": "DE",
            "pattern": "^[A-Z]{2}$",
            "type": "string"
          },
          "time_zone": {
            "description": "The IANA time zone, for example Europe/Berlin. A name that is not in the time zone database is refused.",
            "example": "Europe/Berlin",
            "maxLength": 64,
            "minLength": 1,
            "type": "string"
          }
        },
        "required": [],
        "type": "object"
      },
      "Tenant": {
        "additionalProperties": false,
        "properties": {
          "api_version": {
            "description": "The API version the tenant is pinned to (API-VER).",
            "example": "2026-11-01",
            "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
            "type": "string"
          },
          "cell": {
            "description": "The one cell that serves the tenant.",
            "example": "eu-central-1a",
            "type": "string"
          },
          "contract_id": {
            "description": "The contract the tenant is bound to, one to one (BILL-PLAN).",
            "example": "ctr_01jc8z3k5me9rt7q2v4x6b0dnj",
            "type": "string",
            "x-hive-prefix": "ctr"
          },
          "created_at": {
            "description": "When the tenant was created.",
            "example": "2026-09-01T08:00:00Z",
            "format": "date-time",
            "type": "string"
          },
          "default_language": {
            "description": "The language of messages when the request names none: de or en.",
            "enum": [
              "de",
              "en"
            ],
            "example": "de",
            "type": "string",
            "x-hive-open": true
          },
          "display_name": {
            "description": "The name shown in the web console and in e-mails.",
            "example": "Musterwerk Esslingen",
            "maxLength": 200,
            "minLength": 1,
            "type": "string"
          },
          "handle": {
            "description": "The short name of the tenant, unique in HIVE and never reused after deletion. It appears in login hints only; it is never a key.",
            "example": "musterwerk-esslingen",
            "pattern": "^[a-z0-9][a-z0-9-]{1,38}[a-z0-9]$",
            "type": "string"
          },
          "id": {
            "description": "The tenant ID (canon 2.2). Never changes.",
            "example": "ten_01jc8z3k5me9rt7q2v4x6b0dnh",
            "type": "string",
            "x-hive-prefix": "ten"
          },
          "object": {
            "const": "tenant",
            "description": "The object type name (canon 4).",
            "example": "tenant",
            "type": "string"
          },
          "region": {
            "description": "The one region of the tenant's data.",
            "example": "eu-central-1",
            "type": "string"
          },
          "state": {
            "description": "The lifecycle state of the tenant. It is owned by tenant lifecycle (TEN-LIFE) and cannot be changed here.",
            "enum": [
              "provisioning",
              "active",
              "suspended",
              "offboarding",
              "deleting",
              "deleted",
              "failed"
            ],
            "example": "active",
            "type": "string",
            "x-hive-open": false,
            "x-hive-state-machine": true
          },
          "updated_at": {
            "description": "When the tenant record last changed.",
            "example": "2026-11-01T09:30:00Z",
            "format": "date-time",
            "type": "string"
          },
          "version": {
            "description": "The version of the record; send it in If-Match to update.",
            "example": 3,
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "handle",
          "display_name",
          "state",
          "default_language",
          "cell",
          "region",
          "contract_id",
          "api_version",
          "created_at",
          "updated_at",
          "version"
        ],
        "type": "object",
        "x-hive-object-kind": "resource"
      },
      "TenantUpdate": {
        "additionalProperties": false,
        "description": "The fields of the tenant a customer may change. The handle, the ID and the state cannot be patched: a request that names them is refused as an unknown field.",
        "properties": {
          "default_language": {
            "description": "The new default language.",
            "enum": [
              "de",
              "en"
            ],
            "example": "en",
            "type": "string",
            "x-hive-open": true
          },
          "display_name": {
            "description": "The new display name.",
            "example": "Musterwerk Esslingen",
            "maxLength": 200,
            "minLength": 1,
            "type": "string"
          }
        },
        "required": [],
        "type": "object"
      },
      "TimeException": {
        "additionalProperties": false,
        "description": "One substituted timestamp (DATA-TIME-R-012). The record has no ID of its own: the specification adds no ID prefix.",
        "properties": {
          "object": {
            "const": "time_exception",
            "description": "The object type name (canon 4).",
            "example": "time_exception",
            "type": "string"
          },
          "signal_id": {
            "description": "The signal whose timestamp was replaced.",
            "example": "sig_01jc8z3k5me9rt7q2v4x6b0dnh",
            "type": "string",
            "x-hive-prefix": "sig"
          },
          "t_ingest": {
            "description": "When the endpoint accepted the sample.",
            "example": "2026-11-10T05:12:03.610Z",
            "format": "date-time",
            "type": "string",
            "x-hive-index": "time_exception_ingest_idx",
            "x-hive-sortable": true
          },
          "t_original_raw": {
            "description": "The source time as received: an RFC 3339 instant, or the OPC UA ticks as text when the value cannot be an instant of this system.",
            "example": "1601-01-01T00:00:00Z",
            "maxLength": 64,
            "type": "string"
          },
          "t_stored": {
            "description": "The time that was stored instead (the gateway time of the sample).",
            "example": "2026-11-10T05:12:03.482Z",
            "format": "date-time",
            "type": "string"
          },
          "verdict": {
            "description": "Why it was replaced: future (more than the hard limit ahead of the gateway time) or epoch_sentinel (before 2000-01-01).",
            "enum": [
              "future",
              "epoch_sentinel"
            ],
            "example": "epoch_sentinel",
            "type": "string",
            "x-hive-open": false
          }
        },
        "required": [
          "object",
          "signal_id",
          "t_original_raw",
          "t_stored",
          "verdict",
          "t_ingest"
        ],
        "type": "object",
        "x-hive-object-kind": "view"
      },
      "TimeExceptionList": {
        "additionalProperties": false,
        "description": "A page of substituted timestamps.",
        "properties": {
          "data": {
            "description": "Substituted timestamps.",
            "example": [],
            "items": {
              "$ref": "#/components/schemas/TimeException"
            },
            "type": "array"
          },
          "has_more": {
            "description": "True when another page follows.",
            "example": false,
            "type": "boolean"
          },
          "next_cursor": {
            "description": "The cursor of the next page, or null on the last page.",
            "example": null,
            "type": [
              "string",
              "null"
            ]
          },
          "object": {
            "const": "list",
            "description": "The object type name (canon 4).",
            "example": "list",
            "type": "string"
          },
          "total_count": {
            "description": "The number of items, exact up to 10,000; null unless the request sends count=true.",
            "example": null,
            "minimum": 0,
            "type": [
              "integer",
              "null"
            ]
          },
          "total_count_is_lower_bound": {
            "description": "True when total_count stopped at its cap of 10,000; null unless the request sends count=true.",
            "example": null,
            "type": [
              "boolean",
              "null"
            ]
          }
        },
        "required": [
          "object",
          "data",
          "has_more",
          "next_cursor",
          "total_count",
          "total_count_is_lower_bound"
        ],
        "type": "object",
        "x-hive-object-kind": "list"
      },
      "Unit": {
        "additionalProperties": false,
        "description": "A unit of the registry: a UCUM code that HIVE accepts. The registry is the same for every tenant and is released with the software; a released unit never changes (DATA-UNITS-R-018).",
        "properties": {
          "affine": {
            "description": "True for a unit with an offset (Cel, [degF]): a difference of such units is a K, never a Cel.",
            "example": false,
            "type": "boolean"
          },
          "code": {
            "description": "The UCUM code, matched case-sensitively and exactly.",
            "example": "bar",
            "maxLength": 32,
            "type": "string"
          },
          "created_at": {
            "description": "The registry release date.",
            "example": "2026-11-01T00:00:00Z",
            "format": "date-time",
            "type": "string"
          },
          "id": {
            "description": "The unit code; the same as code.",
            "example": "bar",
            "type": "string"
          },
          "is_deprecated": {
            "description": "True for a unit that is still accepted and is going to be retired.",
            "example": false,
            "type": "boolean"
          },
          "kinds": {
            "description": "The quantity kinds that list this unit. Two units can be converted only if one kind lists both.",
            "example": [
              "pressure"
            ],
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "label_i18n": {
            "additionalProperties": false,
            "description": "How the unit is written for people.",
            "example": {
              "de": "bar",
              "en": "bar"
            },
            "properties": {
              "de": {
                "description": "The German text.",
                "example": "bar",
                "minLength": 1,
                "type": "string"
              },
              "en": {
                "description": "The English text.",
                "example": "bar",
                "minLength": 1,
                "type": "string"
              }
            },
            "required": [
              "de",
              "en"
            ],
            "type": "object"
          },
          "object": {
            "const": "unit",
            "description": "The object type name (canon 4).",
            "example": "unit",
            "type": "string"
          },
          "registry_version": {
            "description": "The registry version, release and hash.",
            "example": "2026.11.1+5dbe9dd356f6",
            "type": "string"
          },
          "updated_at": {
            "description": "The registry release date.",
            "example": "2026-11-01T00:00:00Z",
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "id",
          "object",
          "code",
          "kinds",
          "label_i18n",
          "affine",
          "is_deprecated",
          "registry_version",
          "created_at",
          "updated_at"
        ],
        "type": "object",
        "x-hive-object-kind": "view"
      },
      "UnitConversion": {
        "additionalProperties": false,
        "description": "The converted value. The conversion is exact to a relative error of 1e-12; the factor and the offset are the ones applied: out = value * factor_used + offset_used.",
        "properties": {
          "factor_used": {
            "description": "The factor of the conversion plan.",
            "example": 14.50377377302092,
            "type": "number"
          },
          "object": {
            "const": "conversion",
            "description": "The object type name (canon 4).",
            "example": "conversion",
            "type": "string"
          },
          "offset_used": {
            "description": "The offset of the conversion plan; zero except between affine units (Cel, [degF], K).",
            "example": 0,
            "type": "number"
          },
          "unit": {
            "description": "The unit of the converted value.",
            "example": "[psi]",
            "type": "string"
          },
          "value": {
            "description": "The converted value.",
            "example": 78.32037837431298,
            "type": "number"
          }
        },
        "required": [
          "object",
          "value",
          "unit",
          "factor_used",
          "offset_used"
        ],
        "type": "object",
        "x-hive-object-kind": "transient"
      },
      "UnitConvertRequest": {
        "additionalProperties": false,
        "description": "A value to convert from one unit to another. The units must be registered codes, spelled exactly; an alias is refused, never corrected. Naming the kind of each side adds the check that dimension alone cannot give (newton metre to joule, mm/s of a vibration to mm/s of a feed).",
        "properties": {
          "from": {
            "description": "The unit of value.",
            "example": "bar",
            "maxLength": 32,
            "minLength": 1,
            "type": "string"
          },
          "from_kind": {
            "description": "The quantity kind of the value. When only one kind is named it applies to both sides.",
            "example": "pressure",
            "maxLength": 64,
            "pattern": "^[a-z][a-z0-9_]{0,63}$",
            "type": "string"
          },
          "to": {
            "description": "The unit to convert to.",
            "example": "[psi]",
            "maxLength": 32,
            "minLength": 1,
            "type": "string"
          },
          "to_kind": {
            "description": "The quantity kind of the result.",
            "example": "pressure",
            "maxLength": 64,
            "pattern": "^[a-z][a-z0-9_]{0,63}$",
            "type": "string"
          },
          "value": {
            "description": "The value to convert. A finite number: NaN and infinity are refused.",
            "example": 5.4,
            "type": "number"
          }
        },
        "required": [
          "value",
          "from",
          "to"
        ],
        "type": "object"
      },
      "UnitFormatRequest": {
        "additionalProperties": false,
        "description": "A quantity to show to a person. Stateless: the tenant's display style is not read here; a client sends the style it wants. Nothing is stored and the value is never changed, only the text is rounded.",
        "properties": {
          "count_noun_i18n": {
            "additionalProperties": false,
            "description": "The noun shown after a count (unit 1), for example Teile and parts. Without it a count has no unit label.",
            "example": {
              "de": "Teile",
              "en": "parts"
            },
            "properties": {
              "de": {
                "description": "The German noun.",
                "example": "Teile",
                "maxLength": 40,
                "type": "string"
              },
              "en": {
                "description": "The English noun.",
                "example": "parts",
                "maxLength": 40,
                "type": "string"
              }
            },
            "type": "object"
          },
          "kind": {
            "description": "The quantity kind of the value; it selects the default decimals and the suffix of its units (m³/h (Normal) for compressed air).",
            "example": "pressure",
            "maxLength": 64,
            "pattern": "^[a-z][a-z0-9_]{0,63}$",
            "type": "string"
          },
          "locale": {
            "description": "A BCP 47 tag. de and en are supported; an unsupported tag falls back to its language, then to en, and the response says which locale was used.",
            "example": "de",
            "maxLength": 35,
            "type": "string"
          },
          "precision": {
            "description": "The number of decimals, 0 to 10. Without it the display_precision of the signal or the default of the kind is used; trailing zeros are not shown.",
            "example": 1,
            "maximum": 10,
            "minimum": 0,
            "type": "integer"
          },
          "style": {
            "description": "The German label of 1/min: colloquial (U/min, the default) or din (min⁻¹). It has no effect on other units or on English.",
            "enum": [
              "colloquial",
              "din"
            ],
            "example": "colloquial",
            "type": "string",
            "x-hive-open": false
          },
          "unit": {
            "description": "The unit of value, a registered code.",
            "example": "mm/s",
            "maxLength": 32,
            "minLength": 1,
            "type": "string"
          },
          "value": {
            "description": "The value to format. A finite number.",
            "example": 7.8,
            "type": "number"
          }
        },
        "required": [
          "value",
          "unit"
        ],
        "type": "object"
      },
      "UnitList": {
        "additionalProperties": false,
        "description": "The units of the registry. The registry is small and fixed, so the list is never paged; it is not tenant specific.",
        "properties": {
          "data": {
            "description": "The whole list, in registry order.",
            "example": [],
            "items": {
              "$ref": "#/components/schemas/Unit"
            },
            "type": "array"
          },
          "has_more": {
            "const": false,
            "description": "Always false: the registry is small and fixed, so the list is never paged.",
            "example": false,
            "type": "boolean"
          },
          "next_cursor": {
            "description": "Always null: the list is never paged.",
            "example": null,
            "type": "null"
          },
          "object": {
            "const": "list",
            "description": "The object type name (canon 4).",
            "example": "list",
            "type": "string"
          }
        },
        "required": [
          "object",
          "data",
          "has_more",
          "next_cursor"
        ],
        "type": "object",
        "x-hive-object-kind": "view"
      },
      "UnitPreferences": {
        "additionalProperties": false,
        "description": "The display units of the tenant: which unit each quantity kind is shown in, and the style of the German rotational speed label. One document per tenant; a request parameter overrides it, and the canonical unit of the kind applies where it names nothing.",
        "properties": {
          "created_at": {
            "description": "When the document was created.",
            "example": "2026-11-01T09:00:00Z",
            "format": "date-time",
            "type": "string"
          },
          "display_units": {
            "additionalProperties": {
              "maxLength": 32,
              "type": "string"
            },
            "description": "The unit per quantity kind, for example pressure in bar. A value must be a unit of that kind.",
            "example": {
              "pressure": "bar"
            },
            "type": "object",
            "x-hive-open": true
          },
          "id": {
            "description": "The ID of the tenant's unit preferences.",
            "example": "unp_01jc8z3k5me9rt7q2v4x6b0dnh",
            "type": "string",
            "x-hive-prefix": "unp"
          },
          "object": {
            "const": "unit_preferences",
            "description": "The object type name (canon 4).",
            "example": "unit_preferences",
            "type": "string"
          },
          "rotational_speed_style": {
            "description": "The German label of 1/min: colloquial (U/min) or din (min⁻¹).",
            "enum": [
              "colloquial",
              "din"
            ],
            "example": "colloquial",
            "type": "string",
            "x-hive-open": false
          },
          "updated_at": {
            "description": "When the document last changed.",
            "example": "2026-11-10T09:30:00Z",
            "format": "date-time",
            "type": "string"
          },
          "version": {
            "description": "The version of the document; send it in If-Match to replace it.",
            "example": 3,
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "id",
          "object",
          "display_units",
          "rotational_speed_style",
          "version",
          "created_at",
          "updated_at"
        ],
        "type": "object",
        "x-hive-data-class": "tenant_operational",
        "x-hive-object-kind": "resource"
      },
      "UnitPreferencesUpdate": {
        "additionalProperties": false,
        "description": "The members of the preference document to set. A member that is present replaces the stored member as a whole (display_units is the complete map, not a merge); a member that is absent stays as it is. A unit that is not one of its kind is refused with unit_not_in_kind.",
        "minProperties": 1,
        "properties": {
          "display_units": {
            "additionalProperties": {
              "maxLength": 32,
              "type": "string"
            },
            "description": "The unit per quantity kind. Every key is a kind slug and every value a unit of that kind.",
            "example": {
              "pressure": "bar",
              "temperature": "Cel"
            },
            "maxProperties": 30,
            "type": "object",
            "x-hive-open": true
          },
          "rotational_speed_style": {
            "description": "The German label of 1/min: colloquial or din.",
            "enum": [
              "colloquial",
              "din"
            ],
            "example": "din",
            "type": "string",
            "x-hive-open": false
          }
        },
        "required": [],
        "type": "object"
      }
    }
  },
  "info": {
    "description": "Foundations contract: process health plus the shared Problem schema and header parameters (API-STD, API-ERR). Resource operations are added by their owning modules. Every list operation follows one set of rules for the envelope, cursors, filters, sort, field selection and expansion (API-PAGE): English guide https://docs.hive.clerktree.com/api/pagination (docs/api/pagination.en.md), German guide https://docs.hive.clerktree.com/api/pagination.de (docs/api/pagination.de.md).",
    "title": "HIVE API",
    "version": "2026-11-01"
  },
  "openapi": "3.1.0",
  "paths": {
    "/v1/api-keys": {
      "get": {
        "description": "The API keys of the tenant, newest first; filter by service_account_id. No response holds a secret.",
        "operationId": "api_key_list",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/Limit"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiKeyList"
                }
              }
            },
            "description": "A page of API keys",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "List the API keys",
        "x-hive-data-class": "personal",
        "x-hive-default-sort": "-created_at",
        "x-hive-errors": [
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-owner": "IAM-KEYS",
        "x-hive-permission": "api_key.list",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      },
      "post": {
        "description": "Creates a key for a service account and returns it once, in the response. Needs a user with a recent step-up authentication; a service account cannot create keys. A scope that is a human-only permission answers 400 human_only_permission.",
        "operationId": "api_key_create",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiKeyCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiKeyCreated"
                }
              }
            },
            "description": "The new key, with its secret",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              },
              "Location": {
                "description": "The URL of the new key.",
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Create an API key",
        "x-hive-data-class": "personal",
        "x-hive-errors": [
          "not_found",
          "conflict",
          "limit_exceeded",
          "step_up_required",
          "permission_denied",
          "unavailable"
        ],
        "x-hive-idempotency": "optional",
        "x-hive-owner": "IAM-KEYS",
        "x-hive-permission": "api_key.create",
        "x-hive-principals": [
          "user"
        ],
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 3,
        "x-hive-stability": "stable",
        "x-hive-step-up": "mfa"
      }
    },
    "/v1/api-keys/{id}": {
      "delete": {
        "description": "Revokes the key for good: it stops working everywhere within seconds and cannot be restored; create a new key instead.",
        "operationId": "api_key_delete",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/ApiKeyPath"
          },
          {
            "$ref": "#/components/parameters/IfMatch"
          }
        ],
        "responses": {
          "204": {
            "description": "The key is revoked",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Revoke an API key",
        "x-hive-data-class": "personal",
        "x-hive-errors": [
          "not_found",
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-if-match": "optional",
        "x-hive-owner": "IAM-KEYS",
        "x-hive-permission": "api_key.revoke",
        "x-hive-principals": [
          "user"
        ],
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 2,
        "x-hive-stability": "stable"
      },
      "get": {
        "description": "One API key of the tenant, with its hint and metadata and without its secret.",
        "operationId": "api_key_get",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/ApiKeyPath"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiKey"
                }
              }
            },
            "description": "The key",
            "headers": {
              "ETag": {
                "$ref": "#/components/headers/ETag"
              },
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Get an API key",
        "x-hive-data-class": "personal",
        "x-hive-errors": [
          "not_found",
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-owner": "IAM-KEYS",
        "x-hive-permission": "api_key.get",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      },
      "patch": {
        "description": "Changes the name or the address list of a key that is active.",
        "operationId": "api_key_update",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/ApiKeyPath"
          },
          {
            "$ref": "#/components/parameters/IfMatch"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiKeyUpdate"
              }
            },
            "application/merge-patch+json": {
              "schema": {
                "$ref": "#/components/schemas/ApiKeyUpdate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiKey"
                }
              }
            },
            "description": "The updated key",
            "headers": {
              "ETag": {
                "$ref": "#/components/headers/ETag"
              },
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Change an API key",
        "x-hive-data-class": "personal",
        "x-hive-errors": [
          "not_found",
          "version_mismatch",
          "conflict",
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-if-match": "optional",
        "x-hive-owner": "IAM-KEYS",
        "x-hive-permission": "api_key.update",
        "x-hive-principals": [
          "user"
        ],
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 2,
        "x-hive-stability": "stable"
      }
    },
    "/v1/api-keys/{id}/rotate": {
      "post": {
        "description": "Creates a new secret for the same key ID and returns the new key once; the old secret keeps working for the grace period. A second rotation during the grace period answers 409. Needs a user with a recent step-up authentication.",
        "operationId": "api_key_rotate",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/ApiKeyPath"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiKeyRotate"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiKeyCreated"
                }
              }
            },
            "description": "The key with its new secret",
            "headers": {
              "ETag": {
                "$ref": "#/components/headers/ETag"
              },
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Rotate an API key",
        "x-hive-data-class": "personal",
        "x-hive-errors": [
          "not_found",
          "conflict",
          "step_up_required",
          "permission_denied",
          "unavailable"
        ],
        "x-hive-idempotency": "optional",
        "x-hive-owner": "IAM-KEYS",
        "x-hive-permission": "api_key.rotate",
        "x-hive-principals": [
          "user"
        ],
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 3,
        "x-hive-stability": "stable",
        "x-hive-step-up": "mfa"
      }
    },
    "/v1/api-versions": {
      "get": {
        "description": "Every dated version with its status, dates and changelog URL (API-VER-R-017). The registry is public and tenant-independent; only pinned_by_tenant depends on the caller.",
        "operationId": "api_version_list",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiVersionList"
                }
              }
            },
            "description": "The versions",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "List the API versions",
        "x-hive-data-class": "tenant_operational",
        "x-hive-errors": [
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-owner": "API-VER",
        "x-hive-permission": "api_version.read",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      }
    },
    "/v1/api-versions/pin": {
      "post": {
        "description": "Pins the tenant to a served version, newer or older, or with dry_run true lists what the change affects (API-VER-R-018, R-019). The pin takes effect within 60 seconds and is audited. Human only; the system never changes a pin itself.",
        "operationId": "api_version_pin",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiVersionPinRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiVersionPinResponse"
                }
              }
            },
            "description": "The preview of a dry run, or the new pin",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Change the tenant pin",
        "x-hive-data-class": "personal",
        "x-hive-errors": [
          "unsupported_version",
          "unavailable",
          "conflict"
        ],
        "x-hive-human-only": true,
        "x-hive-idempotency": "optional",
        "x-hive-owner": "API-VER",
        "x-hive-permission": "api_version.update",
        "x-hive-principals": [
          "user"
        ],
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 2,
        "x-hive-stability": "stable"
      }
    },
    "/v1/api-versions/{version}": {
      "get": {
        "description": "One version with its changes (API-VER-R-017).",
        "operationId": "api_version_retrieve",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/ApiVersionPath"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiVersionDetail"
                }
              }
            },
            "description": "The version",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Retrieve one API version",
        "x-hive-data-class": "tenant_operational",
        "x-hive-errors": [
          "not_found",
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-owner": "API-VER",
        "x-hive-permission": "api_version.read",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      }
    },
    "/v1/assets": {
      "get": {
        "description": "The assets of the tenant that the caller may list, as a page. Filter by kind, parent_id, site_id, asset_type_id, lifecycle_state and key; q matches the start of a name or a key; under limits the list to a subtree. An asset outside the caller's scopes is left out and nothing counts it (GRAPH-HIER-R-014).",
        "operationId": "asset_list",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/AssetUnder"
          },
          {
            "$ref": "#/components/parameters/AssetQuery"
          },
          {
            "$ref": "#/components/parameters/AssetIncludeDeleted"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AssetList"
                }
              }
            },
            "description": "A page of assets",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "List the assets",
        "x-hive-data-class": "tenant_operational",
        "x-hive-default-sort": "sort_order",
        "x-hive-errors": [
          "not_found",
          "permission_denied",
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-owner": "GRAPH-HIER",
        "x-hive-permission": "asset.list",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      },
      "post": {
        "description": "Creates a site, area, line, work unit, machine or component. The parent must be of an allowed kind and not decommissioned, the tree at most 8 levels deep and the key unused. A site needs its time zone and country. The caller needs asset.create on the parent (for a site: on the tenant).",
        "operationId": "asset_create",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AssetCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Asset"
                }
              }
            },
            "description": "The new asset",
            "headers": {
              "ETag": {
                "$ref": "#/components/headers/ETag"
              },
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              },
              "Location": {
                "description": "The URL of the new asset.",
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Create an asset",
        "x-hive-data-class": "tenant_operational",
        "x-hive-errors": [
          "conflict",
          "limit_exceeded",
          "not_found",
          "permission_denied",
          "precondition_failed",
          "unavailable"
        ],
        "x-hive-idempotency": "optional",
        "x-hive-owner": "GRAPH-HIER",
        "x-hive-permission": "asset.create",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 2,
        "x-hive-stability": "stable"
      }
    },
    "/v1/assets/{id}": {
      "delete": {
        "description": "Soft delete: the asset disappears from every normal read and can be restored until the retention job purges it. Only a planned or decommissioned asset can be deleted; one with children needs cascade=true. A subtree of more than 2,000 assets is refused with 400 (delete it in parts): asynchronous operations are started by a POST (API-CAT-R-011).",
        "operationId": "asset_delete",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/AssetPath"
          },
          {
            "$ref": "#/components/parameters/AssetCascade"
          },
          {
            "$ref": "#/components/parameters/IfMatch"
          }
        ],
        "responses": {
          "204": {
            "description": "The asset is deleted",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Delete an asset",
        "x-hive-data-class": "tenant_operational",
        "x-hive-errors": [
          "conflict",
          "invalid_request",
          "not_found",
          "permission_denied",
          "precondition_failed",
          "unavailable",
          "version_mismatch"
        ],
        "x-hive-idempotency": "none",
        "x-hive-if-match": "optional",
        "x-hive-owner": "GRAPH-HIER",
        "x-hive-permission": "asset.delete",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 3,
        "x-hive-stability": "stable"
      },
      "get": {
        "description": "One asset with its place in the tree. An asset of another tenant, or an unknown ID, answers 404 not_found.",
        "operationId": "asset_get",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/AssetPath"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Asset"
                }
              }
            },
            "description": "The asset",
            "headers": {
              "ETag": {
                "$ref": "#/components/headers/ETag"
              },
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Get an asset",
        "x-hive-data-class": "tenant_operational",
        "x-hive-errors": [
          "not_found",
          "permission_denied",
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-owner": "GRAPH-HIER",
        "x-hive-permission": "asset.read",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      },
      "patch": {
        "description": "Changes name, key, description, type, manufacturer, model, variant, serial number, build year, commissioning date, properties, sort order or the site profile. It needs If-Match with the current version. The kind and the parent cannot be changed here.",
        "operationId": "asset_update",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/AssetPath"
          },
          {
            "$ref": "#/components/parameters/IfMatch"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AssetUpdate"
              }
            },
            "application/merge-patch+json": {
              "schema": {
                "$ref": "#/components/schemas/AssetUpdate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Asset"
                }
              }
            },
            "description": "The changed asset",
            "headers": {
              "ETag": {
                "$ref": "#/components/headers/ETag"
              },
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Change an asset",
        "x-hive-data-class": "tenant_operational",
        "x-hive-errors": [
          "conflict",
          "not_found",
          "permission_denied",
          "precondition_failed",
          "precondition_required",
          "unavailable",
          "version_mismatch"
        ],
        "x-hive-idempotency": "none",
        "x-hive-if-match": "required",
        "x-hive-owner": "GRAPH-HIER",
        "x-hive-permission": "asset.update",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 2,
        "x-hive-stability": "stable"
      }
    },
    "/v1/assets/{id}/ancestors": {
      "get": {
        "description": "The path to the site: the parent first and the site last. The list is never paged.",
        "operationId": "asset_get_ancestors",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/AssetPath"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AssetAncestorList"
                }
              }
            },
            "description": "The ancestors",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "List the ancestors of an asset",
        "x-hive-data-class": "tenant_operational",
        "x-hive-errors": [
          "not_found",
          "permission_denied",
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-owner": "GRAPH-HIER",
        "x-hive-permission": "asset.list",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      }
    },
    "/v1/assets/{id}/children": {
      "get": {
        "description": "The direct children, ordered by sort order.",
        "operationId": "asset_get_children",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/AssetPath"
          },
          {
            "$ref": "#/components/parameters/Limit"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AssetList"
                }
              }
            },
            "description": "A page of assets",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "List the children of an asset",
        "x-hive-data-class": "tenant_operational",
        "x-hive-default-sort": "sort_order",
        "x-hive-errors": [
          "not_found",
          "permission_denied",
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-owner": "GRAPH-HIER",
        "x-hive-permission": "asset.list",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      }
    },
    "/v1/assets/{id}/descendants": {
      "get": {
        "description": "Every asset below this one, to the depth asked for, ordered by sort order. Filter by kind.",
        "operationId": "asset_get_descendants",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/AssetPath"
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/AssetDescendantDepth"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AssetList"
                }
              }
            },
            "description": "A page of assets",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "List the descendants of an asset",
        "x-hive-data-class": "tenant_operational",
        "x-hive-default-sort": "sort_order",
        "x-hive-errors": [
          "not_found",
          "permission_denied",
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-owner": "GRAPH-HIER",
        "x-hive-permission": "asset.list",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      }
    },
    "/v1/assets/{id}/lifecycle": {
      "post": {
        "description": "Moves the asset along planned, commissioning, active, standby and decommissioned. Decommissioning also decommissions everything below it. It is metadata and never acts on a machine.",
        "operationId": "asset_lifecycle",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/AssetPath"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/IfMatch"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AssetLifecycleChange"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Asset"
                }
              }
            },
            "description": "The asset in its new state",
            "headers": {
              "ETag": {
                "$ref": "#/components/headers/ETag"
              },
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Change the lifecycle of an asset",
        "x-hive-data-class": "tenant_operational",
        "x-hive-errors": [
          "not_found",
          "permission_denied",
          "precondition_failed",
          "unavailable",
          "version_mismatch"
        ],
        "x-hive-idempotency": "optional",
        "x-hive-if-match": "optional",
        "x-hive-owner": "GRAPH-HIER",
        "x-hive-permission": "asset.update",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 3,
        "x-hive-stability": "stable"
      }
    },
    "/v1/assets/{id}/move": {
      "post": {
        "description": "Moves an asset with its whole subtree under another parent in one step. It needs If-Match with the current version. The caller needs asset.move on the old and on the new parent. A new parent inside the subtree answers 422 move_cycle. Moving more than 2,000 assets answers 202 with an operation.",
        "operationId": "asset_move",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/AssetPath"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/IfMatch"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AssetMove"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Asset"
                }
              }
            },
            "description": "The moved asset",
            "headers": {
              "ETag": {
                "$ref": "#/components/headers/ETag"
              },
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "202": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AssetOperationAccepted"
                }
              }
            },
            "description": "The move runs as an operation",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              },
              "Location": {
                "description": "The URL of the operation that carries out the change (API-LRO).",
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Move an asset",
        "x-hive-async": true,
        "x-hive-data-class": "tenant_operational",
        "x-hive-errors": [
          "conflict",
          "not_found",
          "permission_denied",
          "precondition_failed",
          "precondition_required",
          "unavailable",
          "version_mismatch"
        ],
        "x-hive-idempotency": "optional",
        "x-hive-if-match": "required",
        "x-hive-owner": "GRAPH-HIER",
        "x-hive-permission": "asset.move",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 5,
        "x-hive-stability": "stable"
      }
    },
    "/v1/assets/{id}/restore": {
      "post": {
        "description": "Brings a deleted asset and the assets that were deleted with it back. It fails with 409 when its key was taken meanwhile or its parent is deleted.",
        "operationId": "asset_restore",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/AssetPath"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Asset"
                }
              }
            },
            "description": "The restored asset",
            "headers": {
              "ETag": {
                "$ref": "#/components/headers/ETag"
              },
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Restore a deleted asset",
        "x-hive-data-class": "tenant_operational",
        "x-hive-errors": [
          "conflict",
          "not_found",
          "permission_denied",
          "unavailable"
        ],
        "x-hive-idempotency": "optional",
        "x-hive-owner": "GRAPH-HIER",
        "x-hive-permission": "asset.delete",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 3,
        "x-hive-stability": "stable"
      }
    },
    "/v1/assets/{id}/shift-at": {
      "get": {
        "description": "The shift that runs at an instant for a site (DATA-TIME-R-021): a shift belongs to the local date on which it starts, windows are half-open and an instant on a boundary belongs to the later shift. With no shift at that instant shift_key and the window are null. The instant needs a numeric offset or Z; one without an offset answers 400 with timestamp_requires_offset (DATA-TIME-R-002).",
        "operationId": "asset_get_shift_at",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/ShiftSitePath"
          },
          {
            "$ref": "#/components/parameters/ShiftAt"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShiftWindow"
                }
              }
            },
            "description": "The shift window, or nulls",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Read the shift at an instant",
        "x-hive-data-class": "tenant_operational",
        "x-hive-errors": [
          "invalid_request",
          "not_found",
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-owner": "DATA-TIME",
        "x-hive-permission": "shift.read",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      }
    },
    "/v1/assets/{id}/shift-windows": {
      "get": {
        "description": "The shifts of a site that start on a local date from from_on to to_on, both inclusive, at most 62 days, ordered by start. The duration of a window is its real elapsed time: a night shift is 9 or 7 hours on a transition night (DATA-TIME-R-022). The list is never paged.",
        "operationId": "asset_get_shift_windows",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/ShiftSitePath"
          },
          {
            "$ref": "#/components/parameters/ShiftFromOn"
          },
          {
            "$ref": "#/components/parameters/ShiftToOn"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShiftWindowList"
                }
              }
            },
            "description": "The shift windows",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "List the shift windows of a site",
        "x-hive-data-class": "tenant_operational",
        "x-hive-errors": [
          "invalid_request",
          "not_found",
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-owner": "DATA-TIME",
        "x-hive-permission": "shift.list",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      }
    },
    "/v1/assets/{id}/tree": {
      "get": {
        "description": "The asset and its descendants as nested JSON, siblings ordered by sort order and name. At most 2,000 nodes; a larger tree answers 400, read it with descendants instead.",
        "operationId": "asset_get_tree",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/AssetPath"
          },
          {
            "$ref": "#/components/parameters/AssetTreeDepth"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AssetTree"
                }
              }
            },
            "description": "The tree",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Read a nested tree",
        "x-hive-data-class": "tenant_operational",
        "x-hive-errors": [
          "invalid_request",
          "not_found",
          "permission_denied",
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-owner": "GRAPH-HIER",
        "x-hive-permission": "asset.list",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      }
    },
    "/v1/asyncapi.json": {
      "get": {
        "description": "The AsyncAPI 3 document of the public events and webhooks of the latest released dated version, or of the version in the query parameter. Public, unauthenticated, cacheable.",
        "operationId": "asyncapi_document_retrieve",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/SpecVersion"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AsyncApiDocument"
                }
              }
            },
            "description": "The document, without internal operations, tenant data or secrets",
            "headers": {
              "Cache-Control": {
                "$ref": "#/components/headers/CacheControl"
              },
              "ETag": {
                "$ref": "#/components/headers/ETag"
              },
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "304": {
            "description": "The document did not change",
            "headers": {
              "ETag": {
                "$ref": "#/components/headers/ETag"
              },
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "The AsyncAPI document",
        "x-hive-cacheable": true,
        "x-hive-data-class": "public",
        "x-hive-errors": [
          "unsupported_version",
          "not_found"
        ],
        "x-hive-idempotency": "none",
        "x-hive-isolation": "none",
        "x-hive-owner": "API-GOV",
        "x-hive-permission": "none",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      }
    },
    "/v1/clock-statuses": {
      "get": {
        "description": "The clock status of the gateways and connections of the tenant: the state, since when, and the measured offset (DATA-TIME-R-010). Filter by state and source_kind. A gateway status is gateway minus cloud time; a connection status is the median of the gateway time minus the source time of its live samples.",
        "operationId": "clock_status_list",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/Limit"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClockStatusList"
                }
              }
            },
            "description": "A page of clock statuses",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "List the clock statuses",
        "x-hive-data-class": "tenant_operational",
        "x-hive-default-sort": "-state_since",
        "x-hive-errors": [
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-owner": "DATA-TIME",
        "x-hive-permission": "clock_status.read",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      }
    },
    "/v1/clock-statuses/{id}": {
      "get": {
        "description": "The clock status of one gateway or connection of the tenant. The ID is the gwy or cnx ID. An ID of another tenant, or an unknown one, answers 404 not_found (DATA-TIME-R-029).",
        "operationId": "clock_status_get",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/ClockStatusPath"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClockStatus"
                }
              }
            },
            "description": "The clock status",
            "headers": {
              "ETag": {
                "$ref": "#/components/headers/ETag"
              },
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Get a clock status",
        "x-hive-data-class": "tenant_operational",
        "x-hive-errors": [
          "not_found",
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-owner": "DATA-TIME",
        "x-hive-permission": "clock_status.read",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      }
    },
    "/v1/clock-statuses/{id}/exceptions": {
      "get": {
        "description": "The bounded log of timestamps that ingest replaced by the gateway time (the first 100 per connection per hour): the value as received, the value stored, the verdict and the signal (DATA-TIME-R-012). A gateway has no exceptions of its own: its list is empty.",
        "operationId": "clock_status_get_exceptions",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/ClockStatusPath"
          },
          {
            "$ref": "#/components/parameters/Limit"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TimeExceptionList"
                }
              }
            },
            "description": "A page of exceptions",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "List the substituted timestamps of a connection",
        "x-hive-data-class": "tenant_operational",
        "x-hive-default-sort": "-t_ingest",
        "x-hive-errors": [
          "not_found",
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-owner": "DATA-TIME",
        "x-hive-permission": "time_exception.read",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      }
    },
    "/v1/health": {
      "get": {
        "operationId": "api_health_read",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Health"
                }
              }
            },
            "description": "Process is live",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "API health",
        "x-hive-data-class": "public",
        "x-hive-errors": [],
        "x-hive-idempotency": "none",
        "x-hive-isolation": "none",
        "x-hive-owner": "API-STD",
        "x-hive-permission": "none",
        "x-hive-rate-class": "critical",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      }
    },
    "/v1/integrations/secret-scanning/github": {
      "post": {
        "description": "The endpoint for the secret scanning partner programme of GitHub. The signature of the request, checked against the published public keys of the partner, is the authentication; a request without a valid signature answers 401. A reported token that is a live API key is revoked, marked compromised and reported to the security admins (IAM-KEYS-R-017). The format of the answer is the one of the partner programme and is to be verified against its current documentation.",
        "operationId": "integration_secret_scanning_github",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SecretScanningReport"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SecretScanningResult"
                }
              }
            },
            "description": "The verdict for each token",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Receive a secret scanning report",
        "x-hive-data-class": "public",
        "x-hive-errors": [
          "unauthenticated",
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-isolation": "none",
        "x-hive-owner": "IAM-KEYS",
        "x-hive-permission": "none",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 2,
        "x-hive-stability": "stable"
      }
    },
    "/v1/me/tenants": {
      "get": {
        "description": "The tenants the calling user has an active membership of, for choosing the Hive-Tenant of later requests. A user credential only; no tenant is selected. Served by the global plane (TEN-MODEL-R-015).",
        "operationId": "me_get_tenants",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MeTenantList"
                }
              }
            },
            "description": "The caller's tenants",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "List the tenants of the caller",
        "x-hive-data-class": "personal",
        "x-hive-errors": [
          "principal_not_allowed",
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-isolation": "none",
        "x-hive-owner": "TEN-MODEL",
        "x-hive-permission": "me.read",
        "x-hive-principals": [
          "user"
        ],
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      }
    },
    "/v1/memberships": {
      "get": {
        "description": "Who belongs to the tenant, with status and source. Only this tenant's memberships are visible; nothing reveals another tenant of the same user (TEN-MODEL-R-020).",
        "operationId": "membership_list",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/Limit"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MembershipList"
                }
              }
            },
            "description": "A page of memberships",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "List the memberships of the current tenant",
        "x-hive-data-class": "personal",
        "x-hive-default-sort": "-created_at",
        "x-hive-errors": [
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-owner": "TEN-MODEL",
        "x-hive-permission": "membership.list",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      }
    },
    "/v1/memberships/{user_id}": {
      "patch": {
        "description": "Sets the status of one membership of the current tenant to suspended or active. The directory is changed first and the cells follow within seconds (TEN-MODEL-R-023). Removal of a user goes through IAM-SSO.",
        "operationId": "membership_update",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/MembershipUserId"
          },
          {
            "$ref": "#/components/parameters/IfMatch"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MembershipUpdate"
              }
            },
            "application/merge-patch+json": {
              "schema": {
                "$ref": "#/components/schemas/MembershipUpdate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Membership"
                }
              }
            },
            "description": "The updated membership",
            "headers": {
              "ETag": {
                "$ref": "#/components/headers/ETag"
              },
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Suspend or reactivate a membership",
        "x-hive-data-class": "personal",
        "x-hive-errors": [
          "not_found",
          "version_mismatch",
          "conflict",
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-if-match": "optional",
        "x-hive-owner": "TEN-MODEL",
        "x-hive-permission": "membership.update",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 2,
        "x-hive-stability": "stable"
      }
    },
    "/v1/openapi.json": {
      "get": {
        "description": "The bundled OpenAPI 3.1 document of the latest released dated version, or of the version in the query parameter. Public, unauthenticated, cacheable.",
        "operationId": "openapi_document_retrieve",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/SpecVersion"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OpenApiDocument"
                }
              }
            },
            "description": "The document, without internal operations, tenant data or secrets",
            "headers": {
              "Cache-Control": {
                "$ref": "#/components/headers/CacheControl"
              },
              "ETag": {
                "$ref": "#/components/headers/ETag"
              },
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "304": {
            "description": "The document did not change",
            "headers": {
              "ETag": {
                "$ref": "#/components/headers/ETag"
              },
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "The OpenAPI document",
        "x-hive-cacheable": true,
        "x-hive-data-class": "public",
        "x-hive-errors": [
          "unsupported_version",
          "not_found"
        ],
        "x-hive-idempotency": "none",
        "x-hive-isolation": "none",
        "x-hive-owner": "API-GOV",
        "x-hive-permission": "none",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      }
    },
    "/v1/quantity-kinds": {
      "get": {
        "description": "The kinds that say which units may be converted into each other, with the units each lists, its canonical unit and its default number of decimals (DATA-UNITS-R-004, R-021).",
        "operationId": "quantity_kind_list",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/QuantityKindList"
                }
              }
            },
            "description": "The quantity kinds",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "List the quantity kinds of the registry",
        "x-hive-data-class": "public",
        "x-hive-errors": [
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-owner": "DATA-UNITS",
        "x-hive-permission": "unit.read",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      }
    },
    "/v1/service-accounts": {
      "get": {
        "description": "The service accounts of the tenant, newest first.",
        "operationId": "service_account_list",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/Limit"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceAccountList"
                }
              }
            },
            "description": "A page of service accounts",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "List the service accounts",
        "x-hive-data-class": "personal",
        "x-hive-default-sort": "-created_at",
        "x-hive-errors": [
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-owner": "IAM-KEYS",
        "x-hive-permission": "service_account.list",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      },
      "post": {
        "description": "Creates a service account with no permission at all. Grants come from IAM-AUTHZ (IAM-KEYS-R-012). A name already used by a live account of the tenant answers 409.",
        "operationId": "service_account_create",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ServiceAccountCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceAccount"
                }
              }
            },
            "description": "The new service account",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              },
              "Location": {
                "description": "The URL of the new service account.",
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Create a service account",
        "x-hive-data-class": "personal",
        "x-hive-errors": [
          "conflict",
          "limit_exceeded",
          "permission_denied",
          "unavailable"
        ],
        "x-hive-idempotency": "optional",
        "x-hive-owner": "IAM-KEYS",
        "x-hive-permission": "service_account.create",
        "x-hive-principals": [
          "user"
        ],
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 2,
        "x-hive-stability": "stable"
      }
    },
    "/v1/service-accounts/{id}": {
      "delete": {
        "description": "Revokes every key of the account, removes its grants and deletes the account. The name is free again.",
        "operationId": "service_account_delete",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/ServiceAccountPath"
          },
          {
            "$ref": "#/components/parameters/IfMatch"
          }
        ],
        "responses": {
          "204": {
            "description": "The service account is deleted",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Delete a service account",
        "x-hive-data-class": "personal",
        "x-hive-errors": [
          "not_found",
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-if-match": "optional",
        "x-hive-owner": "IAM-KEYS",
        "x-hive-permission": "service_account.delete",
        "x-hive-principals": [
          "user"
        ],
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 2,
        "x-hive-stability": "stable"
      },
      "get": {
        "description": "One service account of the tenant.",
        "operationId": "service_account_get",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/ServiceAccountPath"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceAccount"
                }
              }
            },
            "description": "The service account",
            "headers": {
              "ETag": {
                "$ref": "#/components/headers/ETag"
              },
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Get a service account",
        "x-hive-data-class": "personal",
        "x-hive-errors": [
          "not_found",
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-owner": "IAM-KEYS",
        "x-hive-permission": "service_account.get",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      },
      "patch": {
        "description": "Changes the name, the description, the owner, or enables a disabled account.",
        "operationId": "service_account_update",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/ServiceAccountPath"
          },
          {
            "$ref": "#/components/parameters/IfMatch"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ServiceAccountUpdate"
              }
            },
            "application/merge-patch+json": {
              "schema": {
                "$ref": "#/components/schemas/ServiceAccountUpdate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceAccount"
                }
              }
            },
            "description": "The updated service account",
            "headers": {
              "ETag": {
                "$ref": "#/components/headers/ETag"
              },
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Change a service account",
        "x-hive-data-class": "personal",
        "x-hive-errors": [
          "not_found",
          "version_mismatch",
          "conflict",
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-if-match": "optional",
        "x-hive-owner": "IAM-KEYS",
        "x-hive-permission": "service_account.update",
        "x-hive-principals": [
          "user"
        ],
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 2,
        "x-hive-stability": "stable"
      }
    },
    "/v1/service-accounts/{id}/disable": {
      "post": {
        "description": "All keys and tokens of the account stop working at once. Enable the account again with an update.",
        "operationId": "service_account_disable",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/ServiceAccountPath"
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceAccount"
                }
              }
            },
            "description": "The disabled service account",
            "headers": {
              "ETag": {
                "$ref": "#/components/headers/ETag"
              },
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Disable a service account",
        "x-hive-data-class": "personal",
        "x-hive-errors": [
          "not_found",
          "unavailable"
        ],
        "x-hive-idempotency": "optional",
        "x-hive-owner": "IAM-KEYS",
        "x-hive-permission": "service_account.disable",
        "x-hive-principals": [
          "user"
        ],
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 2,
        "x-hive-stability": "stable"
      }
    },
    "/v1/sites": {
      "get": {
        "description": "The site profiles of the current tenant: time zone, country and address of each site (TEN-MODEL-R-004).",
        "operationId": "site_list",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteProfileList"
                }
              }
            },
            "description": "The site profiles",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "List the site profiles",
        "x-hive-data-class": "tenant_operational",
        "x-hive-errors": [
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-owner": "TEN-MODEL",
        "x-hive-permission": "site.list",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      }
    },
    "/v1/sites/{id}": {
      "patch": {
        "description": "Sets the time zone, country or address of a site. The site must be an asset of kind site; a time zone that is not in the IANA database is refused with a 400 (TEN-MODEL-R-004).",
        "operationId": "site_update",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/SiteId"
          },
          {
            "$ref": "#/components/parameters/IfMatch"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SiteProfileUpdate"
              }
            },
            "application/merge-patch+json": {
              "schema": {
                "$ref": "#/components/schemas/SiteProfileUpdate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteProfile"
                }
              }
            },
            "description": "The site profile",
            "headers": {
              "ETag": {
                "$ref": "#/components/headers/ETag"
              },
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Create or update a site profile",
        "x-hive-data-class": "tenant_operational",
        "x-hive-errors": [
          "not_found",
          "version_mismatch",
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-if-match": "optional",
        "x-hive-owner": "TEN-MODEL",
        "x-hive-permission": "site.update",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 2,
        "x-hive-stability": "stable"
      }
    },
    "/v1/tenants/current": {
      "get": {
        "description": "The tenant the request acts in: handle, display name, state, language, cell, region, contract and API version (TEN-MODEL-R-003).",
        "operationId": "tenant_get_current",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Tenant"
                }
              }
            },
            "description": "The tenant",
            "headers": {
              "ETag": {
                "$ref": "#/components/headers/ETag"
              },
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Retrieve the current tenant",
        "x-hive-data-class": "tenant_confidential",
        "x-hive-errors": [
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-owner": "TEN-MODEL",
        "x-hive-permission": "tenant.read",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      },
      "patch": {
        "description": "Changes the display name or the default language. The handle, the ID and the state cannot be changed; an unknown field is a 400. Send the version in If-Match (TEN-MODEL-R-014, R-019).",
        "operationId": "tenant_update_current",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/IfMatch"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TenantUpdate"
              }
            },
            "application/merge-patch+json": {
              "schema": {
                "$ref": "#/components/schemas/TenantUpdate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Tenant"
                }
              }
            },
            "description": "The updated tenant",
            "headers": {
              "ETag": {
                "$ref": "#/components/headers/ETag"
              },
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Update the current tenant",
        "x-hive-data-class": "tenant_confidential",
        "x-hive-errors": [
          "not_found",
          "version_mismatch",
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-if-match": "optional",
        "x-hive-owner": "TEN-MODEL",
        "x-hive-permission": "tenant.update",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 2,
        "x-hive-stability": "stable"
      }
    },
    "/v1/tenants/{id}": {
      "get": {
        "description": "Only the tenant of the request can be read here: the ID is compared with the context and nothing else, so any other ID answers 404 exactly as a missing one does (TEN-MODEL-R-014).",
        "operationId": "tenant_get",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/TenantPath"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Tenant"
                }
              }
            },
            "description": "The tenant",
            "headers": {
              "ETag": {
                "$ref": "#/components/headers/ETag"
              },
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Retrieve a tenant by ID",
        "x-hive-data-class": "tenant_confidential",
        "x-hive-errors": [
          "not_found",
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-owner": "TEN-MODEL",
        "x-hive-permission": "tenant.read",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      }
    },
    "/v1/time": {
      "get": {
        "description": "The time of the cloud as the API sees it, in UTC with Z, the release of the time zone data in use (tzdata_version) and the default time zone of a site. Clients use it to judge their own clock (DATA-TIME-R-024). It touches no tenant data.",
        "operationId": "time_get",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServerTime"
                }
              }
            },
            "description": "The cloud time",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Read the cloud time",
        "x-hive-data-class": "public",
        "x-hive-errors": [
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-isolation": "none",
        "x-hive-owner": "DATA-TIME",
        "x-hive-permission": "time.read",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      }
    },
    "/v1/unit-preferences": {
      "get": {
        "description": "The display units of the current tenant. The document exists from the first request: a tenant that never chose gets the defaults (no display units, colloquial style) at version 1.",
        "operationId": "unit_preference_get",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UnitPreferences"
                }
              }
            },
            "description": "The unit preferences",
            "headers": {
              "ETag": {
                "$ref": "#/components/headers/ETag"
              },
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Retrieve the unit preferences of the tenant",
        "x-hive-data-class": "tenant_operational",
        "x-hive-errors": [
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-owner": "DATA-UNITS",
        "x-hive-permission": "unit_preference.read",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      },
      "patch": {
        "description": "Sets the display units and the rotational speed style of the tenant. A member that is sent replaces that member as a whole: display_units is the complete map, a kind that is left out goes back to its canonical unit. Send the version in If-Match (required). A key that is not a quantity kind, or a unit that is not one of its kind, is refused with 400 and the reason unit_not_in_kind; nothing is stored then (DATA-UNITS-R-015).",
        "operationId": "unit_preference_update",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/IfMatch"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UnitPreferencesUpdate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UnitPreferences"
                }
              }
            },
            "description": "The changed unit preferences",
            "headers": {
              "ETag": {
                "$ref": "#/components/headers/ETag"
              },
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Change the unit preferences of the tenant",
        "x-hive-data-class": "tenant_operational",
        "x-hive-errors": [
          "version_mismatch",
          "precondition_required",
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-if-match": "required",
        "x-hive-max-body": 1024,
        "x-hive-owner": "DATA-UNITS",
        "x-hive-permission": "unit_preference.update",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 2,
        "x-hive-stability": "stable"
      }
    },
    "/v1/units": {
      "get": {
        "description": "The units HIVE accepts, with the quantity kinds that list each and the labels in German and English. The registry is global reference data and the same for every tenant (DATA-UNITS-R-021, R-024). kind narrows the list to one quantity kind. The list is never paged: there are fewer than a hundred units.",
        "operationId": "unit_list",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          },
          {
            "$ref": "#/components/parameters/UnitsKind"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UnitList"
                }
              }
            },
            "description": "The units",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "List the units of the registry",
        "x-hive-data-class": "public",
        "x-hive-errors": [
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-owner": "DATA-UNITS",
        "x-hive-permission": "unit.read",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      }
    },
    "/v1/units/convert": {
      "post": {
        "description": "Converts one value exactly (relative error at most 1e-12). Affine units (Cel, [degF]) use their offset. A conversion between units that share no kind, or whose named kinds differ, answers 422 precondition_failed with unit_incompatible and converts nothing. Units are matched exactly and case-sensitively; an alias such as rpm or Bar is refused with 400 and never corrected (DATA-UNITS-R-002, R-003, R-005, R-007).",
        "operationId": "unit_convert",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UnitConvertRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UnitConversion"
                }
              }
            },
            "description": "The converted value",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Convert a value between two units",
        "x-hive-data-class": "public",
        "x-hive-errors": [
          "precondition_failed",
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-max-body": 1024,
        "x-hive-owner": "DATA-UNITS",
        "x-hive-permission": "unit.read",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      }
    },
    "/v1/units/format": {
      "post": {
        "description": "Writes a value and a unit the way a person of the locale reads it: decimal comma and dotted grouping in German, U+00A0 between number and unit, the registry's own unit labels. Only the text is rounded. A locale that is not supported falls back to its language, then to en, and the response names the locale used (DATA-UNITS-R-011 to R-013, R-016).",
        "operationId": "unit_format",
        "parameters": [
          {
            "$ref": "#/components/parameters/HiveVersion"
          },
          {
            "$ref": "#/components/parameters/HiveClientRequestId"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UnitFormatRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FormattedQuantity"
                }
              }
            },
            "description": "The formatted quantity",
            "headers": {
              "Hive-Request-Id": {
                "$ref": "#/components/headers/HiveRequestId"
              },
              "Hive-Version": {
                "$ref": "#/components/headers/HiveVersion"
              }
            }
          },
          "default": {
            "$ref": "#/components/responses/Problem"
          }
        },
        "summary": "Format a quantity for a person",
        "x-hive-data-class": "public",
        "x-hive-errors": [
          "unavailable"
        ],
        "x-hive-idempotency": "none",
        "x-hive-max-body": 1024,
        "x-hive-owner": "DATA-UNITS",
        "x-hive-permission": "unit.read",
        "x-hive-rate-class": "interactive",
        "x-hive-rate-cost": 1,
        "x-hive-stability": "stable"
      }
    }
  }
}
