Skip to content

Conversation

@HenrikHL
Copy link
Contributor

@HenrikHL HenrikHL commented Oct 13, 2025

User description

Aligning GitHub with what has been agreed on SwaggerHub


PR Type

Documentation, Enhancement


Description

  • Updated timestamp examples from Zulu time to Amsterdam time with timezone offset

  • Removed terminalCallID field from schema and examples

  • Added vesselOperatorSMDGLinerCode to transport call reference examples

  • Clarified timestamp description to specify UTC instead of local time


Diagram Walkthrough

flowchart LR
  A["API Examples"] -- "timezone update" --> B["Amsterdam time (+01:00)"]
  A -- "remove field" --> C["terminalCallID removed"]
  A -- "add field" --> D["vesselOperatorSMDGLinerCode"]
  E["Schema Documentation"] -- "clarify" --> F["UTC timestamp description"]
Loading

File Walkthrough

Relevant files
Documentation
OVS_HUB_TER_v1.0.0.yaml
Update API specification with timezone, field and documentation
changes

ovs_hub_ter/v1/OVS_HUB_TER_v1.0.0.yaml

  • Changed timestamp examples from Zulu time (Z) to Amsterdam timezone
    (+01:00)
  • Removed terminalCallID field from schema definition and all examples
  • Added vesselOperatorSMDGLinerCode to examples using
    transportCallReference
  • Updated timestamp description from "local date and time" to "UTC date
    and time"
  • Improved formatting of required fields documentation in schema
    description
+20/-23 
Configuration changes
styleguide.json
Update styleguide configuration                                                   

.stoplight/styleguide.json

  • Modified styleguide configuration file
+1/-1     

@qodo-code-review
Copy link

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.

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

@qodo-code-review
Copy link

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
Possible issue
Fix inconsistent timestamp timezone usage

Update timestamp examples to use the UTC timezone to align with the
timestampDateTime field's description, which specifies UTC.

ovs_hub_ter/v1/OVS_HUB_TER_v1.0.0.yaml [49-68]

 description: |
-  Send an `ETA` timestamp for the Vessel: `Jacques Saadé` arriving at `Amsterdam Port` on the 18 of August 2025 at 18.00 Amsterdam time. This example does not include a `transportCallReference`.
+  Send an `ETA` timestamp for the Vessel: `Jacques Saadé` arriving at `Amsterdam Port` on the 18 of August 2025 at 17.00 UTC. This example does not include a `transportCallReference`.
 value:
   ...
   timestampPositionCode: 'PORT'
-  timestampDateTime: '2025-08-18T18:00:00+01:00'
+  timestampDateTime: '2025-08-18T17:00:00Z'

[To ensure code accuracy, apply this suggestion manually]

Suggestion importance[1-10]: 9

__

Why: The suggestion correctly identifies a critical inconsistency where the schema definition for timestampDateTime requires UTC, but all examples in the PR were changed to use a non-UTC timezone, which would confuse API consumers.

High
  • More

@HenrikHL HenrikHL requested a review from Copilot October 13, 2025 08:48
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR aligns the GitHub API specification with SwaggerHub by standardizing timezone examples, removing deprecated fields, and clarifying documentation. The changes focus on consistency and accuracy in the OVS Hub Terminal API specification.

  • Updated timestamp examples from Zulu time (Z) to Amsterdam timezone (+01:00)
  • Removed deprecated terminalCallID field from schema and examples
  • Added vesselOperatorSMDGLinerCode field to transport call reference examples

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

description: |
The local date and time, when the **Vessel** of a **Port Call** is estimated or has happened.
The UTC date and time, when the **Vessel** of a **Port Call** is estimated or has happened.
example: '2025-08-18T17:41:00+08:30'
Copy link

Copilot AI Oct 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The example timestamp uses a different timezone (+08:30) than the Amsterdam timezone (+01:00) used in other examples throughout the file. This inconsistency could confuse API consumers about which timezone format to use.

Suggested change
example: '2025-08-18T17:41:00+08:30'
example: '2025-08-18T17:41:00+01:00'

Copilot uses AI. Check for mistakes.
@HenrikHL HenrikHL merged commit 762ec25 into master Oct 13, 2025
1 check passed
@HenrikHL HenrikHL deleted the Align_GitHub_with_SwaggerHub branch October 13, 2025 08:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants