Multiple groups within UN/CEFACT wish to develop standard Application Programming Interfaces (APIs) as part of the set of technical deliverables from their project. The RDM2API project demonstrated that it is possible to go from the semantics of UN/CEFACT towards APIs. This project aims to develop a technical specification in order to move from Reference Data Model (RDM) based deliverables to a standardized API which retains the richness of information available in RDMs.
The JSON Schema NDR TS defines a standardised method to generate the UN/CEFACT data structures of the reference data models and their derived message structures as standardised JSON schema files. The https://github.com/uncefact/spec-JSONschema publishes the standardised JSON schema files as well as examples.
This repository serves as a test platform during the project phase. Subsequently, the final location for the publication of the UN/CEFACT standards will be specified. The generated JSON schema files will serve as standardised input for the JSON-LD project from the end of this project. In this way, conformity between these two formats will be ensured.
The JSON Schema NDR Technical Specification 1.0 from the UN/CEFACT website can be found here.
In this repository there are two main publications of UN/CEFACT JSON schema artefacts:
-
The first variant in the JSONSchema2020-12 folder is based on JSON schema draft 2020-12 and fully supports OpenAPI 3.1.x.
-
The second variant in the Compatibility folder supports OpenAPI 3.0.x and therefore uses some older JSON schema concepts.
Use cases for extensions, restrictions and contextualisations of the publications can be found in the examples folder.
We invite anyone in the global supply chain space (e.g. trade, transport, finance, agriculture, travel, …) to participate and contribute. Especially we are looking for active users in API development to drive quality requirements.
Note that you need to be a registered UN/CEFACT expert in order to formally contribute as Subject Matter Expert to this specification. Experts are expected to contribute to the work based solely on their expertise and to comply with the UN/CEFACT Code of Conduct and Ethics and the policy on Intellectual Property Rights.
To register please visit https://uncefact.unece.org/display/uncefactpublic/UNCEFACT+Expert+Registration and follow the registration process.
The official UN/CEFACT project page can be found at https://uncefact.unece.org/pages/viewpage.action?pageId=83591895
Chair of the project is Marek Laskowski. Project Lead is Jörg Walther. Editors are Andreas Pelekies @AndreasPvd and Gerhard Heemskerk @GerhardHNL.
Sessions will be held regularly on Tuesdays from 10:00-11:00 Central European Time.
The standing agenda is to review open issues or other topics that can be found on the official UN/CEFACT project page.
Meeting minutes are shared on the project page.