Skip to content

Conversation

@HenrikHL
Copy link
Contributor

@HenrikHL HenrikHL commented Sep 19, 2025

User description

SD-2448: Rename Just in Time Port Calls -> Port Calls (JIT)


PR Type

Documentation


Description

  • Rename API title from "Just in Time Port Calls" to "Port Calls (JIT)"

  • Update API description to use "Port Call (JIT)" terminology


Diagram Walkthrough

flowchart LR
  A["Just in Time Port Calls API"] --> B["Port Calls (JIT) API"]
  C["Just In Time Port Call description"] --> D["Port Call (JIT) description"]
Loading

File Walkthrough

Relevant files
Documentation
JIT_v2.0.0.yaml
Rename API title and description terminology                         

jit/v2/JIT_v2.0.0.yaml

  • Update API title from "DCSA Just in Time Port Calls API" to "DCSA Port
    Calls (JIT) API"
  • Modify description header from "Just in Time Port Call process" to
    "Port Call (JIT) process"
  • Change description text to use "Port Call (JIT)" instead of "Just In
    Time Port Call"
+3/-3     

@qodo-code-review
Copy link

qodo-code-review bot commented Sep 19, 2025

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis 🔶

SD-2448 - Partially compliant

Compliant requirements:

  • Rename "Just in Time Port Call" to "Port Call (JIT)" in API title.
  • Update description header to "Port Call (JIT) process".
  • Update descriptive text to use "Port Call (JIT)" terminology.

Non-compliant requirements:

  • Update Developer Portal guide URL to /implementing-port-call-standard.
  • Ensure site hero/title and landing pages reflect "Port Call (JIT)" (portal content not in this PR).
  • Explicit mention of "Standard version 2.0" in narrative (beyond version field) if required by portal content.
  • Clarify/adjust Event Publisher and Consumer sections on the portal.
  • Validate and update all related portal links (design principles, conformance, sandbox, scenarios).

Requires further human verification:

  • Visual check on developer portal pages to confirm updated titles/hero and navigation labels.
  • Verify redirects from old JIT URL to the new /implementing-port-call-standard.
  • Content review of Event Publisher/Consumer sections to decide retention and wording.
⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Consistency

Ensure "Port Call (JIT)" terminology is consistently applied throughout the entire spec (tags, operation summaries/descriptions, externalDocs) beyond the info block touched here.

title: |
  DCSA Port Calls (JIT) API
description: |
  # DCSA OpenAPI specification for Port Call (JIT) process
  The DCSA API for **Port Call (JIT)** aims to simplify and standardize the exchange of operational information between carriers, terminals, port authorities, and service providers, to orchestrate and optimize port calls. JIT can be used for negotiating services execution via timestamps, informing timestamps, or informing moves forecasts, between the parties involved in any given location.

  The planning and execution of events always follow the same pattern, in which several instances of the estimated (`E`), requested (`R`), and planned (`P`) times (from now on referred to as: `ERP`-pattern) can occur if a new estimated or requested time is given after the initially planned time. Some events, specified in this document, do not need the `ERP`-pattern, as they are informative and reflect actuals (`A`) only (i.e. vessel readiness for cargo operations).

  For more information about the `ERP`-pattern please check [GUIDELINES FOR HARMONIZED COMMUNICATION AND ELECTRONIC EXCHANGE OF OPERATIONAL DATA FOR PORT CALLS](https://wwwcdn.imo.org/localresources/en/OurWork/Facilitation/FAL%20related%20nonmandatory%20documents/FAL.5-Circ.52.pdf) by IMO. Link to IMO GIA [Just In Time Arrival Guide](https://greenvoyage2050.imo.org/wp-content/uploads/2021/01/GIA-just-in-time-hires.pdf).
Backward Compatibility

Changing the API title/description should not affect clients, but validate any tooling or generated documentation that keys off the title string (e.g., doc sites, anchors).

title: |
  DCSA Port Calls (JIT) API
description: |
  # DCSA OpenAPI specification for Port Call (JIT) process
  The DCSA API for **Port Call (JIT)** aims to simplify and standardize the exchange of operational information between carriers, terminals, port authorities, and service providers, to orchestrate and optimize port calls. JIT can be used for negotiating services execution via timestamps, informing timestamps, or informing moves forecasts, between the parties involved in any given location.

  The planning and execution of events always follow the same pattern, in which several instances of the estimated (`E`), requested (`R`), and planned (`P`) times (from now on referred to as: `ERP`-pattern) can occur if a new estimated or requested time is given after the initially planned time. Some events, specified in this document, do not need the `ERP`-pattern, as they are informative and reflect actuals (`A`) only (i.e. vessel readiness for cargo operations).

  For more information about the `ERP`-pattern please check [GUIDELINES FOR HARMONIZED COMMUNICATION AND ELECTRONIC EXCHANGE OF OPERATIONAL DATA FOR PORT CALLS](https://wwwcdn.imo.org/localresources/en/OurWork/Facilitation/FAL%20related%20nonmandatory%20documents/FAL.5-Circ.52.pdf) by IMO. Link to IMO GIA [Just In Time Arrival Guide](https://greenvoyage2050.imo.org/wp-content/uploads/2021/01/GIA-just-in-time-hires.pdf).

@qodo-code-review
Copy link

qodo-code-review bot commented Sep 19, 2025

PR Code Suggestions ✨

No code suggestions found for the PR.

@HenrikHL HenrikHL requested a review from emiliodcsa September 19, 2025 11:28
@HenrikHL HenrikHL merged commit 6042979 into master Sep 19, 2025
1 check passed
@HenrikHL HenrikHL deleted the SD-2448_Rename-JIT branch September 19, 2025 11:50
Copy link
Contributor

@emiliodcsa emiliodcsa left a comment

Choose a reason for hiding this comment

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

looks good for me and kris.

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.

3 participants