ENTITY developer reference
ICVersionRef
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.
id
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for id
{
"type": "string",
"minLength": 1,
"maxLength": 120,
"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
}digest
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for digest
{
"type": "string",
"pattern": "^[a-f0-9]{64}$",
"x-profile-maxLength": "string_characters_max"
}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": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 120,
"x-profile-maxLength": "string_characters_max"
},
"revision": {
"type": "integer",
"minimum": 1
},
"digest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$",
"x-profile-maxLength": "string_characters_max"
}
},
"required": [
"id",
"revision",
"digest"
],
"additionalProperties": false
}