Sustema

ENTITY developer reference

PackagePolicy

Candidate documentation for reading and synthetic examples. Account creation, live API access, SDKs, collections and MCP are not available here. A released service profile and matching integration instructions are required before use.

This is a documentation reading view of an unreleased candidate, not a downloadable replacement schema. Public wire names, types and constraints are retained except for the explicitly marked private-only subsets and route patterns. Private governance references are explained in public language. Use only a separately released, verified generation for clients. Read the explicit exclusions.

PackagePolicy: its retained title says it is not current UsageResult, while UsageResult requires package_policy. Follow the explicit required property and its referenced structure; the stale title does not make the field optional.

This is the public candidate schema reading view. Read it with the operation that uses it; a representable field does not establish enabled coverage or entitlement.

Declared type: "object"

Declared fields

This list shows only properties declared directly in this schema. Required labels refer only to this schema’s own required array. Referenced, composed and conditional rules can add constraints; a field not listed as required here is not guaranteed to be optional.

policy_id

Listed in this schema’s required array.

Declared type
"string"
Reading definition for policy_id
{
  "type": "string",
  "minLength": 1,
  "x-profile-maxLength": "string_characters_max"
}

revision

Listed in this schema’s required array.

Declared type
"integer"
Reading definition for revision
{
  "type": "integer",
  "minimum": 1
}

effective_from

Listed in this schema’s required array.

Declared type
"string"
Declared format
"date-time"
Reading definition for effective_from
{
  "type": "string",
  "format": "date-time",
  "x-profile-maxLength": "string_characters_max"
}

effective_until

Listed in this schema’s required array.

Declared type
"string"
Declared format
"date-time"
Reading definition for effective_until
{
  "type": "string",
  "format": "date-time",
  "x-profile-maxLength": "string_characters_max"
}

aggregation

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for aggregation
{
  "const": "workspace_environment"
}

period_boundary_resets_rate

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for period_boundary_resets_rate
{
  "const": false
}

work

Listed in this schema’s required array.

Declared type
"object"
Reading definition for work
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "bucket": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "algorithm": {
          "const": "token_bucket"
        },
        "requests_per_second": {
          "type": "integer",
          "minimum": 1
        },
        "burst_requests": {
          "type": "integer",
          "minimum": 1
        }
      },
      "required": [
        "algorithm",
        "requests_per_second",
        "burst_requests"
      ]
    },
    "concurrent_work_max": {
      "type": "integer",
      "minimum": 1
    }
  },
  "required": [
    "bucket",
    "concurrent_work_max"
  ]
}

recovery

Listed in this schema’s required array.

Declared type
"object"
Reading definition for recovery
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "bucket": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "algorithm": {
          "const": "token_bucket"
        },
        "requests_per_second": {
          "type": "integer",
          "minimum": 1
        },
        "burst_requests": {
          "type": "integer",
          "minimum": 1
        }
      },
      "required": [
        "algorithm",
        "requests_per_second",
        "burst_requests"
      ]
    },
    "requires_work_allowance": {
      "const": false
    }
  },
  "required": [
    "bucket",
    "requires_work_allowance"
  ]
}

Schema reading view

Read all retained constraints, including any allOf, oneOf, anyOf, conditional and additional-property constraints. The field list does not combine branches. Explicitly marked private-only omissions mean this view is not an executable substitute for the original schema or a released contract.

{
  "title": "Proposed public package-policy projection, not current UsageResult",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "policy_id": {
      "type": "string",
      "minLength": 1,
      "x-profile-maxLength": "string_characters_max"
    },
    "revision": {
      "type": "integer",
      "minimum": 1
    },
    "effective_from": {
      "type": "string",
      "format": "date-time",
      "x-profile-maxLength": "string_characters_max"
    },
    "effective_until": {
      "type": "string",
      "format": "date-time",
      "x-profile-maxLength": "string_characters_max"
    },
    "aggregation": {
      "const": "workspace_environment"
    },
    "period_boundary_resets_rate": {
      "const": false
    },
    "work": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "bucket": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "algorithm": {
              "const": "token_bucket"
            },
            "requests_per_second": {
              "type": "integer",
              "minimum": 1
            },
            "burst_requests": {
              "type": "integer",
              "minimum": 1
            }
          },
          "required": [
            "algorithm",
            "requests_per_second",
            "burst_requests"
          ]
        },
        "concurrent_work_max": {
          "type": "integer",
          "minimum": 1
        }
      },
      "required": [
        "bucket",
        "concurrent_work_max"
      ]
    },
    "recovery": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "bucket": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "algorithm": {
              "const": "token_bucket"
            },
            "requests_per_second": {
              "type": "integer",
              "minimum": 1
            },
            "burst_requests": {
              "type": "integer",
              "minimum": 1
            }
          },
          "required": [
            "algorithm",
            "requests_per_second",
            "burst_requests"
          ]
        },
        "requires_work_allowance": {
          "const": false
        }
      },
      "required": [
        "bucket",
        "requires_work_allowance"
      ]
    }
  },
  "required": [
    "policy_id",
    "revision",
    "effective_from",
    "effective_until",
    "aggregation",
    "period_boundary_resets_rate",
    "work",
    "recovery"
  ]
}

All API operations