ENTITY developer reference
Publication
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.
manifest_id
Listed in this schema’s required array.
- Declared type
"string"- Declared format
"uuid"
Reading definition for manifest_id
{
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
}published_at
Listed in this schema’s required array.
- Declared type
"string"- Declared format
"date-time"
Reading definition for published_at
{
"type": "string",
"format": "date-time",
"x-profile-maxLength": "string_characters_max"
}identity_revision
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for identity_revision
{
"type": "string",
"x-profile-maxLength": "string_characters_max"
}source_checkpoint_refs
Listed in this schema’s required array.
- Declared type
"array"
Reading definition for source_checkpoint_refs
{
"type": "array",
"items": {
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
"x-profile-maxItems": "collection_items_max"
}policy_revision
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for policy_revision
{
"type": "string",
"x-profile-maxLength": "string_characters_max"
}relationship_revision
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for relationship_revision
{
"anyOf": [
{
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
}classification_revision
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for classification_revision
{
"anyOf": [
{
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
}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": {
"manifest_id": {
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
},
"published_at": {
"type": "string",
"format": "date-time",
"x-profile-maxLength": "string_characters_max"
},
"identity_revision": {
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
"source_checkpoint_refs": {
"type": "array",
"items": {
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
"x-profile-maxItems": "collection_items_max"
},
"policy_revision": {
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
"relationship_revision": {
"anyOf": [
{
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
},
"classification_revision": {
"anyOf": [
{
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
}
},
"required": [
"manifest_id",
"published_at",
"identity_revision",
"source_checkpoint_refs",
"policy_revision",
"relationship_revision",
"classification_revision"
],
"additionalProperties": false
}