dcsaorg / DCSA-OpenAPI

DCSA - Digital Container Shipping Association
https://app.swaggerhub.com/apis/dcsaorg/DCSA_OAS
68 stars 13 forks source link

SD-1798: Merge timestamp endPoints #450

Closed HenrikHL closed 4 days ago

HenrikHL commented 4 days ago

User description

SD-1798: Merge timestamp endPoints into a single endPoint

Moves timestamps, cancelled and declined from the Specification object --> PortCallService object


PR Type

enhancement


Description


Changes walkthrough πŸ“

Relevant files
Enhancement
JIT_v2.0.0.yaml
Consolidate timestamp endpoints and schemas in JIT API     

jit/v2/JIT_v2.0.0.yaml
  • Merged multiple timestamp endpoints into a single endpoint.
  • Updated schema references from specific timestamp types to a unified
    Timestamp.
  • Added timestamps, cancelled, and declined fields to the
    PortCallService object.
  • Removed specific timestamp schemas and consolidated them into a single
    Timestamp schema.
  • +68/-342
    Additional files (token-limit)
    styleguide.json
    ...                                                                                                           

    .stoplight/styleguide.json ...
    +2/-2     

    πŸ” To retrieve JIRA tickets as context to your PR description, please register your organization.

    codiumai-pr-agent-pro[bot] commented 4 days ago

    PR Reviewer Guide πŸ”

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 3 πŸ”΅πŸ”΅πŸ”΅βšͺβšͺ
    πŸ§ͺ No relevant tests
    πŸ”’ No security concerns identified
    ⚑ Recommended focus areas for review

    API Breaking Change
    Merging multiple timestamp endpoints into a single endpoint is a breaking change that will require client updates. Validate that all existing functionality is preserved in the new unified endpoint. Missing Properties
    The new unified Timestamp schema appears to be missing some properties that existed in the original schemas like delayReasonCode, isFYI and remark. Verify if these fields should be preserved. Validation Rules
    New conditions added for classifierCode usage between consumer/provider need careful review to ensure proper access control and data validation.
    codiumai-pr-agent-pro[bot] commented 4 days ago

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    General
    βœ… Fix incorrect API endpoint URL in example documentation to prevent confusion ___ **Fix the typo in the example requestUri which shows 'ztimestamp' instead of
    'timestamp'. This could cause confusion for API consumers and documentation readers.** [jit/v2/JIT_v2.0.0.yaml [348]](https://github.com/dcsaorg/DCSA-OpenAPI/pull/450/files#diff-9515d70681d4860776aad1fa65c622e5b362021ad1f0c0ae1352067f49108299R348-R348) ```diff -requestUri: /v2/port-call-services/085a3207-5e45-49cf-8e1b-f8442beaf545/ztimestamp +requestUri: /v2/port-call-services/085a3207-5e45-49cf-8e1b-f8442beaf545/timestamp ``` `[Suggestion has been applied]`
    Suggestion importance[1-10]: 8 Why: The typo in the example URL ('ztimestamp' instead of 'timestamp') could mislead API consumers and cause integration issues. This is particularly important as it's in the API documentation example section.
    8

    πŸ’‘ Need additional feedback ? start a PR chat