OVS 3.0: SD-2212: Update vesselName description to recommend dummy vessel naming

[HenrikHL]

User description

SD-2212: Update vesselName to also include a recommendation for dummy vessel naming

---

PR Type

Documentation

---

Description

• Update vesselName field documentation with dummy vessel naming recommendations

• Add guidance for using SMDG Operating Carrier Code prefix

• Clarify dummy vessel identification and naming conventions

---

Diagram Walkthrough

flowchart LR
  A["vesselName field"] --> B["Add dummy vessel guidance"]
  B --> C["SMDG carrier code prefix"]
  B --> D["Alphanumeric suffix rules"]
  B --> E["Uniqueness across carriers"]

Loading

File Walkthrough

	Relevant files
Documentation	OVS_v3.0.1.yaml Enhanced dummy vessel naming documentation                              ovs/v3/OVS_v3.0.1.yaml Add comprehensive dummy vessel naming recommendations to vesselName description Include SMDG Operating Carrier Code prefix requirement for uniqueness Specify alphanumeric suffix rules (up to 10 characters) Add clarification to isDummyVessel field about using vesselName for distinction +13/-0
Configuration changes	styleguide.json Styleguide configuration updates                                                  .stoplight/styleguide.json Configuration file modifications (content not visible due to token limits) +1/-1

---

[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
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

[qodo-code-review]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
General	✅ Strengthen and cross-reference the field description Suggestion Impact: The description text was updated to require using vesselName as a unique identifier when true and added a cross-reference to the vesselName field's naming convention. code diff: - It is possible to use `vesselName` to distinguish different dummy vessels. + When `true`, the `vesselName` must be used as a unique identifier for the dummy vessel. See the `vesselName` field description for the recommended naming convention. Strengthen the isDummyVessel description by making it a requirement to use vesselName as a unique identifier and cross-referencing the vesselName field for the specific naming convention. ovs/v3/OVS_v3.0.1.yaml [363-366] description: | Is this a dummy vessel? In case no vessel has been asigned yet - this property can be set to `true` indicating that the `vesselIMONumber`/`MMSINumber` does not exist. - It is possible to use `vesselName` to distinguish different dummy vessels. + When `true`, the `vesselName` must be used as a unique identifier for the dummy vessel. See the `vesselName` field description for the recommended naming convention. [Suggestion processed] Suggestion importance[1-10]: 7 __ Why: The suggestion improves the clarity and precision of the API specification by changing vague wording to a direct instruction and adding a helpful cross-reference to the vesselName field's naming convention.	Medium
	Clarify description for real and dummy vessels Rephrase the vesselName description to clarify that IMO registration applies only to real vessels, resolving a contradiction with the new note about dummy vessels. ovs/v3/OVS_v3.0.1.yaml [341-344] description: | - The name of the Vessel given by the Vessel Operator and registered with IMO. + The name of the Vessel. For real vessels, this is the name given by the Vessel Operator and registered with IMO. - **Note:** In case the vessel is a "dummy vessel" (`isDummyVessel='true'`) then the following recommendation should be followed: + **Note:** For "dummy vessels" (where `isDummyVessel` is `true`), the following naming convention is recommended to ensure uniqueness: Apply / Chat Suggestion importance[1-10]: 6 __ Why: The suggestion correctly identifies a logical contradiction in the vesselName description and proposes a clearer text that distinguishes between real and dummy vessels, improving the API specification's accuracy.	Low
Update

[Copilot]

Pull Request Overview

This PR updates the OpenAPI specification to enhance documentation for dummy vessel naming conventions in the OVS v3.0.1 schema. The changes provide clear guidance on how to name dummy vessels when no real vessel has been assigned.

• Added comprehensive dummy vessel naming recommendations with SMDG Operating Carrier Code prefix requirements
• Specified alphanumeric suffix rules for maintaining uniqueness across carriers
• Enhanced the isDummyVessel field documentation to reference the new naming conventions

---

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

[Copilot]

Pull Request Overview

Copilot reviewed 1 out of 2 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.}

[Copilot]

Corrected spelling of 'recomend' to 'recommend' in the PR title.