Sustema

ENTITY developer reference

RecoveryGuidance

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.

Safe guidance only. Paths are rooted at InputReference. Repeated/revised work requires explicit customer action or an already authorised client policy and remaining server budget; guidance grants no authority. No raw customer/source values or protected existence disclosures.

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_revision

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for policy_revision
{
  "const": "recovery-0.1"
}

actions

Listed in this schema’s required array.

Declared type
"array"
Reading definition for actions
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/RecoveryAction"
  },
  "maxItems": 7,
  "x-profile-maxItems": "collection_items_max"
}

automatic_retry_allowed

Listed in this schema’s required array.

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

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": {
    "policy_revision": {
      "const": "recovery-0.1"
    },
    "actions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/RecoveryAction"
      },
      "maxItems": 7,
      "x-profile-maxItems": "collection_items_max"
    },
    "automatic_retry_allowed": {
      "const": false
    }
  },
  "required": [
    "policy_revision",
    "actions",
    "automatic_retry_allowed"
  ],
  "additionalProperties": false,
  "description": "Safe guidance only. Paths are rooted at InputReference. Repeated/revised work requires explicit customer action or an already authorised client policy and remaining server budget; guidance grants no authority. No raw customer/source values or protected existence disclosures."
}

Related schemas

All API operations