Merge pull request #250 from aloccid-iata/master

API Documentation separation
IATA-Cargo · Jul 16, 2024 · 8dd1e6f · 8dd1e6f
2 parents abe083f + 20653b5
commit 8dd1e6f
Show file tree

Hide file tree

Showing 103 changed files with 321 additions and 206 deletions.
diff --git a/.github/workflows/docs_builder.yaml b/.github/workflows/docs_builder.yaml
@@ -1,4 +1,4 @@
-name: ONE Record Github pages deployer
+name: ONE Record Github Pages deployer (development)
 on:
   push:
     branches:
@@ -10,17 +10,22 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-        continue-on-error: true
-      - uses: actions/setup-python@v4
         with:
-          python-version: 3.x
-      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
-      - uses: actions/cache@v3
+          fetch-depth: 0
+      - uses: actions/setup-python@v4
         with:
-          key: mkdocs-material-${{ env.cache_id }}
-          path: .cache
-          restore-keys: |
-            mkdocs-material-
-      - run: pip install mkdocs mkdocs-material 
-      - run: make deployGH
-        working-directory: ./working_draft/API/
+          python-version: 3.10.6
+      - name: Install Dependencies
+        run: |
+          pip install mkdocs-material
+          pip install mike
+      - name: Setup Docs Deploy
+        run: |
+          git config --global user.name "IATA-Cargo"
+          git config --global user.email "[email protected]"
+      - name: Build Docs Website
+        run: |
+          make copy-assets
+          mike deploy --push development
+        working-directory: ./Documentation_website
+
diff --git a/.github/workflows/docs_eraser.yaml b/.github/workflows/docs_eraser.yaml
@@ -0,0 +1,27 @@
+name: Github Pages Eraser
+on:
+    workflow_dispatch:
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.10.6
+      - name: Install Dependencies
+        run: |
+          pip install mkdocs-material
+          pip install mike
+      - name: Setup Docs Deploy
+        run: |
+          git config --global user.name "IATA-Cargo"
+          git config --global user.email "[email protected]"
+      - name: Build Docs Website
+        run: |
+          mike delete --push --all
+        working-directory: ./Documentation_website
diff --git a/.github/workflows/docs_publisher.yaml b/.github/workflows/docs_publisher.yaml
@@ -0,0 +1,31 @@
+name: ONE Record new release publisher
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.10.6
+      - name: Install Dependencies
+        run: |
+          pip install mkdocs-material
+          pip install mike
+      - name: Setup Docs Deploy
+        run: |
+          git config --global user.name "Docs Deploy"
+          git config --global user.email "[email protected]"
+      - name: Build Docs Website        
+        run: |
+          make copy-assets
+          mike deploy --push --update-aliases ${{ github.event.release.tag_name }} stable
+          mike set-default --push stable
+        working-directory: ./Documentation_website
diff --git a/working_draft/API/Build.md → Documentation_website/Build.md b/working_draft/API/Build.md → Documentation_website/Build.md
diff --git a/Documentation_website/Makefile b/Documentation_website/Makefile
@@ -0,0 +1,51 @@
+SITE_DIR := $(CURDIR)/site
+VERSION  := 2.0.0-dev
+
+install:
+	pip install pip --upgrade
+	pip install -r requirements.txt
+
+upgrade:
+	pip install pip --upgrade
+	pip install -r requirements.txt --upgrade
+
+copy-assets:
+	rm -rf docs/API-Security/changelog.md; cp ../working_draft/API/CHANGELOG.md docs/API-Security/changelog.md
+	rm -rf docs/API-Security/license.md; cp ../LICENSE docs/API-Security/license.md
+	rm -rf docs/API-Security/assets/ONE-Record-API-Ontology.ttl; cp ../working_draft/API/ONE-Record-API-Ontology.ttl docs/API-Security/assets/ONE-Record-API-Ontology.ttl
+	rm -rf docs/API-Security/assets/ONE-Record-API-Class-Diagram.md; cp ../working_draft/API/ONE-Record-API-Class-Diagram.md docs/API-Security/assets/ONE-Record-API-Class-Diagram.md
+	rm -rf docs/API-Security/assets/ONE-Record-API-OpenAPI.yaml; cp ../working_draft/API/ONE-Record-API-OpenAPI.yaml docs/API-Security/assets/ONE-Record-API-OpenAPI.yaml
+	rm -rf docs/API-Security/assets/ONE-Record-API-Ontology.csv; cp ../working_draft/API/ONE-Record-API-Ontology.csv docs/API-Security/assets/ONE-Record-API-Ontology.csv
+	rm -rf docs/API-Security/assets/ONE-Record-API-Collections.postman_collection; cp ../working_draft/API/ONE-Record-API-Collections.postman_collection docs/API-Security/assets/ONE-Record-API-Collections.postman_collection
+
+serve:
+	$(MAKE) copy-assets
+	mkdocs serve
+
+build:
+	$(MAKE) copy-assets
+	mkdocs build
+	mkdir -p $(SITE_DIR)/ns/api/$(VERSION)
+	echo "<!DOCTYPE html> <meta charset=\"utf-8\"> <title>Redirecting to versioned ontology</title> <meta http-equiv=\"refresh\" content=\"0; URL=./2.0.0-dev\"> <link rel=\"canonical\" href=\"2.0.0-dev\">" > $(SITE_DIR)/ns/api/index.html
+	python -m pylode ONE-Record-API-Ontology.ttl -o $(SITE_DIR)/ns/api/$(VERSION)/index.html
+
+
+deployGH:	
+	$(MAKE) copy-assets
+	mkdocs gh-deploy --ignore-version --no-history
+
+clean:
+	rm -rf $(SITE_DIR)
+
+ghp-deploy: 
+	ghp-import -m "updating docs" --no-history -p site
+
+mike-deploy:
+	$(MAKE) copy-assets
+	mike deploy --push development
+
+mike-release:
+	$(MAKE) copy-assets
+	mike deploy --push --update-aliases ${{ github.event.release.tag_name }} latest
+
+.PHONY: install upgrade copy-assets serve build deployGH clean ghp-deploy
diff --git a/working_draft/API/docs/README.md → ...ation_website/docs/API-Security/README.md b/working_draft/API/docs/README.md → ...ation_website/docs/API-Security/README.md
diff --git a/working_draft/API/docs/access-delegations.md → ...e/docs/API-Security/access-delegations.md b/working_draft/API/docs/access-delegations.md → ...e/docs/API-Security/access-delegations.md
@@ -114,9 +114,9 @@ POST /access-delegations HTTP/1.1
 Content-Type: application/ld+json; version=2.0.0-dev
 Accept: application/ld+json; version=2.0.0-dev
 
---8<-- "examples/AccessDelegation_example1.json"
+--8<-- "API-Security/examples/AccessDelegation_example1.json"
 ```
-_([examples/AccessDelegation_example1.json](examples/AccessDelegation_example1.json))_
+_([AccessDelegation_example1.json](./examples/AccessDelegation_example1.json))_
 
 Response:
 ```bash
@@ -141,9 +141,9 @@ POST /access-delegations HTTP/1.1
 Content-Type: application/ld+json; version=2.0.0-dev
 Accept: application/ld+json; version=2.0.0-dev
 
---8<-- "examples/AccessDelegation_example2.json"
+--8<-- "API-Security/examples/AccessDelegation_example2.json"
 ```
-_([examples/AccessDelegation_example2.json](examples/AccessDelegation_example2.json))_
+_([AccessDelegation_example2.json](./examples/AccessDelegation_example2.json))_
 
 Response:
 ```bash

diff --git a/working_draft/API/docs/action-requests.md → ...site/docs/API-Security/action-requests.md b/working_draft/API/docs/action-requests.md → ...site/docs/API-Security/action-requests.md
@@ -215,9 +215,9 @@ Location: https://1r.example.com/action-requests/599fea49-7287-42af-b441-1fa618d
 Type: https://onerecord.iata.org/ns/api#SubscriptionRequest
 Last-Modified: Tue, 21 Feb 2023 07:28:00 GMT
 
---8<-- "examples/SubscriptionRequest_example2.json"
+--8<-- "API-Security/examples/SubscriptionRequest_example2.json"
 ```
-_([examples/SubscriptionRequest_example2.json](examples/SubscriptionRequest_example2.json))_
+_([SubscriptionRequest_example2.json](./examples/SubscriptionRequest_example2.json))_
 
 # Update an Action Request
 

diff --git a/working_draft/API/docs/api-features.md → ...website/docs/API-Security/api-features.md b/working_draft/API/docs/api-features.md → ...website/docs/API-Security/api-features.md
diff --git a/...it-tests/1R_Unit_Tests.postman_collection → ...it-tests/1R_Unit_Tests.postman_collection b/...it-tests/1R_Unit_Tests.postman_collection → ...it-tests/1R_Unit_Tests.postman_collection
diff --git a/...tests/Unit_Test_Setup.postman_environment → ...tests/Unit_Test_Setup.postman_environment b/...tests/Unit_Test_Setup.postman_environment → ...tests/Unit_Test_Setup.postman_environment
diff --git a/working_draft/API/docs/bibliography.md → ...website/docs/API-Security/bibliography.md b/working_draft/API/docs/bibliography.md → ...website/docs/API-Security/bibliography.md
diff --git a/working_draft/API/docs/community.md → ...on_website/docs/API-Security/community.md b/working_draft/API/docs/community.md → ...on_website/docs/API-Security/community.md
diff --git a/working_draft/API/docs/concepts.md → ...ion_website/docs/API-Security/concepts.md b/working_draft/API/docs/concepts.md → ...ion_website/docs/API-Security/concepts.md
@@ -175,19 +175,19 @@ Therefore, the same `Sensor` object can be formatted as extended (see example 1)
 
 **Example 1:**
 
-```json title="examples/Sensor.expanded.json"
---8<-- "examples/Sensor.expanded.json"
+```json title="Sensor.expanded.json"
+--8<-- "API-Security/examples/Sensor.expanded.json"
 ```
 
-(see [examples/Sensor.expanded.json](examples/Sensor.expanded.json))
+(see [Sensor.expanded.json](./examples/Sensor.expanded.json))
 
 **Example 2:**
 
-```json title="examples/Sensor.compacted.json"
---8<-- "examples/Sensor.compacted.json"
+```json title="Sensor.compacted.json"
+--8<-- "API-Security/examples/Sensor.compacted.json"
 ```
 
-(see [examples/Sensor.compacted.json](examples/Sensor.compacted.json))
+(see [Sensor.compacted.json](./examples/Sensor.compacted.json))
 
 There are more forms that are equal to the example above. Copy and paste the first example on the [JSON-LD Playground](https://json-ld.org/playground/) to see this different forms.
 

diff --git a/working_draft/API/docs/examples/ACL.json → ...bsite/docs/API-Security/examples/ACL.json b/working_draft/API/docs/examples/ACL.json → ...bsite/docs/API-Security/examples/ACL.json
diff --git a/...s/examples/AccessDelegation_example1.json → ...y/examples/AccessDelegation_example1.json b/...s/examples/AccessDelegation_example1.json → ...y/examples/AccessDelegation_example1.json
diff --git a/...s/examples/AccessDelegation_example2.json → ...y/examples/AccessDelegation_example2.json b/...s/examples/AccessDelegation_example2.json → ...y/examples/AccessDelegation_example2.json
diff --git a/...xamples/ActionRequestChange_example1.json → ...xamples/ActionRequestChange_example1.json b/...xamples/ActionRequestChange_example1.json → ...xamples/ActionRequestChange_example1.json
diff --git a/...g_draft/API/docs/examples/AuditTrail.json → ...ocs/API-Security/examples/AuditTrail.json b/...g_draft/API/docs/examples/AuditTrail.json → ...ocs/API-Security/examples/AuditTrail.json
diff --git a/...PI/docs/examples/AuditTrail_example2.json → ...ecurity/examples/AuditTrail_example2.json b/...PI/docs/examples/AuditTrail_example2.json → ...ecurity/examples/AuditTrail_example2.json
diff --git a/...cs/examples/ChangeRequest_with_error.json → ...ty/examples/ChangeRequest_with_error.json b/...cs/examples/ChangeRequest_with_error.json → ...ty/examples/ChangeRequest_with_error.json
diff --git a/...ft/API/docs/examples/Change_example1.json → ...PI-Security/examples/Change_example1.json b/...ft/API/docs/examples/Change_example1.json → ...PI-Security/examples/Change_example1.json
diff --git a/...ft/API/docs/examples/Change_example2.json → ...PI-Security/examples/Change_example2.json b/...ft/API/docs/examples/Change_example2.json → ...PI-Security/examples/Change_example2.json
diff --git a/...ft/API/docs/examples/Change_example3.json → ...PI-Security/examples/Change_example3.json b/...ft/API/docs/examples/Change_example3.json → ...PI-Security/examples/Change_example3.json
diff --git a/...ft/API/docs/examples/Change_example4.json → ...PI-Security/examples/Change_example4.json b/...ft/API/docs/examples/Change_example4.json → ...PI-Security/examples/Change_example4.json
diff --git a/...ft/API/docs/examples/Change_example5.json → ...PI-Security/examples/Change_example5.json b/...ft/API/docs/examples/Change_example5.json → ...PI-Security/examples/Change_example5.json
diff --git a/...ft/API/docs/examples/Change_example6.json → ...PI-Security/examples/Change_example6.json b/...ft/API/docs/examples/Change_example6.json → ...PI-Security/examples/Change_example6.json
diff --git a/...ft/API/docs/examples/Change_example7.json → ...PI-Security/examples/Change_example7.json b/...ft/API/docs/examples/Change_example7.json → ...PI-Security/examples/Change_example7.json
diff --git a/working_draft/API/docs/examples/Company.json → ...e/docs/API-Security/examples/Company.json b/working_draft/API/docs/examples/Company.json → ...e/docs/API-Security/examples/Company.json
diff --git a/...ft/API/docs/examples/Company_with_id.json → ...PI-Security/examples/Company_with_id.json b/...ft/API/docs/examples/Company_with_id.json → ...PI-Security/examples/Company_with_id.json
diff --git a/...API/docs/examples/CustomsInformation.json → ...Security/examples/CustomsInformation.json b/...API/docs/examples/CustomsInformation.json → ...Security/examples/CustomsInformation.json
diff --git a/...I/docs/examples/CustomsInformation_2.json → ...curity/examples/CustomsInformation_2.json b/...I/docs/examples/CustomsInformation_2.json → ...curity/examples/CustomsInformation_2.json
diff --git a/...ng_draft/API/docs/examples/Error_400.json → ...docs/API-Security/examples/Error_400.json b/...ng_draft/API/docs/examples/Error_400.json → ...docs/API-Security/examples/Error_400.json
diff --git a/...API/docs/examples/Error_400_example2.json → ...Security/examples/Error_400_example2.json b/...API/docs/examples/Error_400_example2.json → ...Security/examples/Error_400_example2.json
diff --git a/...ng_draft/API/docs/examples/Error_403.json → ...docs/API-Security/examples/Error_403.json b/...ng_draft/API/docs/examples/Error_403.json → ...docs/API-Security/examples/Error_403.json
diff --git a/...ft/API/docs/examples/Error_404.de-DE.json → ...PI-Security/examples/Error_404.de-DE.json b/...ft/API/docs/examples/Error_404.de-DE.json → ...PI-Security/examples/Error_404.de-DE.json
diff --git a/...ng_draft/API/docs/examples/Error_404.json → ...docs/API-Security/examples/Error_404.json b/...ng_draft/API/docs/examples/Error_404.json → ...docs/API-Security/examples/Error_404.json
diff --git a/...aft/API/docs/examples/LogisticsEvent.json → ...API-Security/examples/LogisticsEvent.json b/...aft/API/docs/examples/LogisticsEvent.json → ...API-Security/examples/LogisticsEvent.json
diff --git a/...docs/examples/LogisticsEvent_with_id.json → ...rity/examples/LogisticsEvent_with_id.json b/...docs/examples/LogisticsEvent_with_id.json → ...rity/examples/LogisticsEvent_with_id.json
diff --git a/.../examples/LogisticsEvents_empty_list.json → .../examples/LogisticsEvents_empty_list.json b/.../examples/LogisticsEvents_empty_list.json → .../examples/LogisticsEvents_empty_list.json
diff --git a/...amples/LogisticsEvents_filtered_list.json → ...amples/LogisticsEvents_filtered_list.json b/...amples/LogisticsEvents_filtered_list.json → ...amples/LogisticsEvents_filtered_list.json
diff --git a/...I/docs/examples/LogisticsEvents_list.json → ...curity/examples/LogisticsEvents_list.json b/...I/docs/examples/LogisticsEvents_list.json → ...curity/examples/LogisticsEvents_list.json
diff --git a/.../docs/examples/Notification_example1.json → ...urity/examples/Notification_example1.json b/.../docs/examples/Notification_example1.json → ...urity/examples/Notification_example1.json
diff --git a/.../docs/examples/Notification_example2.json → ...urity/examples/Notification_example2.json b/.../docs/examples/Notification_example2.json → ...urity/examples/Notification_example2.json
diff --git a/.../docs/examples/Notification_example3.json → ...urity/examples/Notification_example3.json b/.../docs/examples/Notification_example3.json → ...urity/examples/Notification_example3.json
diff --git a/.../docs/examples/Notification_example4.json → ...urity/examples/Notification_example4.json b/.../docs/examples/Notification_example4.json → ...urity/examples/Notification_example4.json
diff --git a/.../docs/examples/Notification_example5.json → ...urity/examples/Notification_example5.json b/.../docs/examples/Notification_example5.json → ...urity/examples/Notification_example5.json
diff --git a/working_draft/API/docs/examples/Piece.json → ...ite/docs/API-Security/examples/Piece.json b/working_draft/API/docs/examples/Piece.json → ...ite/docs/API-Security/examples/Piece.json
diff --git a/...raft/API/docs/examples/Piece_with_id.json → .../API-Security/examples/Piece_with_id.json b/...raft/API/docs/examples/Piece_with_id.json → .../API-Security/examples/Piece_with_id.json
diff --git a/...API/docs/examples/Piece_with_id.rev3.json → ...Security/examples/Piece_with_id.rev3.json b/...API/docs/examples/Piece_with_id.rev3.json → ...Security/examples/Piece_with_id.rev3.json
diff --git a/...t/API/docs/examples/Sensor.compacted.json → ...I-Security/examples/Sensor.compacted.json b/...t/API/docs/examples/Sensor.compacted.json → ...I-Security/examples/Sensor.compacted.json
diff --git a/...ft/API/docs/examples/Sensor.expanded.json → ...PI-Security/examples/Sensor.expanded.json b/...ft/API/docs/examples/Sensor.expanded.json → ...PI-Security/examples/Sensor.expanded.json
diff --git a/.../API/docs/examples/ServerInformation.json → ...-Security/examples/ServerInformation.json b/.../API/docs/examples/ServerInformation.json → ...-Security/examples/ServerInformation.json
diff --git a/...xamples/Shipment_with_Piece.embedded.json → ...xamples/Shipment_with_Piece.embedded.json b/...xamples/Shipment_with_Piece.embedded.json → ...xamples/Shipment_with_Piece.embedded.json
diff --git a/...PI/docs/examples/Shipment_with_Piece.json → ...ecurity/examples/Shipment_with_Piece.json b/...PI/docs/examples/Shipment_with_Piece.json → ...ecurity/examples/Shipment_with_Piece.json
diff --git a/...examples/SubscriptionRequest_example.json → ...examples/SubscriptionRequest_example.json b/...examples/SubscriptionRequest_example.json → ...examples/SubscriptionRequest_example.json
diff --git a/...xamples/SubscriptionRequest_example2.json → ...xamples/SubscriptionRequest_example2.json b/...xamples/SubscriptionRequest_example2.json → ...xamples/SubscriptionRequest_example2.json
diff --git a/.../docs/examples/Subscription_example1.json → ...urity/examples/Subscription_example1.json b/.../docs/examples/Subscription_example1.json → ...urity/examples/Subscription_example1.json
diff --git a/...docs/examples/Subscriptions_example1.json → ...rity/examples/Subscriptions_example1.json b/...docs/examples/Subscriptions_example1.json → ...rity/examples/Subscriptions_example1.json
diff --git a/...docs/examples/Subscriptions_example2.json → ...rity/examples/Subscriptions_example2.json b/...docs/examples/Subscriptions_example2.json → ...rity/examples/Subscriptions_example2.json
diff --git a/...les/Subscriptions_example3_Error_400.json → ...les/Subscriptions_example3_Error_400.json b/...les/Subscriptions_example3_Error_400.json → ...les/Subscriptions_example3_Error_400.json
diff --git a/...riptions_example3_Error_400_example2.json → ...riptions_example3_Error_400_example2.json b/...riptions_example3_Error_400_example2.json → ...riptions_example3_Error_400_example2.json
diff --git a/working_draft/API/docs/glossary.md → ...ion_website/docs/API-Security/glossary.md b/working_draft/API/docs/glossary.md → ...ion_website/docs/API-Security/glossary.md
diff --git a/...I/docs/img/Access-Delegation_overview.png → ...curity/img/Access-Delegation_overview.png b/...I/docs/img/Access-Delegation_overview.png → ...curity/img/Access-Delegation_overview.png
diff --git a/working_draft/API/docs/img/IATA_logo.png → ...bsite/docs/API-Security/img/IATA_logo.png b/working_draft/API/docs/img/IATA_logo.png → ...bsite/docs/API-Security/img/IATA_logo.png
diff --git a/...raft/API/docs/img/ONE-Record_API-Logo.png → .../API-Security/img/ONE-Record_API-Logo.png b/...raft/API/docs/img/ONE-Record_API-Logo.png → .../API-Security/img/ONE-Record_API-Logo.png
diff --git a/...ng_draft/API/docs/img/ONE-Record_logo.png → ...docs/API-Security/img/ONE-Record_logo.png b/...ng_draft/API/docs/img/ONE-Record_logo.png → ...docs/API-Security/img/ONE-Record_logo.png
diff --git a/working_draft/API/docs/img/Overview_1.png → ...site/docs/API-Security/img/Overview_1.png b/working_draft/API/docs/img/Overview_1.png → ...site/docs/API-Security/img/Overview_1.png
diff --git a/working_draft/API/docs/img/Overview_2.png → ...site/docs/API-Security/img/Overview_2.png b/working_draft/API/docs/img/Overview_2.png → ...site/docs/API-Security/img/Overview_2.png
diff --git a/...ng_draft/API/docs/img/PubSub_overview.png → ...docs/API-Security/img/PubSub_overview.png b/...ng_draft/API/docs/img/PubSub_overview.png → ...docs/API-Security/img/PubSub_overview.png
diff --git a/..._draft/API/docs/img/Security_overview.png → ...cs/API-Security/img/Security_overview.png b/..._draft/API/docs/img/Security_overview.png → ...cs/API-Security/img/Security_overview.png
diff --git a/working_draft/API/docs/img/favicon.ico → ...website/docs/API-Security/img/favicon.ico b/working_draft/API/docs/img/favicon.ico → ...website/docs/API-Security/img/favicon.ico
diff --git a/working_draft/API/docs/img/logo.png → ...on_website/docs/API-Security/img/logo.png b/working_draft/API/docs/img/logo.png → ...on_website/docs/API-Security/img/logo.png
diff --git a/...aft/API/docs/img/unit-tests/authSetup.png → ...API-Security/img/unit-tests/authSetup.png b/...aft/API/docs/img/unit-tests/authSetup.png → ...API-Security/img/unit-tests/authSetup.png
diff --git a/...aft/API/docs/img/unit-tests/envConfig.png → ...API-Security/img/unit-tests/envConfig.png b/...aft/API/docs/img/unit-tests/envConfig.png → ...API-Security/img/unit-tests/envConfig.png
diff --git a/...t/API/docs/img/unit-tests/postmanColl.png → ...I-Security/img/unit-tests/postmanColl.png b/...t/API/docs/img/unit-tests/postmanColl.png → ...I-Security/img/unit-tests/postmanColl.png
diff --git a/...ft/API/docs/img/unit-tests/postmanEnv.png → ...PI-Security/img/unit-tests/postmanEnv.png b/...ft/API/docs/img/unit-tests/postmanEnv.png → ...PI-Security/img/unit-tests/postmanEnv.png
diff --git a/...PI/docs/img/unit-tests/testCollection.png → ...ecurity/img/unit-tests/testCollection.png b/...PI/docs/img/unit-tests/testCollection.png → ...ecurity/img/unit-tests/testCollection.png
diff --git a/...aft/API/docs/implementation-guidelines.md → ...API-Security/implementation-guidelines.md b/...aft/API/docs/implementation-guidelines.md → ...API-Security/implementation-guidelines.md
@@ -308,9 +308,9 @@ HTTP/1.1 403 Forbidden
 Content-Language: en-US
 Content-Type: application/ld+json
 
---8<-- "examples/Error_403.json"
+--8<-- "API-Security/examples/Error_403.json"
 ```
-_([examples/Error_403.json](examples/Error_403.json))_
+_([Error_403.json](./examples/Error_403.json))_
 
 ## Asynchronous Error Handling
 
@@ -395,9 +395,9 @@ HTTP/1.1 404 Not Found
 Content-Language: de-DE
 Content-Type: application/ld+json
 
---8<-- "examples/Error_404.de-DE.json"
+--8<-- "API-Security/examples/Error_404.de-DE.json"
 ```
-_([examples/Error_404.de-DE.json](examples/Error_404.de-DE.json))_
+_([Error_404.de-DE.json](./examples/Error_404.de-DE.json))_
 
 # Caching
 

diff --git a/working_draft/API/docs/index.md → ...tation_website/docs/API-Security/index.md b/working_draft/API/docs/index.md → ...tation_website/docs/API-Security/index.md
diff --git a/working_draft/API/docs/logistics-events.md → ...ite/docs/API-Security/logistics-events.md b/working_draft/API/docs/logistics-events.md → ...ite/docs/API-Security/logistics-events.md
@@ -41,7 +41,7 @@ The following HTTP header parameters MUST be present in the request:
 
 The HTTP request body must contain a valid [LogisticsEvent](https://onerecord.iata.org/ns/cargo#LogisticsEvent) in the format as specified by the Content-Type in the header.
 
-The LogisticsEvent is a data class of the [ONE Record cargo ontology](https://onerecord.iata.org/ns/cargo/3.0.0).
+The LogisticsEvent is a data class of the [ONE Record cargo ontology](https://onerecord.iata.org/ns/cargo).
 The properties and relationships to other data classes are visualized in the following class diagram.
 
 ```mermaid
@@ -135,10 +135,10 @@ Host: 1r.example.com
 Content-Type: application/ld+json; version=2.0.0-dev
 Accept: application/ld+json; version=2.0.0-dev
 
---8<-- "examples/LogisticsEvent.json"
+--8<-- "API-Security/examples/LogisticsEvent.json"
 ```
 
-_([examples/LogisticsEvent.json](examples/LogisticsEvent.json))_
+_([LogisticsEvent.json](./examples/LogisticsEvent.json))_
 
 Response:
 
@@ -162,10 +162,10 @@ Host: 1r.example.com
 Content-Type: application/ld+json; version=2.0.0-dev
 Accept: application/ld+json; version=2.0.0-dev
 
---8<-- "examples/LogisticsEvent.json"
+--8<-- "API-Security/examples/LogisticsEvent.json"
 ```
 
-_([examples/LogisticsEvent.json](examples/LogisticsEvent.json))_
+_([LogisticsEvent.json](./examples/LogisticsEvent.json))_
 
 Response:
 
@@ -174,10 +174,10 @@ HTTP/1.1 404 Not Found
 Content-Language: en-US
 Content-Type: application/ld+json; version=2.0.0-dev
 
---8<-- "examples/Error_404.json"
+--8<-- "API-Security/examples/Error_404.json"
 ```
 
-_([examples/Error_404.json](examples/Error_404.json))_
+_([Error_404.json](./examples/Error_404.json))_
 
 # Get a Logistics Event
 
@@ -250,10 +250,10 @@ Location: https://1r.example.com/logistics-objects/1a8ded38-1804-467c-a369-81a41
 Type: https://onerecord.iata.org/ns/cargo#LogisticsEvent
 Last-Modified: Tue, 19 Apr 2023 07:28:00 GMT
 
---8<-- "examples/LogisticsEvent_with_id.json"
+--8<-- "API-Security/examples/LogisticsEvent_with_id.json"
 ```
 
-_([examples/LogisticsEvent_with_id.json](examples/LogisticsEvent_with_id.json))_
+_([LogisticsEvent_with_id.json](./examples/LogisticsEvent_with_id.json))_
 
 ## Example B2
 
@@ -275,10 +275,10 @@ Content-Language: en-US
 Content-Type: application/ld+json; version=2.0.0-dev
 Type: https://onerecord.iata.org/ns/api/2.0.0dev#Error
 
---8<-- "examples/Error_404.json"
+--8<-- "API-Security/examples/Error_404.json"
 ```
 
-_([examples/Error_404.json](examples/Error_404.json))_
+_([Error_404.json](./examples/Error_404.json))_
 
 # Get Logistic Events of a Logistics Object
 
@@ -396,9 +396,9 @@ HTTP/1.1 200 OK
 Content-Type: application/ld+json; version=2.0.0-dev
 Content-Language: en-US
 
---8<-- "examples/LogisticsEvents_list.json"
+--8<-- "API-Security/examples/LogisticsEvents_list.json"
 ```
-_([examples/LogisticsEvents_list.json](examples/LogisticsEvents_list.json))_
+_([LogisticsEvents_list.json](./examples/LogisticsEvents_list.json))_
 
 
 ## Example C2
@@ -420,9 +420,9 @@ HTTP/1.1 200 OK
 Content-Type: application/ld+json; version=2.0.0-dev
 Content-Language: en-US
 
---8<-- "examples/LogisticsEvents_filtered_list.json"
+--8<-- "API-Security/examples/LogisticsEvents_filtered_list.json"
 ```
-_([examples/LogisticsEvents_filtered_list.json](examples/LogisticsEvents_filtered_list.json))_
+_([LogisticsEvents_filtered_list.json](./examples/LogisticsEvents_filtered_list.json))_
 
 ## Example C3
 
@@ -443,6 +443,6 @@ HTTP/1.1 200 OK
 Content-Type: application/ld+json; version=2.0.0-dev
 Content-Language: en-US
 
---8<-- "examples/LogisticsEvents_empty_list.json"
+--8<-- "API-Security/examples/LogisticsEvents_empty_list.json"
 ```
-_([examples/LogisticsEvents_empty_list.json](examples/LogisticsEvents_empty_list.json))_
+_([LogisticsEvents_empty_list.json](./examples/LogisticsEvents_empty_list.json))_