Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Test CLI fun in CI #124

Merged
merged 1 commit into from
Aug 30, 2024
Merged

Test CLI fun in CI #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 70 additions & 26 deletions ebl-issuance/src/main/resources/standards/eblissuance/schemas/eblissuance-v3.0.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -424,7 +424,7 @@
"example": "W3C"
},
"partyCode": {
"maxLength": 100,
"maxLength": 150,
"type": "string",
"description": "Code to identify the party as provided by the code list provider\n",
"example": "MSK"
Expand Down Expand Up @@ -462,7 +462,7 @@
"example": "DK"
},
"value": {
"maxLength": 100,
"maxLength": 35,
"pattern": "^\\S(?:.*\\S)?$",
"type": "string",
"description": "The value of the `taxLegalReference`\n",
Expand Down Expand Up @@ -553,28 +553,28 @@
"numberOfCopiesWithCharges": {
"minimum": 0,
"type": "integer",
"description": "The requested number of copies of the Transport document to be issued by the carrier including charges. Only applicable for physical (paper) documents",
"description": "The requested number of copies of the `Transport Document` to be issued by the carrier including charges.",
"format": "int32",
"example": 2
},
"numberOfCopiesWithoutCharges": {
"minimum": 0,
"type": "integer",
"description": "The requested number of copies of the Transport document to be issued by the carrier **NOT** including charges. Only applicable for physical (paper) documents",
"description": "The requested number of copies of the `Transport Document` to be issued by the carrier **NOT** including charges.",
"format": "int32",
"example": 2
},
"numberOfOriginalsWithCharges": {
"minimum": 0,
"type": "integer",
"description": "Number of originals of the bill of lading that has been requested by the customer with charges. Only applicable for physical documents.\n",
"description": "Number of originals of the Bill of Lading that has been requested by the customer with charges.\n \n**Condition:** Only applicable if `transportDocumentType` = `BOL` (Bill of Lading). If `isElectronic = 'True'`, accepted value is `1` (one) or `0` (zero)\n",
"format": "int32",
"example": 1
},
"numberOfOriginalsWithoutCharges": {
"minimum": 0,
"type": "integer",
"description": "Number of originals of the bill of lading that has been requested by the customer without charges. Only applicable for physical documents.\n",
"description": "Number of originals of the Bill of Lading that has been requested by the customer without charges.\n \n**Condition:** Only applicable if `transportDocumentType` = `BOL` (Bill of Lading). If `isElectronic = 'True'`, accepted value is `1` (one) or `0` (zero)\n",
"format": "int32",
"example": 1
},
Expand Down Expand Up @@ -628,6 +628,13 @@
"format": "date",
"example": "2020-12-12"
},
"displayedShippedOnBoardReceivedForShipment": {
"maxLength": 250,
"pattern": "^\\S(?:.*\\S)?$",
"type": "string",
"description": "The text to be displayed on the `Transport Document` as evidence that the goods have been received for shipment or shipped on board.\n",
"example": "Received for Shipment CMA CGM CONCORDE 28-Jul-2022 CMA CGM Agences France SAS As agents for the Carrier"
},
"termsAndConditions": {
"maxLength": 50000,
"type": "string",
Expand Down Expand Up @@ -696,7 +703,7 @@
"declaredValue": {
"minimum": 0,
"type": "number",
"description": "The value of the cargo that the shipper declares to avoid the carrier's limitation of liability and \"Ad Valorem\" freight, i.e. freight which is calculated based on the value of the goods declared by the shipper.\n",
"description": "The value of the cargo that the shipper declares in order to avoid the carrier's limitation of liability and \"Ad Valorem\" freight, i.e., freight which is calculated based on the value of the goods declared by the shipper.\n\n**Condition:** Included in the transport document upon customer request. If customers want the value to show, evidence is required, and customers need to approve additional insurance fee charge from the carrier (very exceptional).\n",
"format": "float",
"example": 1231.1
},
Expand Down Expand Up @@ -913,7 +920,8 @@
"example": "CR"
},
"value": {
"maxLength": 100,
"maxLength": 35,
"pattern": "^\\S(?:.*\\S)?$",
"type": "string",
"description": "The value of the reference. \n",
"example": "HHL00103004"
Expand Down Expand Up @@ -1013,7 +1021,7 @@
"maxLength": 10,
"pattern": "^\\S(?:.*\\S)?$",
"type": "string",
"description": "The national commodity classification code, which can be one of the following values defined by DCSA:\n- `NCM` (Nomenclatura Comum do Mercosul)\n- `HTS` (Harmonized Tariff Schedule)\n- `Schedule B` ( Schedule B)\n- `TARIC` (Integrated Tariff of the European Communities)\n- `CN` (Combined Noemclature)\n- `CUS` (Customs Union and Statistics)\n",
"description": "The national commodity classification code, which can be one of the following values defined by DCSA:\n- `NCM` (Nomenclatura Comum do Mercosul)\n- `HTS` (Harmonized Tariff Schedule)\n- `Schedule B` ( Schedule B)\n- `TARIC` (Integrated Tariff of the European Communities)\n- `CN` (Combined Nomenclature)\n- `CUS` (Customs Union and Statistics)\n",
"example": "NCM"
},
"countryCode": {
Expand Down Expand Up @@ -1050,7 +1058,7 @@
"required": [
"countryCode",
"type",
"value"
"values"
],
"type": "object",
"properties": {
Expand All @@ -1069,12 +1077,16 @@
"description": "The 2 characters for the country code using [ISO 3166-1 alpha-2](https://www.iso.org/obp/ui/#iso:pub:PUB500001:en)\n",
"example": "DK"
},
"value": {
"maxLength": 100,
"pattern": "^\\S(?:.*\\S)?$",
"type": "string",
"description": "The value of the `customsReference`\n",
"example": "4988470982020120017"
"values": {
"minItems": 1,
"type": "array",
"items": {
"maxLength": 35,
"pattern": "^\\S(?:.*\\S)?$",
"type": "string",
"description": "The value of the `customsReference`\n",
"example": "4988470982020120017"
}
}
},
"description": "Reference associated with customs and/or excise purposes required by the relevant authorities for the import, export, or transit of the goods.\n\nA (small) list of examples:\n\n| Type | Country | Description |\n|-------|:-------:|-------------|\n|ACID|EG|Advance Cargo Information Declaration in Egypt|\n|CERS|CA|Canadian Export Reporting System|\n|ITN|US|Internal Transaction Number in US|\n|PEB|ID|PEB reference number|\n|CSN|IN|Cargo Summary Notification (CSN)|\n\nAllowed combinations of `type` and `country` are maintained in [GitHub](https://github.com/dcsaorg/DCSA-OpenAPI/blob/master/domain/documentation/reference-data/customsreferences-v300.csv).\n"
Expand Down Expand Up @@ -1133,6 +1145,13 @@
"outerPackaging": {
"$ref": "#/components/schemas/OuterPackaging"
},
"nationalCommodityCodes": {
"type": "array",
"description": "A list of `National Commodity Codes` that apply to this `cargoItem`\n",
"items": {
"$ref": "#/components/schemas/NationalCommodityCode"
}
},
"customsReferences": {
"type": "array",
"description": "A list of `Customs references`\n",
Expand Down Expand Up @@ -1547,7 +1566,7 @@
},
"shippingMarks": {
"type": "array",
"description": "A list of the `ShippingMarks` applicable to this `consignmentItem`\n",
"description": "A list of the `ShippingMarks` applicable to this `UtilizedTransportEquipment`\n",
"items": {
"maxLength": 500,
"type": "string",
Expand Down Expand Up @@ -1636,7 +1655,7 @@
},
"source": {
"type": "string",
"description": "The source of the seal, namely who has affixed the seal. This attribute links to the Seal Source ID defined in the Seal Source reference data entity.\n- `CAR` (Carrier)\n- `SHI` (Shipper)\n- `VET` (Veterinary)\n- `CUS` (Customs)\n",
"description": "The source of the seal, namely who has affixed the seal.\n- `CAR` (Carrier)\n- `SHI` (Shipper)\n- `VET` (Veterinary)\n- `CUS` (Customs)\n\n**Condition:** Seal source may be required depending on the type of commodity being shipped.\n",
"example": "CUS",
"enum": [
"CAR",
Expand Down Expand Up @@ -2301,7 +2320,6 @@
},
"displayedAddress": {
"maxItems": 999,
"minItems": 1,
"type": "array",
"description": "The address of the party to be displayed on the `Transport Document`. The displayed address may be used to match the address provided in the `Letter of Credit`. For physical BL (`isElectronic=false`), it is only allowed to provide max 2 lines of 35 characters. No limit for electronic BL (`isElectronic=true`).\n\n**Condition:** if provided, the displayed address must be included in the Transport Document.\n",
"items": {
Expand Down Expand Up @@ -2332,14 +2350,14 @@
}
},
"shippersReference": {
"maxLength": 100,
"maxLength": 35,
"pattern": "^\\S(?:.*\\S)?$",
"type": "string",
"description": "A reference linked to the `Shipper`.\n",
"example": "HHL007"
},
"shippersPurchaseOrderReference": {
"maxLength": 100,
"maxLength": 35,
"pattern": "^\\S(?:.*\\S)?$",
"type": "string",
"description": "A reference linked to the `Shipper Purchase Order`.\n",
Expand Down Expand Up @@ -2367,7 +2385,6 @@
},
"displayedAddress": {
"maxItems": 999,
"minItems": 1,
"type": "array",
"description": "The address of the party to be displayed on the `Transport Document`. The displayed address may be used to match the address provided in the `Letter of Credit`. For physical BL (`isElectronic=false`), it is only allowed to provide max 2 lines of 35 characters. No limit for electronic BL (`isElectronic=true`).\n\n**Condition:** if provided, the displayed address must be included in the Transport Document.\n",
"items": {
Expand Down Expand Up @@ -2398,14 +2415,14 @@
}
},
"consigneesReference": {
"maxLength": 100,
"maxLength": 35,
"pattern": "^\\S(?:.*\\S)?$",
"type": "string",
"description": "A reference linked to the `Consignee`.\n",
"example": "HHL007"
},
"consigneesPurchaseOrderReference": {
"maxLength": 100,
"maxLength": 35,
"pattern": "^\\S(?:.*\\S)?$",
"type": "string",
"description": "A reference linked to the `Consignee Purchase Order`.\n",
Expand Down Expand Up @@ -2433,7 +2450,6 @@
},
"displayedAddress": {
"maxItems": 999,
"minItems": 1,
"type": "array",
"description": "The address of the party to be displayed on the `Transport Document`. The displayed address may be used to match the address provided in the `Letter of Credit`. For physical BL (`isElectronic=false`), it is only allowed to provide max 2 lines of 35 characters. No limit for electronic BL (`isElectronic=true`).\n\n**Condition:** if provided, the displayed address must be included in the Transport Document.\n",
"items": {
Expand Down Expand Up @@ -2533,7 +2549,7 @@
}
},
"reference": {
"maxLength": 100,
"maxLength": 35,
"pattern": "^\\S(?:.*\\S)?$",
"type": "string",
"description": "A reference linked to the `Party`.\n",
Expand Down Expand Up @@ -2583,6 +2599,26 @@
},
"description": "Refers to a company or a legal entity.\n"
},
"IssuanceError": {
"title": "Issuance Error",
"type": "object",
"properties": {
"reason": {
"maxLength": 255,
"pattern": "^\\S(?:.*\\S)?$",
"type": "string",
"description": "Human readable description of the rationale for an unsuccessful issuance.\n\nThe `reason` should be omitted when the `issuanceResponseCode` is `ISSU`. If the platform for some reason chooses to deviate from this and provide the field anyway, they should use canned phrased like `Issued` that matches the meaning of the `issuanceResponseCode`.\n",
"example": "Cannot get..."
},
"errorCode": {
"maxLength": 50,
"pattern": "^\\S+$",
"type": "string",
"description": "A vendor provided error code.\n\nThe meaning of each code is agreed bilaterally between the vendor.\n",
"example": "ERR-1234"
}
}
},
"IssuanceResponse": {
"title": "Issuance Response",
"required": [
Expand Down Expand Up @@ -2614,6 +2650,14 @@
"type": "string",
"description": "Human readable description of the rationale for an unsuccessful issuance.\n\nThe `reason` should be omitted when the `issuanceResponseCode` is `ISSU`. If the platform for some reason chooses to deviate from this and provide the field anyway, they should use canned phrased like `Issued` that matches the meaning of the `issuanceResponseCode`.\n",
"example": "Cannot get..."
},
"errors": {
"maxItems": 255,
"type": "array",
"description": "A list of errors if the issuance failed for some reason.\n",
"items": {
"$ref": "#/components/schemas/IssuanceError"
}
}
}
},
Expand Down
2 changes: 1 addition & 1 deletion ebl/src/main/resources/standards/ebl/messages/ebl-api-3.0.0-amf.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
{
"type": "CTN",
"countryCode": "SN",
"value": "12345"
"values": ["12345"]
}
],
"utilizedTransportEquipments": [
Expand Down
2 changes: 1 addition & 1 deletion ebl/src/main/resources/standards/ebl/messages/ebl-api-3.0.0-soc-references.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
{
"type": "CTN",
"countryCode": "SN",
"value": "12345"
"values": ["12345"]
}
],
"utilizedTransportEquipments": [
Expand Down
Loading
Loading