# iata-cargo/one-record architecture

> Architecture diagram of the GitHub repository iata-cargo/one-record, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-26). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/iata-cargo/one-record
- Repository: https://github.com/iata-cargo/one-record

## Overview

This repository publishes the IATA ONE Record specifications, not a running logistics service. Its principal user workflow is for implementers to consult the shipment data model and ontology, then use the API and security specifications to exchange shipment information; orchestration materials document mappings to other cargo formats. The README identifies working_draft as the latest version, while dated release directories preserve prior specifications. The tree and README support these capability relationships, but no runtime call graph exists to inspect.

Main entry points: [`working_draft/API/ONE-Record-API-OpenAPI.yaml`](https://github.com/iata-cargo/one-record/blob/master/working_draft/API/ONE-Record-API-OpenAPI.yaml) (API specification), [`working_draft/ontology`](https://github.com/iata-cargo/one-record/tree/master/working_draft/ontology) (Shipment data model), [`working_draft/API/README.md`](https://github.com/iata-cargo/one-record/blob/master/working_draft/API/README.md) (API security), [`working_draft/Data-Orchestration`](https://github.com/iata-cargo/one-record/tree/master/working_draft/Data-Orchestration) (Format mappings)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_core["Core standard"]
  node_dm["Shipment data model"]
  node_ontology["Data ontology"]
end

subgraph group_api["API and security"]
  node_api["API specification"]
  node_api_models["API models"]
  node_security["API security<br/>[README.md]"]
  node_class_diagram["API class diagram"]
end

subgraph group_interop["Interoperability"]
  node_orchestration["Format mappings"]
  node_cxml["CXML mapping<br/>[CXML-Mapping.md]"]
end

subgraph group_history["Releases and guidance"]
  node_release_specs["Dated specifications"]
  node_portal["Specification guidance"]
end

node_implementer(("Cargo implementer"))

node_implementer -->|"consults"| node_dm
node_implementer -->|"implements"| node_api
node_implementer -->|"applies"| node_security
node_dm -->|"defines shared data"| node_api
node_ontology -->|"formalizes"| node_dm
node_api_models -->|"describes models"| node_api
node_security -->|"secures exchange"| node_api
node_class_diagram -->|"illustrates"| node_api
node_implementer -->|"consults mappings"| node_orchestration
node_orchestration -->|"includes mapping"| node_cxml
node_implementer -->|"checks release"| node_release_specs
node_implementer -->|"consults guidance"| node_portal

click node_dm "https://github.com/iata-cargo/one-record/tree/master/working_draft/ontology"
click node_ontology "https://github.com/iata-cargo/one-record/blob/master/working_draft/ontology/IATA-1R-DM-Ontology.ttl"
click node_api "https://github.com/iata-cargo/one-record/blob/master/working_draft/API/ONE-Record-API-OpenAPI.yaml"
click node_api_models "https://github.com/iata-cargo/one-record/blob/master/working_draft/API/ONE-Record-API-Ontology.ttl"
click node_security "https://github.com/iata-cargo/one-record/blob/master/working_draft/API/README.md"
click node_class_diagram "https://github.com/iata-cargo/one-record/blob/master/working_draft/API/ONE-Record-API-Class-Diagram.md"
click node_orchestration "https://github.com/iata-cargo/one-record/tree/master/working_draft/Data-Orchestration"
click node_cxml "https://github.com/iata-cargo/one-record/blob/master/working_draft/Data-Orchestration/CXML-Mapping.md"
click node_release_specs "https://github.com/iata-cargo/one-record/tree/master/2026-07-standard"
click node_portal "https://github.com/iata-cargo/one-record/tree/master/Documentation_website/docs"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_dm,node_ontology toneBlue
class node_api,node_api_models,node_security,node_class_diagram toneAmber
class node_orchestration,node_cxml toneMint
class node_release_specs,node_portal toneRose
class node_implementer toneIndigo
```

## Components

### Core standard

- [Shipment data model](https://github.com/iata-cargo/one-record/tree/master/working_draft/ontology): `working_draft/ontology`
- [Data ontology](https://github.com/iata-cargo/one-record/blob/master/working_draft/ontology/IATA-1R-DM-Ontology.ttl): `working_draft/ontology/IATA-1R-DM-Ontology.ttl`

### API and security

- [API specification](https://github.com/iata-cargo/one-record/blob/master/working_draft/API/ONE-Record-API-OpenAPI.yaml): `working_draft/API/ONE-Record-API-OpenAPI.yaml`
- [API models](https://github.com/iata-cargo/one-record/blob/master/working_draft/API/ONE-Record-API-Ontology.ttl): `working_draft/API/ONE-Record-API-Ontology.ttl`
- [API security](https://github.com/iata-cargo/one-record/blob/master/working_draft/API/README.md): `working_draft/API/README.md`
- [API class diagram](https://github.com/iata-cargo/one-record/blob/master/working_draft/API/ONE-Record-API-Class-Diagram.md): `working_draft/API/ONE-Record-API-Class-Diagram.md`

### Interoperability

- [Format mappings](https://github.com/iata-cargo/one-record/tree/master/working_draft/Data-Orchestration): `working_draft/Data-Orchestration`
- [CXML mapping](https://github.com/iata-cargo/one-record/blob/master/working_draft/Data-Orchestration/CXML-Mapping.md): `working_draft/Data-Orchestration/CXML-Mapping.md`

### Releases and guidance

- [Dated specifications](https://github.com/iata-cargo/one-record/tree/master/2026-07-standard): `2026-07-standard`
- [Specification guidance](https://github.com/iata-cargo/one-record/tree/master/Documentation_website/docs): `Documentation_website/docs`

### Other components

- **Cargo implementer**

## Connections

- Cargo implementer → Shipment data model: consults
- Cargo implementer → API specification: implements
- Cargo implementer → API security: applies
- Shipment data model → API specification: defines shared data
- Data ontology → Shipment data model: formalizes
- API models → API specification: describes models
- API security → API specification: secures exchange
- API class diagram → API specification: illustrates
- Cargo implementer → Format mappings: consults mappings
- Format mappings → CXML mapping: includes mapping
- Cargo implementer → Dated specifications: checks release
- Cargo implementer → Specification guidance: consults guidance