ENTITY developer reference
UsageHeadroom
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.
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.
method_revision
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for method_revision
{
"const": "usage-headroom-0.1"
}eligible_available_units
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for eligible_available_units
{
"$ref": "#/components/schemas/Units"
}limits
Listed in this schema’s required array.
- Declared type
"array"
Reading definition for limits
{
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageBudgetHeadroom"
},
"minItems": 1,
"maxItems": 8,
"x-profile-maxItems": "collection_items_max"
}service_admission
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for service_admission
{
"type": "string",
"enum": [
"available",
"temporarily_unavailable"
],
"x-profile-maxLength": "string_characters_max"
}meaning
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for meaning
{
"const": "snapshot_not_reservation_or_duration_eligibility"
}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.
{
"type": "object",
"properties": {
"method_revision": {
"const": "usage-headroom-0.1"
},
"eligible_available_units": {
"$ref": "#/components/schemas/Units"
},
"limits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageBudgetHeadroom"
},
"minItems": 1,
"maxItems": 8,
"x-profile-maxItems": "collection_items_max"
},
"service_admission": {
"type": "string",
"enum": [
"available",
"temporarily_unavailable"
],
"x-profile-maxLength": "string_characters_max"
},
"meaning": {
"const": "snapshot_not_reservation_or_duration_eligibility"
}
},
"required": [
"method_revision",
"eligible_available_units",
"limits",
"service_admission",
"meaning"
],
"additionalProperties": false
}