OVS 3.0: SD-2532: Create "What's New"

[HenrikHL]

PR Type

Documentation

---

Description

• Added comprehensive "What's New" section for OVS v3.0.1 release

• Documented major changes including new filters and query parameters

• Listed deprecated fields and their replacements

• Included minor improvements and documentation updates

---

Diagram Walkthrough

flowchart LR
  A["OVS v3.0.1 Release Notes"] --> B["Major Changes"]
  A --> C["Minor Changes"]
  B --> D["New Filters: MMSI, Operator Code"]
  B --> E["Pagination: cursor parameter"]
  B --> F["Deprecated: statusCode, delayReasonCode"]
  C --> G["Documentation Improvements"]
  C --> H["Layout & Description Updates"]

Loading

File Walkthrough

Relevant files

Documentation

README.md Add OVS v3.0.1 release notes and changelog                              ovs/v3/README.md Added new v3.0.1 release section with comprehensive changelog Documented major changes including MMSINumber and vesselOperatorSMDGLinerCode filters Added cursor parameter for pagination and API-Version header requirements Listed deprecated fields (statusCode, delayReasonCode) with replacements Included minor improvements covering documentation layout and error handling Reorganized release history with v3.0.0 and Beta 2 sections +43/-5

---

[qodo-code-review]

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢	No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
⚪	🎫 No ticket provided - [ ] Create ticket/issue <!-- /create_ticket --create_ticket=true --> </details></td></tr>
Codebase Duplication Compliance
⚪	Codebase context is not defined Follow the guide to enable codebase context checks.
Custom Compliance
⚪	No custom compliance provided Follow the guide to enable custom compliance check.
Update

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

[Copilot]

Pull Request Overview

This PR adds release notes for OVS API version 3.0.1, documenting new features and improvements. The update primarily focuses on enhanced filtering capabilities, pagination support, and deprecation of singular fields in favor of plural equivalents.

Key changes:

• Added comprehensive v3.0.1 release notes with major and minor changes
• Updated SwaggerHub link to remove "OVS" prefix for consistency
• Standardized heading formatting by removing "##" prefix from version anchors

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[qodo-code-review]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
High-level	Reconsider API versioning for these changes The API changes documented for v3.0.1, such as new features and deprecations, should be released under a minor version like v3.1.0 instead of a patch version, to comply with Semantic Versioning principles. This change would better reflect the magnitude of the updates to API consumers. Examples: ovs/v3/README.md [7-26] <a name="v301"></a>[Release v3.0.1 (TBD)](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_OVS/3.0.1) --- A minor update to improve the usage of OVS. Bigger changes: - added a `MMSINumber` filter to the GET endPoint - added a `vesselOperatorSMDGLinerCode` filter to the GET endPoint - removed the `ISO 8601` reference in `startDate` and `endDate` descriptions - added a `cursor` query parameter to the GET endPoint for paginated results - changed the requirements for the `API-Version` header. Going forward the entire version (SemVer) should be included and not only the major version. This will be used for provider to know consumer version. ... (clipped 10 lines) Solution Walkthrough: Before: <a name="v301"></a>[Release v3.0.1 (TBD)](...) --- A minor update to improve the usage of OVS. Bigger changes: - added a `MMSINumber` filter to the GET endPoint - added a `vesselOperatorSMDGLinerCode` filter to the GET endPoint - added a `cursor` query parameter to the GET endPoint for paginated results - `statusCode` in `TransportCall` object **deprecated** - use `statusCodes` instead - `delayReasonCode` in `Timestamp` object **deprecated** - use `delayReasonCodes` instead ... <a name="v300"></a>[Release v3.0.0 (15 January 2024)](...) After: <a name="v310"></a>[Release v3.1.0 (TBD)](...) --- A minor update to improve the usage of OVS. Bigger changes: - added a `MMSINumber` filter to the GET endPoint - added a `vesselOperatorSMDGLinerCode` filter to the GET endPoint - added a `cursor` query parameter to the GET endPoint for paginated results - `statusCode` in `TransportCall` object **deprecated** - use `statusCodes` instead - `delayReasonCode` in `Timestamp` object **deprecated** - use `delayReasonCodes` instead ... <a name="v300"></a>[Release v3.0.0 (15 January 2024)](...) Suggestion importance[1-10]: 8 __ Why: The suggestion correctly identifies that the documented API changes (new features, deprecations) warrant a minor version bump (e.g., v3.1.0) according to Semantic Versioning, not a patch release (v3.0.1), which is a significant issue for API consumer expectations and release communication.	Medium
Update

[Copilot]

Pull Request Overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[emiliodcsa]

Hi Henrik, have reviewed it and added some small changes to the text. They are ready to copy paste for you : )

[HenrikHL]

@emiliodcsa I updated according to your (good) comments. I will merge. Let me know if more needs to be fixed and we can make a new PR 👍