Remove csv export of for api. Fix request status and notification eve…

…n type
IATA-Cargo · Dec 6, 2024 · eba626d · eba626d
1 parent 6e1cc92
commit eba626d
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 53 deletions.
diff --git a/Documentation_website/docs/API-Security/api-features.md b/Documentation_website/docs/API-Security/api-features.md
@@ -9,6 +9,8 @@ The following features summarize all of the ONE Record API features
 
 **Update a Logistics Object** - As a fundamental principle, _only_ the Holder of a Logistics Object can make changes to it. Therefore, changes required by other parties are expressed as `Change Requests` that needs to be approved and executed by the actual holder.
 
+**Verify a Logistics Object** - The ONE Record standard enables third parties to not only propose modifications to LogisticsObjects but also flag anomalies, missing properties, or errors using a process called `Verification Request`. This action request follow the same approval process as the `Change Requests`.
+
 **Subscribe to a Logistics Object for updates** - Once a Logistics Object has been created, the holder can propose subscriptions to other parties who will then be notified of any changes. Other parties may also request such a subscription at the discretion of the holder.
 
 **Create Logistics Event linked with Logistics Objects** - Logistics Events like "arrival", "acceptance" etc. are central in the management of logistics and transport. Every participant in the network with sufficient access rights can submit any type of Logistics Event to any published Logistics Object.
@@ -29,7 +31,7 @@ The following features summarize all of the ONE Record API features
 | ---------------- | -------------------------------------- |   -------- |
 | GET              | /                  | Retrieve ServerInformation             |
 | POST              | /logistics-objects/ | Create Logistics Object. This endpoint could be either internal or not implemented.             |
-| GET, PATCH       | /logistics-objects/{logisticsObjectId}                  | Retrieve Logistics Object and links to related resources                       |
+| GET, PATCH, POST       | /logistics-objects/{logisticsObjectId}                  | Retrieve Logistics Object, Change Logistics object and Create a new Verification Request                       |
 | GET              | /logistics-objects/{logisticsObjectId}/audit-trail      | Retrieve Audit Trail of a Logistics Object                 |
 | GET, POST        | /logistics-objects/{logisticsObjectId}/logistics-events | Create or retrieve LogisticsEvents to a Logistics Object                       |
 | GET              | /logistics-objects/{logisticsObjectId}/logistics-events/{LogisticsEvent URI}                  | Retrieve a LogisticsEvent              |

diff --git a/Documentation_website/docs/API-Security/index.md b/Documentation_website/docs/API-Security/index.md
@@ -15,7 +15,6 @@ It is assumed that the reader is familiar with the ONE Record data model, REST A
 
 - [Changelog](changelog.md) contains a list of all notable changes for each version of the ONE Record API specification.
 - [ONE Record API ontology](assets/ONE-Record-API-Ontology.ttl) provides the vocabulary and data classes for the data model used in the ONE Record API.
-- [Tabular overview of ONE Record API ontology](assets/ONE-Record-API-Ontology.csv) is a tabular representation of the ONE Record API ontology and describes the ONE Record API data classes, their properties as attributes, descriptions and valid values.
 - [ONE Record API class diagram](assets/ONE-Record-API-Class-Diagram.md) is a visual representation of the ONE Record API ontology and describes the ONE Record API data classes, their properties as attributes, and the relationship that can exist between the classes.
 - [OpenAPI specification](assets/ONE-Record-API-OpenAPI.yaml) describes the prescribed API endpoint structure of a ONE Record server implementation. 
 - [Postman collection](assets/ONE-Record-API-Collections.postman_collection) contains demo HTTP requests that demonstrate how to interact with the various ONE Record API endpoints and can be used to playback the examples provided in this document.

diff --git a/Documentation_website/docs/API-Security/notifications.md b/Documentation_website/docs/API-Security/notifications.md
@@ -86,6 +86,12 @@ The properties and relationships to other data classes are visualized in the fol
         SUBSCRIPTION_REQUEST_REJECTED
         SUBSCRIPTION_REQUEST_FAILED
         SUBSCRIPTION_REQUEST_REVOKED
+
+        VERIFICATION_REQUEST_PENDING
+        VERIFICATION_REQUEST_ACKNOWLEDGED
+        VERIFICATION_REQUEST_REJECTED
+        VERIFICATION_REQUEST_FAILED
+        VERIFICATION_REQUEST_REVOKED
     }
 
     class RequestStatus{
@@ -94,7 +100,8 @@ The properties and relationships to other data classes are visualized in the fol
         REQUEST_ACCEPTED
         REQUEST_REJECTED
         REQUEST_FAILED
-        REQUEST_REVOKED        
+        REQUEST_REVOKED  
+        REQUEST_ACKNOWLEDGED       
     }
 ```
 

diff --git a/working_draft/API/ONE-Record-API-Ontology.csv b/working_draft/API/ONE-Record-API-Ontology.csv