Add vessel info to Voyage Reference endPoint example

[HenrikHL]

Adds Vessel informtion to the example for the Voyage Reference endPoint

[qodo-code-review]

PR Summary by Qodo

Add vessel details to Voyage Reference endpoint example

📝 Documentation ✨ Enhancement 🕐 Less than 5 minutes

AI Description

• Extend the Voyage Reference endpoint example response with a vessel object.
• Provide realistic vessel identifiers and flags to improve consumer guidance.

Diagram

graph TD
  A[API consumers] --> B["Voyage Reference endpoint"] --> C["OpenAPI spec (YAML)"] --> D["Example payload"]
  D --> E["vessel object"]

  subgraph Legend
    direction LR
    _usr[Consumer] ~~~ _api[API endpoint] ~~~ _doc[Spec/doc] ~~~ _data[Example data]
  end

Loading

High-Level Assessment

The following are alternative approaches to this PR:

1. Reference a reusable example via components/examples

• ➕ Avoids duplication if vessel examples are needed in multiple endpoints
• ➕ Makes it easier to keep vessel example fields consistent across the spec
• ➖ Adds indirection for readers (must navigate to components to see the full example)
• ➖ May be unnecessary if vessel appears only in this single example

2. Expand the schema and keep examples minimal

• ➕ Ensures documentation completeness via schema definitions rather than only examples
• ➕ Improves validation/contract clarity for generated clients
• ➖ Potentially broader change than intended if the schema is already defined elsewhere
• ➖ Requires more review to ensure backward compatibility and correct modeling

Recommendation: The current approach (inline example enrichment) is appropriate for a targeted documentation improvement with minimal risk. If vessel example content will be reused across multiple endpoints, consider extracting it into components/examples to reduce future drift.

Files changed (1) +6 / -0

Documentation (1) +6 / -0

OVS_HUB_REF_v1.0.0.yamlAdd vessel block to Voyage Reference example payload +6/-0

Add vessel block to Voyage Reference example payload

• Extends the Voyage Reference endpoint example to include a 'vessel' object. The example now documents operator SMDG code, IMO number, vessel name, call sign, and dummy-vessel flag.

ovs_hub_ref/v1/OVS_HUB_REF_v1.0.0.yaml

[Copilot]

Pull request overview

Updates the OVS Hub Reference OpenAPI spec to include vessel details in the GET /v1/voyage-references response example, aligning the example payload more closely with the PartnerVoyage schema (which already supports an optional vessel object).

Changes:

• Extended the voyagesExample response example to include a vessel object with operator code, IMO number, name, call sign, and dummy flag.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[qodo-code-review]

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

_{To customize comments, go to the Qodo configuration screen, or learn more in the docs.}