Schemas

Canonical schema artifacts generated by arxi-contract.

Download: schemas/envelope.schema.json (2.5 KB) Download: schemas/segment.schema.json (1014 B) Download: schemas/bundle.schema.json (8.3 KB)

envelope.schema.json

{"$id":"https://arxi.dev/contracts/v1/schemas/envelope.schema.json","$schema":"https://json-schema.org/draft/2020-12/schema","additionalProperties":false,"properties":{"actor_id":{"maxLength":256,"minLength":1,"pattern":"^(?=.*\\S)[^\\u0000-\\u001F\\u007F]+$","type":"string"},"attachment_refs":{"items":{"additionalProperties":false,"properties":{"content_type":{"maxLength":255,"minLength":1,"pattern":"^(?=.*\\S)[^\\u0000-\\u001F\\u007F]+$","type":"string"},"hash":{"items":{"maximum":255,"minimum":0,"type":"integer"},"maxItems":32,"minItems":32,"type":"array"},"size":{"type":"integer"}},"required":["content_type","hash","size"],"type":"object"},"type":"array"},"chain_hash":{"items":{"maximum":255,"minimum":0,"type":"integer"},"maxItems":32,"minItems":32,"type":"array"},"claimed_time":{"items":{"type":"integer"},"type":"array"},"content_hash":{"items":{"maximum":255,"minimum":0,"type":"integer"},"maxItems":32,"minItems":32,"type":"array"},"environment_id":{"maxLength":256,"minLength":1,"pattern":"^(?=.*\\S)[^\\u0000-\\u001F\\u007F]+$","type":"string"},"event_type":{"maxLength":128,"minLength":1,"pattern":"^[a-z0-9_]+(?:\\.[a-z0-9_]+)+$","type":"string"},"id":{"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"},"parent_id":{"oneOf":[{"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"},{"type":"null"}]},"payload":{"additionalProperties":false,"properties":{"kind":{"type":"string"},"version":{"type":"integer"}},"required":["kind","version"],"type":"object"},"schema_version":{"minimum":1,"type":"integer"},"segment_id":{"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"},"sequence":{"type":"integer"},"session_id":{"oneOf":[{"maxLength":256,"minLength":1,"pattern":"^(?=.*\\S)[^\\u0000-\\u001F\\u007F]+$","type":"string"},{"type":"null"}]},"signature":{"additionalProperties":false,"properties":{"algorithm":{"enum":["ed25519"],"type":"string"},"bytes":{"items":{"maximum":255,"minimum":0,"type":"integer"},"maxItems":64,"minItems":64,"type":"array"},"key_id":{"pattern":"^[0-9a-f]{64}$","type":"string"}},"required":["algorithm","bytes","key_id"],"type":["object","null"]},"trace_id":{"oneOf":[{"maxLength":256,"minLength":1,"pattern":"^(?=.*\\S)[^\\u0000-\\u001F\\u007F]+$","type":"string"},{"type":"null"}]}},"required":["actor_id","attachment_refs","chain_hash","claimed_time","content_hash","environment_id","event_type","id","parent_id","payload","schema_version","segment_id","sequence","session_id","signature","trace_id"],"title":"Arxi Envelope","type":"object"}

segment.schema.json

{"$id":"https://arxi.dev/contracts/v1/schemas/segment.schema.json","$schema":"https://json-schema.org/draft/2020-12/schema","additionalProperties":false,"properties":{"created_at":{"items":{"type":"integer"},"type":"array"},"hash_algorithm_id":{"enum":["sha256"],"type":"string"},"predecessor_chain_head":{"oneOf":[{"items":{"maximum":255,"minimum":0,"type":"integer"},"maxItems":32,"minItems":32,"type":"array"},{"type":"null"}]},"predecessor_id":{"oneOf":[{"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"},{"type":"null"}]},"recorder_id":{"maxLength":256,"minLength":1,"pattern":"^(?=.*\\S)[^\\u0000-\\u001F\\u007F]+$","type":"string"},"schema_version":{"minimum":1,"type":"integer"},"segment_id":{"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"}},"required":["created_at","hash_algorithm_id","predecessor_chain_head","predecessor_id","recorder_id","schema_version","segment_id"],"title":"Arxi SegmentGenesis","type":"object"}

bundle.schema.json

{"$defs":{"bundleSelector":{"oneOf":[{"additionalProperties":false,"properties":{"BySegment":{"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"}},"required":["BySegment"],"type":"object"},{"additionalProperties":false,"properties":{"BySegments":{"items":{"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"},"type":"array"}},"required":["BySegments"],"type":"object"},{"additionalProperties":false,"properties":{"ByTrace":{"maxLength":256,"minLength":1,"pattern":"^(?=.*\\S)[^\\u0000-\\u001F\\u007F]+$","type":"string"}},"required":["ByTrace"],"type":"object"},{"additionalProperties":false,"properties":{"ByTimeRange":{"additionalProperties":false,"properties":{"end":{"items":{"type":"integer"},"maxItems":9,"minItems":9,"type":"array"},"start":{"items":{"type":"integer"},"maxItems":9,"minItems":9,"type":"array"}},"required":["start","end"],"type":"object"}},"required":["ByTimeRange"],"type":"object"},{"additionalProperties":false,"properties":{"ByEnvelopeIds":{"items":{"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"},"type":"array"}},"required":["ByEnvelopeIds"],"type":"object"},{"additionalProperties":false,"properties":{"ByFilter":{"additionalProperties":false,"properties":{"actor_ids":{"oneOf":[{"items":{"maxLength":256,"minLength":1,"pattern":"^(?=.*\\S)[^\\u0000-\\u001F\\u007F]+$","type":"string"},"type":"array"},{"type":"null"}]},"cursor":{"oneOf":[{"additionalProperties":false,"properties":{"segment_id":{"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"},"sequence":{"minimum":0,"type":"integer"}},"required":["segment_id","sequence"],"type":"object"},{"type":"null"}]},"environment_ids":{"oneOf":[{"items":{"maxLength":256,"minLength":1,"pattern":"^(?=.*\\S)[^\\u0000-\\u001F\\u007F]+$","type":"string"},"type":"array"},{"type":"null"}]},"event_types":{"oneOf":[{"items":{"maxLength":128,"minLength":1,"pattern":"^[a-z0-9_]+(?:\\.[a-z0-9_]+)+$","type":"string"},"type":"array"},{"type":"null"}]},"limit":{"oneOf":[{"maximum":4294967295,"minimum":0,"type":"integer"},{"type":"null"}]},"session_ids":{"oneOf":[{"items":{"maxLength":256,"minLength":1,"pattern":"^(?=.*\\S)[^\\u0000-\\u001F\\u007F]+$","type":"string"},"type":"array"},{"type":"null"}]},"time_range":{"oneOf":[{"additionalProperties":false,"properties":{"end":{"items":{"type":"integer"},"maxItems":9,"minItems":9,"type":"array"},"start":{"items":{"type":"integer"},"maxItems":9,"minItems":9,"type":"array"}},"required":["start","end"],"type":"object"},{"type":"null"}]},"trace_ids":{"oneOf":[{"items":{"maxLength":256,"minLength":1,"pattern":"^(?=.*\\S)[^\\u0000-\\u001F\\u007F]+$","type":"string"},"type":"array"},{"type":"null"}]}},"type":"object"}},"required":["ByFilter"],"type":"object"},{"additionalProperties":false,"properties":{"Composite":{"items":{"$ref":"#/$defs/bundleSelector"},"type":"array"}},"required":["Composite"],"type":"object"}]}},"$id":"https://arxi.dev/contracts/v1/schemas/bundle.schema.json","$schema":"https://json-schema.org/draft/2020-12/schema","additionalProperties":false,"properties":{"attachments":{"items":{"items":{"items":{"type":"integer"},"type":"array"},"type":"array"},"type":"array"},"created_at":{"items":{"type":"integer"},"type":"array"},"format_version":{"type":"integer"},"id":{"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"},"manifest":{"additionalProperties":false,"properties":{"attachment_hashes":{"items":{"items":{"maximum":255,"minimum":0,"type":"integer"},"maxItems":32,"minItems":32,"type":"array"},"type":"array"},"format_version":{"type":"integer"},"hash_algorithm_id":{"type":"string"},"omitted_parents":{"items":{},"type":"array"},"segments":{"items":{"additionalProperties":false,"properties":{"chain_head":{"items":{"maximum":255,"minimum":0,"type":"integer"},"maxItems":32,"minItems":32,"type":"array"},"envelope_count":{"type":"integer"},"first_envelope_id":{"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"},"genesis_hash":{"items":{"maximum":255,"minimum":0,"type":"integer"},"maxItems":32,"minItems":32,"type":"array"},"is_partial":{"type":"boolean"},"last_envelope_id":{"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"},"segment_id":{"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"}},"required":["chain_head","envelope_count","first_envelope_id","genesis_hash","is_partial","last_envelope_id","segment_id"],"type":"object"},"type":"array"}},"required":["attachment_hashes","format_version","hash_algorithm_id","omitted_parents","segments"],"type":"object"},"segments":{"items":{"additionalProperties":false,"properties":{"envelopes":{"items":{"additionalProperties":false,"properties":{"actor_id":{"maxLength":256,"minLength":1,"pattern":"^(?=.*\\S)[^\\u0000-\\u001F\\u007F]+$","type":"string"},"attachment_refs":{"items":{"additionalProperties":false,"properties":{"content_type":{"maxLength":255,"minLength":1,"pattern":"^(?=.*\\S)[^\\u0000-\\u001F\\u007F]+$","type":"string"},"hash":{"items":{"maximum":255,"minimum":0,"type":"integer"},"maxItems":32,"minItems":32,"type":"array"},"size":{"type":"integer"}},"required":["content_type","hash","size"],"type":"object"},"type":"array"},"chain_hash":{"items":{"maximum":255,"minimum":0,"type":"integer"},"maxItems":32,"minItems":32,"type":"array"},"claimed_time":{"items":{"type":"integer"},"type":"array"},"content_hash":{"items":{"maximum":255,"minimum":0,"type":"integer"},"maxItems":32,"minItems":32,"type":"array"},"environment_id":{"maxLength":256,"minLength":1,"pattern":"^(?=.*\\S)[^\\u0000-\\u001F\\u007F]+$","type":"string"},"event_type":{"maxLength":128,"minLength":1,"pattern":"^[a-z0-9_]+(?:\\.[a-z0-9_]+)+$","type":"string"},"id":{"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"},"parent_id":{"oneOf":[{"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"},{"type":"null"}]},"payload":{"additionalProperties":false,"properties":{"kind":{"type":"string"},"version":{"type":"integer"}},"required":["kind","version"],"type":"object"},"schema_version":{"minimum":1,"type":"integer"},"segment_id":{"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"},"sequence":{"type":"integer"},"session_id":{"oneOf":[{"maxLength":256,"minLength":1,"pattern":"^(?=.*\\S)[^\\u0000-\\u001F\\u007F]+$","type":"string"},{"type":"null"}]},"signature":{"additionalProperties":false,"properties":{"algorithm":{"enum":["ed25519"],"type":"string"},"bytes":{"items":{"maximum":255,"minimum":0,"type":"integer"},"maxItems":64,"minItems":64,"type":"array"},"key_id":{"pattern":"^[0-9a-f]{64}$","type":"string"}},"required":["algorithm","bytes","key_id"],"type":["object","null"]},"trace_id":{"oneOf":[{"maxLength":256,"minLength":1,"pattern":"^(?=.*\\S)[^\\u0000-\\u001F\\u007F]+$","type":"string"},{"type":"null"}]}},"required":["actor_id","attachment_refs","chain_hash","claimed_time","content_hash","environment_id","event_type","id","parent_id","payload","schema_version","segment_id","sequence","session_id","signature","trace_id"],"type":"object"},"type":"array"},"genesis":{"additionalProperties":false,"properties":{"created_at":{"items":{"type":"integer"},"type":"array"},"hash_algorithm_id":{"enum":["sha256"],"type":"string"},"predecessor_chain_head":{"oneOf":[{"items":{"maximum":255,"minimum":0,"type":"integer"},"maxItems":32,"minItems":32,"type":"array"},{"type":"null"}]},"predecessor_id":{"oneOf":[{"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"},{"type":"null"}]},"recorder_id":{"maxLength":256,"minLength":1,"pattern":"^(?=.*\\S)[^\\u0000-\\u001F\\u007F]+$","type":"string"},"schema_version":{"minimum":1,"type":"integer"},"segment_id":{"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","type":"string"}},"required":["created_at","hash_algorithm_id","predecessor_chain_head","predecessor_id","recorder_id","schema_version","segment_id"],"type":"object"},"proof_anchor":{"type":"null"},"seal":{"type":"null"}},"required":["envelopes","genesis","proof_anchor","seal"],"type":"object"},"type":"array"},"selector":{"$ref":"#/$defs/bundleSelector"}},"required":["attachments","created_at","format_version","id","manifest","segments","selector"],"title":"Arxi Bundle","type":"object"}