Schema Documentation
OpenAPI 3.0 definitions for model endpoints and annotation trees, enabling precise integration of time-based urban data.
The Schema Documentation provides machine-readable OpenAPI 3.0 specifications for all core 4D endpoints, including time-series model payloads and hierarchical annotation trees. Teams can use these specs to generate SDKs in their preferred language, validate requests before sending, and document internal contracts. Each endpoint explicitly defines data shapes for simulation metrics, temporal bounds, and annotation relationships — ensuring consistency across integrations.
The time-series model schema supports nested timelines with delta-encoded changesets, enabling efficient updates without full model retransmission. Annotation trees include parent-child references, timestamped edits, and linkable metadata such as source data IDs or stakeholder tags. All fields enforce strict type constraints and enumerations for regulatory categories, reducing downstream parsing errors in report generation or regulatory review workflows.
To integrate, developers fetch the YAML or JSON spec from a stable versioned URL, then use tools like Swagger Codegen or OpenAPI Generator. You can also validate incoming payloads in staging environments by running automated OpenAPI-compliant validators. This documentation is versioned alongside platform releases, so your build process stays aligned with supported capabilities.
