Skip to content

Commit afdbda4

Browse files
authored
OVS 3.0: SD-2532: Create "What's New" (#571)
1 parent 4a8de8e commit afdbda4

File tree

1 file changed

+43
-5
lines changed

1 file changed

+43
-5
lines changed

ovs/v3/README.md

Lines changed: 43 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,54 @@
11
## DCSA OVS API
22

3-
The DCSA OVS API is documented on [**OVS SwaggerHub**](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_OVS).
3+
The DCSA OVS API is documented on [**SwaggerHub**](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_OVS).
44

55
The primary purpose of this API is to specify endPoints for schedules shared between Vessel Partners.
66

7-
## <a name="v300"></a>[Release v3.0.0 (15 January 2024)](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_OVS/3.0.0-Beta-2)
7+
<a name="v301"></a>[Release v3.0.1 (TBD)](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_OVS/3.0.1)
88
---
9+
A minor update to improve the usage of OVS.
10+
11+
Bigger changes:
12+
- added an `MMSINumber` filter to the GET endPoint
13+
- added a `vesselOperatorSMDGLinerCode` filter to the GET endPoint
14+
- removed the `ISO 8601` reference in `startDate` and `endDate` descriptions
15+
- added a `cursor` query parameter to the GET endPoint for paginated results
16+
- changed the requirements for the `API-Version` header. Going forward, the entire version (SemVer) should be included - not only the major version. This enables the provider to identify the consumer’s version.
17+
- `Next-Page-Cursor` header added to `200` (Ok) responses
18+
- description modified for `vesselIMONumber` in case the `VesselSchedule` refers to a non-dummy-vessel. The condition has been modified and the `vesselIMONumber` is no longer mandatory - a `MMSINumber` can also be provided.
19+
- `MMSINumber` added next to `vesselIMONumber`. This allows carriers to provide an `MMSInumber` when available, whether or not an `vesselIMOnumber` is provided.
20+
- `vesselName` description improved with recommedation to standardize dummy vessels names
21+
- `isDummyVessel` description improved to mention `vesselName` usage to make the dummy vessel unique
22+
- `9999R` is to be used as placeholder when `carrierImportVoyageNumber` is unknown or not applicable. This allows carriers to provide a pseudo import voyage number in edge cases (e.g., dry dock) without failing validation on the required field.
23+
- `statusCode` in `TransportCall` object **deprecated** - use `statusCodes` instead
24+
- `statusCodes` added to `TransportCall` and to be used instead of `statusCode`. This allows OVS implementers to submit multiple statuses for a transport call, reflecting real-world scenarios where more than one status may apply.
25+
- `delayReasonCode` in `Timestamp` object **deprecated** - use `delayReasonCodes` instead
26+
- `delayReasonCodes` added to `Timestamp` and to be used instead of `delayReasonCode`. This allows OVS implementers to submit multiple delay reasons for a timestamp, reflecting real-world scenarios where more than one cause may apply.
27+
28+
Minor changes:
29+
- improved layout of descriptions
30+
- updated the 'Contact us' link
31+
- removed the `servers` as it was wrongly added
32+
- removed `required=false` from query parameters, as this is the default
33+
- added `operationId` to the GET endPoint
34+
- improved the `limit` query parameter description
35+
- improved error examples
36+
- description added to `ServiceSchedule`, `VesselSchedule`
37+
- improved `title` in objects where a space was missing
38+
- GitHub reference removed from `eventTypeCode` property
39+
- `eventClassifierCode` description updated. Additional guidance provided in the API on when to send planned, estimated, and actual timestamps, clarifying semantics so implementers can align expectations with partners.
40+
- `ISO 8601` reference removed from `errorDateTime` property in the `ErrorResponse` object
41+
- removed unused parameter declarations
42+
43+
44+
<a name="v300"></a>[Release v3.0.0 (15 January 2024)](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_OVS/3.0.0)
45+
---
46+
Release of OVS 3.0.0
947

1048
- Aligns with v3.0.0 Beta 2.
1149

12-
## <a name="v300B2"></a>[Release v3.0.0 Beta 2 (15 January 2024)](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_OVS/3.0.0-Beta-2)
50+
51+
<a name="v300B2"></a>[Release v3.0.0 Beta 2 (15 January 2024)](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_OVS/3.0.0-Beta-2)
1352
---
1453
- Description updated.
1554
- carrierServiceName added as a queryParameter
@@ -21,8 +60,7 @@ The primary purpose of this API is to specify endPoints for schedules shared bet
2160
- Error schema updated.
2261

2362

24-
25-
## <a name="v300B1"></a>[Release v3.0.0 Beta 1 (30 June 2022)](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_OVS/3.0.0-Beta-1)
63+
<a name="v300B1"></a>[Release v3.0.0 Beta 1 (30 June 2022)](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_OVS/3.0.0-Beta-1)
2664
---
2765
This API primarily defines endPoints and otherwise uses the following Domains:
2866
- Event Domain

0 commit comments

Comments
 (0)