SD-350 Update placeofissue-ebl (#242)

dcsaorg · Dec 10, 2024 · e31403f · e31403f
1 parent 3cf9f4e
commit e31403f
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 21 deletions.
diff --git a/ebl-issuance/src/main/resources/standards/eblissuance/schemas/EBL_ISS_v3.0.0.yaml b/ebl-issuance/src/main/resources/standards/eblissuance/schemas/EBL_ISS_v3.0.0.yaml
@@ -6,21 +6,21 @@ info:
   version: 3.0.0
   title: DCSA eBL Issuance API
   description: |
-    <h1>DCSA OpenAPI specification for the issuance of an electronic Bill of Lading (eBL) via an eBL Solution Provider</h1>
+    <h1>DCSA OpenAPI specification for the issuance of an electronic Bill of Lading (referred to as `eBL`) via an eBL Solution Provider</h1>
 
-    This API is intended as an API between a carrier and a EBL Solution Platform.
+    This API is intended as an API between a carrier and a eBL Solution Platform.
 
-    The EBL Solution Provider is to implement
+    The eBL Solution Provider is to implement
 
         PUT /v3/ebl-issuance-requests
 
     for the carrier to call and the carrier is to implement
 
         POST /v3/ebl-issuance-responses
 
-    for the EBL Solution Provider to call.
+    for the eBL Solution Provider to call.
 
-    When the document is to be surrendered, it should happen via a version of the [DCSA EBL Surrender](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_EBL_SUR/3.0.0) API.
+    When the document is to be surrendered, it should happen via a version of the [DCSA eBL Surrender](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_EBL_SUR/3.0.0) API.
 
     ### API Design & Implementation Principles
     This API follows the guidelines defined in version 2.1 of the API Design & Implementation Principles which can be found on the [DCSA Developer page](https://developer.dcsa.org/api_design)
@@ -29,34 +29,34 @@ info:
     Please look at the following implementation guide for how to create [Digital Signatures](https://developer.dcsa.org/implementing-digital-signatures-for-transport-documents).
 
     ### Changelog and GitHub
-    For a changelog, please click [here](https://github.com/dcsaorg/DCSA-OpenAPI/tree/master/ebl/v3/issuance#v300). Please [create a GitHub issue](https://github.com/dcsaorg/DCSA-OpenAPI/issues/new) if you have any questions/comments.
+    For a changelog, please click [here](https://github.com/dcsaorg/DCSA-OpenAPI/tree/master/ebl/v3/issuance#v300). If you have any questions, feel free to [Contact Us](https://dcsa.org/get-involved/contact-us).
 
     API specification issued by [DCSA.org](https://dcsa.org/).
   license:
     name: Apache 2.0
-    url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
+    url: 'https://www.apache.org/licenses/LICENSE-2.0.html'
   contact:
     name: Digital Container Shipping Association (DCSA)
     url: 'https://dcsa.org'
     email: [email protected]
 tags:
-  - name: Issuance EBL
+  - name: Issuance eBL
     description: |
-      Issuance EBL **implemented** by EBL Solution Platform
+      Issuance eBL **implemented** by eBL Solution Platform
   - name: Issuance Response
     description: |
       Issuance Response **implemented** by carrier
 paths:
   /v3/ebl-issuance-requests:
     put:
       tags:
-        - Issuance EBL
+        - Issuance eBL
       operationId: put-ebl-issuance-requests
-      summary: Request issuance of an EBL
+      summary: Request issuance of an eBL
       description: |
-        Submit a transport document (EBL) for issuance
+        Submit a transport document (eBL) for issuance
 
-        **This endPoint is to be implemented by an EBL Solution Provider for the carrier to call**
+        **This endPoint is to be implemented by an eBL Solution Provider for the carrier to call**
       parameters:
         - $ref: '#/components/parameters/Api-Version-Major'
       requestBody:
@@ -78,7 +78,7 @@ paths:
           description: |
             An Issuance Request is made with a `Transport Document Reference` (TDR), that was used previously to request the issuance of a `Transport Document` (TD). The document is either already issued or an TD with the same TDR.
 
-            The eBL platform will inform the carrier when the carrier needs to act on this document again. If the issuance is pending, then the carrier will be notified via the DCSA_EBL_ISS_RSP API once the issuance process completes. If the issuance has already succeeded, the eBL platform will notify the carrier when there is a surrender request via the DCSA_EBL_SUR API.
+            The eBL platform will inform the carrier when the carrier needs to act on this document again. If the issuance is pending, then the carrier will be notified via the `/v3/ebl-issuance-responses` endPoint once the issuance process completes. If the issuance has already succeeded, the eBL platform will notify the carrier when there is a surrender request via the DCSA_EBL_SUR API.
           headers:
             API-Version:
               $ref: '#/components/headers/API-Version'
@@ -124,7 +124,7 @@ paths:
       description: |
         Submit a response to a carrier issuance request.
 
-        **This endPoint is to be implemented by a carrier for the EBL Solution Provider to call**
+        **This endPoint is to be implemented by a carrier for the eBL Solution Provider to call**
       parameters:
         - $ref: '#/components/parameters/Api-Version-Major'
       requestBody:
@@ -402,7 +402,7 @@ components:
           pattern: ^\S+$
           maxLength: 4
           description: |
-            The EBL platform of the transaction party.
+            The eBL platform of the transaction party.
             The value **MUST** be one of:
             - `WAVE` (Wave)
             - `CARX` (CargoX)
@@ -3235,7 +3235,7 @@ components:
         issuanceResponseCode:
           type: string
           description: |
-            The platforms verdict on the issuance of the EBL  identified by the `transportDocumentReference`
+            The platforms verdict on the issuance of the eBL  identified by the `transportDocumentReference`
 
             Options are:
               - `ISSU`: The document was successfully `ISSU` and successfully delivered to the initial possessor.
@@ -3274,7 +3274,7 @@ components:
       description: |
         An object to capture where the original Transport Document (`Bill of Lading`) will be issued.
 
-        The location can be specified as one of `UN Location Code` or `CountryCode`.
+        **Condition:** The location can be specified as one of `UN Location Code` or `CountryCode`, but not both.
       properties:
         locationName:
           type: string
@@ -3450,7 +3450,7 @@ components:
           pattern: ^\S(?:.*\S)?$
           maxLength: 35
           description: |
-            Reference number assigned to an `Import License` or permit, issued by countries exercising import controls that athorizes the importation of the articles stated in the license. The `Import License` must be valid at time of arrival.
+            Reference number assigned to an `Import License` or permit, issued by countries exercising import controls that authorizes the importation of the articles stated in the license. The `Import License` must be valid at time of arrival.
           example: EMC007123
         issueDate:
           type: string

diff --git a/ebl/src/main/resources/standards/ebl/schemas/EBL_v3.0.0.yaml b/ebl/src/main/resources/standards/ebl/schemas/EBL_v3.0.0.yaml
@@ -8511,7 +8511,7 @@ components:
     ##########################################
     DocumentPartiesShippingInstructions:
       type: object
-      title: Document Parties
+      title: Document Parties (Shipping Instructions)
       description: |
         All `Parties` with associated roles.
 
@@ -8553,7 +8553,7 @@ components:
     ############################
     DocumentPartiesHouseBL:
       type: object
-      title: Document Parties
+      title: Document Parties (House B/L)
       description: |
         All `Parties` with associated roles for this `House Bill of Lading`.