-
Notifications
You must be signed in to change notification settings - Fork 16
Align GitHub with SwaggerHub #567
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
PR Compliance Guide 🔍Below is a summary of compliance checks for this PR:
Compliance status legend🟢 - Fully Compliant🟡 - Partial Compliant 🔴 - Not Compliant ⚪ - Requires Further Human Verification 🏷️ - Compliance label |
||||||||||||||||||
PR Code Suggestions ✨Explore these optional code suggestions:
|
|||||||||
There was a problem hiding this 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
terminalCallIDfield from schema and examples - Added
vesselOperatorSMDGLinerCodefield 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' |
Copilot
AI
Oct 13, 2025
There was a problem hiding this comment.
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.
| example: '2025-08-18T17:41:00+08:30' | |
| example: '2025-08-18T17:41:00+01:00' |
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
terminalCallIDfield from schema and examplesAdded
vesselOperatorSMDGLinerCodeto transport call reference examplesClarified timestamp description to specify UTC instead of local time
Diagram Walkthrough
File Walkthrough
OVS_HUB_TER_v1.0.0.yaml
Update API specification with timezone, field and documentationchangesovs_hub_ter/v1/OVS_HUB_TER_v1.0.0.yaml
(+01:00)
terminalCallIDfield from schema definition and all examplesvesselOperatorSMDGLinerCodeto examples usingtransportCallReferenceand time"
description
styleguide.json
Update styleguide configuration.stoplight/styleguide.json