From d5476d481e9bf51586fa8a9b8097efd0fe79a2d6 Mon Sep 17 00:00:00 2001 From: Kevin Schmengler Date: Tue, 7 May 2024 15:07:07 +0200 Subject: [PATCH] Adapt readme --- .github/workflows/release.yml | 2 +- README.md | 35 ++++++++++++++--------------------- pom.xml | 3 ++- 3 files changed, 17 insertions(+), 23 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index a6b332a..7d97320 100755 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -17,7 +17,7 @@ jobs: uses: actions/setup-java@v4 with: distribution: 'temurin' - java-version: 8 + java-version: '21' cache: 'maven' - name: Get tag version diff --git a/README.md b/README.md index af1b9e5..602dd11 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ This repository contains **Java POJO classes for IATA ONE Record** (1R) data mod official IATA Ontology on GitHub at https://github.com/IATA-Cargo/ONE-Record. Note that the deliverable of this project contains POJO classes from the -Ontologies for "Data-Model" _only_, excluding the "API" part. +Ontologies for "Data-Model", "API" and the "CoreCodeLists" part. ### Codelists and Utility This repository additionally contains some assisting classes e.g., @@ -36,24 +36,16 @@ is not published on Maven Central Repository. ### Related projects -See also https://github.com/riege/one-record-ontologymodel, a predecessor of -this repository, which covers DataModel- plus API-Ontology. -
Public projects like [IATA one-record-server-java](https://github.com/IATA-Cargo/one-record-server-java) or [NE:ONE ONE Record server](https://git.openlogisticsfoundation.org/digital-air-cargo/ne-one) use similar approaches with embedded Java POJOs. -### Comparison [one-record-ontologydatamodel](https://github.com/riege/one-record-ontologydatamodel) and [one-record-ontologymodel](https://github.com/riege/one-record-ontologymodel) +### Versioning -| | [one-record-ontologydatamodel](https://github.com/riege/one-record-ontologydatamodel) | [one-record-ontologymodel](https://github.com/riege/one-record-ontologymodel) | -|----------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [Ontology 1.1 / 2021-June](https://github.com/IATA-Cargo/ONE-Record/tree/master/June-2021-standard-COTB-endorsed) | not available (Note 1) | Yes (Release 1.1.x) | -| [Ontology 2.0 / 2022-May](https://github.com/IATA-Cargo/ONE-Record/tree/master/May-2022-standard-forCOTBendorsement) | not available (Note 1) | Yes (Release 2.0.x) | -| [Ontology 2.1 / 2022-December](https://github.com/IATA-Cargo/ONE-Record/tree/master/December-2022-standard) | Yes | not available | -| Scope | DataModel Ontology only | API + DataModel Ontology | -| 3rd party Java annotations | none (clean API) | [Jackson](https://github.com/FasterXML/jackson), [Swagger IO](https://github.com/swagger-api/swagger.io), [Spring Framework](https://github.com/spring-projects/spring-framework) | - -Note 1: Not released but can be build manually by replacing Ontology file and building manually within project. +Since we aim to keep the version numbers in relation to the used ontology version we decided to use a slightly different pattern for the versioning. +The most recent version of the DataModel Ontology is: **3.0.0** (as of 07-05-2024). The next release of this project will therefore get the version: **0.3.0000**. +An internal bugfix would then result in the release version **0.3.0001** and if a new ontology is used e.g. version **3.0.1** for the DataModel, +this would then result in the release of **0.3.1000**. ### Building @@ -73,7 +65,7 @@ which will generate `target/one-record-cargo-1.2.3.jar` ### Generation from (a new) Ontology -Updating with a new Ontology works by updating content in directory `src/main/resources`, the TTL file and adopt the `mapping` file. +Updating with a new Ontology works by updating content in directory `src/main/resources`. Please replace the TTL file(s) and adopt the `mapping` file. ## Used Ontology / Data model version @@ -81,12 +73,13 @@ In general, the official IATA Ontology determines the 1R data model. The IATA O The IATA [Cargo Operations and Technology Board, COTB](https://www.iata.org/en/programs/workgroups/cotb) approved various Ontology versions. -This project aims to keep its releases and versioning in synchronization with the IATA Ontologies, starting with IATA ONE Record Ontology version 2.1. - +This project aims to keep its releases and versioning in synchronization with the IATA Ontologies, starting with IATA ONE Record Ontology versions: + +DataModel: 3.0.0 (as of 03-11-2023) + +API: 2.0.0 (as of 02-05-2023) + +CoreCodeLists: 1.0.0 (as of 23-10-2023) ## Question and Feedback diff --git a/pom.xml b/pom.xml index 79710f2..f6736c9 100644 --- a/pom.xml +++ b/pom.xml @@ -13,7 +13,7 @@ based on (https://github.com/IATA-Cargo/ONE-Record). - 1.0.0-SNAPSHOT + 0.3.0000-SNAPSHOT 1.2.2 @@ -51,6 +51,7 @@ *.ttl mapping + *.cer