Reference
Appendix covering the schema contract, type mappings, generated module anatomy, CLI exit codes, glossary, and versioning for the OptixLog SDK and CLI.
The Reference appendix collects precise, look-up-friendly material that supports the rest of the SDK and CLI documentation. Use it when you need exact type mappings, field-level schema details, a term definition, or the canonical list of exit codes — rather than step-by-step guidance.
What is in this section
Schema Contract
The full JSON schema contract: schema_version, identity, projects, node_types, and project_node_types — annotated field by field.
Type Mapping
How every contract type (string, integer, enum, array, json…) maps to its Python counterpart, with required/optional/default rules.
Generated Module Anatomy
A walk-through of optixlog_gen.py: what each section contains, what is generated vs hand-written, and how the typing mechanism works.
Exit Codes
CLI exit codes and the complete list of error: messages printed to stderr.
Glossary
Definitions for every term used across the SDK and CLI docs — organization, project, workflow node, codegen, OptixClient, and more.
Versioning
SDK version, server API surface version, and schema_version in optixlog.toml.
Types
Type aliases and Literal unions used throughout the OptixLog SDK — JSONValue, IngestibleNode, Order, and all filter/include literals.
Schema Contract
The JSON schema contract returned by the server codegen endpoint — schema_version, identity, projects, node_types, and project_node_types — annotated field by field.