Sustema

ENTITY developer reference

Freshness

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.

Age interval ordering, clock revision consistency, precision/timezone and policy boundaries require semantic validation. Unknown may include a usable but indeterminate basis.

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.

state

Listed in this schema’s required array.

Declared type
"string"
Reading definition for state
{
  "type": "string",
  "enum": [
    "within_profile",
    "stale_but_permitted",
    "unknown"
  ],
  "x-profile-maxLength": "string_characters_max"
}

age_basis

Listed in this schema’s required array.

Declared type
"string"
Reading definition for age_basis
{
  "type": "string",
  "enum": [
    "source_published",
    "acquired",
    "verified",
    "unknown"
  ],
  "x-profile-maxLength": "string_characters_max"
}

age_min_seconds

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for age_min_seconds
{
  "anyOf": [
    {
      "type": "integer",
      "minimum": 0
    },
    {
      "type": "null"
    }
  ]
}

age_max_seconds

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for age_max_seconds
{
  "anyOf": [
    {
      "type": "integer",
      "minimum": 0
    },
    {
      "type": "null"
    }
  ]
}

evaluated_at

Listed in this schema’s required array.

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

policy_revision

Listed in this schema’s required array.

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

basis

Not listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for basis
{
  "$ref": "#/components/schemas/FreshnessBasis"
}

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": {
    "state": {
      "type": "string",
      "enum": [
        "within_profile",
        "stale_but_permitted",
        "unknown"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "age_basis": {
      "type": "string",
      "enum": [
        "source_published",
        "acquired",
        "verified",
        "unknown"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "age_min_seconds": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 0
        },
        {
          "type": "null"
        }
      ]
    },
    "age_max_seconds": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 0
        },
        {
          "type": "null"
        }
      ]
    },
    "evaluated_at": {
      "type": "string",
      "format": "date-time",
      "x-profile-maxLength": "string_characters_max"
    },
    "policy_revision": {
      "type": "string",
      "minLength": 1,
      "x-profile-maxLength": "string_characters_max"
    },
    "basis": {
      "$ref": "#/components/schemas/FreshnessBasis"
    }
  },
  "required": [
    "state",
    "age_basis",
    "age_min_seconds",
    "age_max_seconds",
    "evaluated_at",
    "policy_revision"
  ],
  "additionalProperties": false,
  "allOf": [
    {
      "if": {
        "properties": {
          "state": {
            "enum": [
              "within_profile",
              "stale_but_permitted"
            ]
          }
        },
        "required": [
          "state"
        ]
      },
      "then": {
        "required": [
          "basis"
        ],
        "properties": {
          "age_basis": {
            "type": "string",
            "enum": [
              "source_published",
              "acquired",
              "verified"
            ],
            "x-profile-maxLength": "string_characters_max"
          },
          "age_min_seconds": {
            "type": "integer",
            "minimum": 0
          },
          "age_max_seconds": {
            "type": "integer",
            "minimum": 0
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "age_basis": {
            "const": "unknown"
          }
        },
        "required": [
          "age_basis"
        ]
      },
      "then": {
        "properties": {
          "state": {
            "const": "unknown"
          },
          "age_min_seconds": {
            "type": "null"
          },
          "age_max_seconds": {
            "type": "null"
          }
        },
        "not": {
          "required": [
            "basis"
          ]
        }
      }
    },
    {
      "if": {
        "properties": {
          "age_basis": {
            "const": "source_published"
          }
        },
        "required": [
          "age_basis"
        ]
      },
      "then": {
        "required": [
          "basis"
        ],
        "properties": {
          "basis": {
            "properties": {
              "clock_field": {
                "const": "source_published"
              }
            }
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "age_basis": {
            "const": "acquired"
          }
        },
        "required": [
          "age_basis"
        ]
      },
      "then": {
        "required": [
          "basis"
        ],
        "properties": {
          "basis": {
            "properties": {
              "clock_field": {
                "const": "acquired"
              }
            }
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "age_basis": {
            "const": "verified"
          }
        },
        "required": [
          "age_basis"
        ]
      },
      "then": {
        "required": [
          "basis"
        ],
        "properties": {
          "basis": {
            "properties": {
              "clock_field": {
                "const": "verified"
              }
            }
          }
        }
      }
    }
  ],
  "description": "Age interval ordering, clock revision consistency, precision/timezone and policy boundaries require semantic validation. Unknown may include a usable but indeterminate basis."
}

Related schemas

All API operations