Skip to content

Conversation

@HenrikHL
Copy link
Contributor

@HenrikHL HenrikHL commented Mar 25, 2025

User description

To include:

  • remove Servers list that was wrongly added (we don't have any Virtual servers)
  • Remove the reference to ISO 8601 (all dateTime fields must comply with RFC
  • Improved some descriptions to list enum values
  • Removed link to GitHub reference data for cutoffTimeCodes

Adding you as well @emiliodcsa as a FYI :-)


PR Type

Enhancement, Documentation


Description

  • Updated API version to 1.0.1 and related references.

  • Added routingReference field to PointToPoint schema.

  • Removed references to ISO 8601 in descriptions for clarity.

  • Improved descriptions for carrier code list providers with enumerated values.


Changes walkthrough 📝

Relevant files
Enhancement
CS_v1.X.yaml
Update API version and enhance schema and descriptions     

cs/v1/CS_v1.X.yaml

  • Updated API version to 1.0.1 and adjusted related references.
  • Added routingReference field to PointToPoint schema for booking
    references.
  • Removed ISO 8601 references from date/time descriptions for
    simplicity.
  • Improved descriptions for carrier code list providers with enumerated
    values.
  • +44/-27 

    Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.
  • @qodo-code-review
    Copy link

    Qodo Merge was enabled for this repository. To continue using it, please link your Git account with your Qodo account here.

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    New Field Addition

    A new routingReference field was added to the PointToPoint schema. This field appears to be used for creating bookings in the Booking API. Verify that this addition is properly documented and integrated with the Booking API.

    routingReference:
      type: string
      pattern: ^\S(?:.*\S)?$
      maxLength: 5000
      description: |
        A reference to be used when creating a **Booking** in the **Booking API**.
      example: Route123

    @qodo-code-review
    Copy link

    qodo-code-review bot commented Mar 25, 2025

    Qodo Merge was enabled for this repository. To continue using it, please link your Git account with your Qodo account here.

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    General
    Fix potential broken link

    The changelog link points to a specific version (v1.0.1) which doesn't appear to
    exist yet since this PR is creating that version. Ensure the linked changelog
    section exists before merging this PR to avoid broken links in the
    documentation.

    cs/v1/CS_v1.X.yaml [31]

    -+    For a changelog please click [here](https://github.com/dcsaorg/DCSA-OpenAPI/tree/master/cs/v1#v101). Please also [create a GitHub issue](https://github.com/dcsaorg/DCSA-OpenAPI/issues/new) if you have any questions/comments.
    +For a changelog please click [here](https://github.com/dcsaorg/DCSA-OpenAPI/tree/master/cs/v1#changelog). Please also [create a GitHub issue](https://github.com/dcsaorg/DCSA-OpenAPI/issues/new) if you have any questions/comments.

    [To ensure code accuracy, apply this suggestion manually]

    Suggestion importance[1-10]: 8

    __

    Why: The suggestion correctly identifies a critical issue with the changelog link that points to a specific version (v1.0.1) that may not exist yet. A broken link would negatively impact documentation usability and should be addressed before release.

    Medium
    Consider required field status

    The routingReference field has been added to the PointToPoint schema, but it's
    not included in the required array. If this field is essential for creating
    bookings, consider adding it to the required fields list to ensure it's always
    provided.

    cs/v1/CS_v1.X.yaml [813-819]

    -+        routingReference:
    -+          type: string
    -+          pattern: ^\S(?:.*\S)?$
    -+          maxLength: 5000
    -+          description: |
    -+            A reference to be used when creating a **Booking** in the **Booking API**.
    -+          example: Route123
    +routingReference:
    +  type: string
    +  pattern: ^\S(?:.*\S)?$
    +  maxLength: 5000
    +  description: |
    +    A reference to be used when creating a **Booking** in the **Booking API**.
    +  example: Route123

    [To ensure code accuracy, apply this suggestion manually]

    Suggestion importance[1-10]: 7

    __

    Why: This suggestion identifies an important consideration about the newly added routingReference field. If this field is essential for integration with the Booking API, making it required would prevent potential errors when users try to use the reference later.

    Medium
    • Update

    @HenrikHL HenrikHL requested a review from palatsangeetha March 26, 2025 12:47
    @HenrikHL HenrikHL merged commit c4e1476 into master Mar 28, 2025
    1 check passed
    @HenrikHL HenrikHL deleted the SD-1825_Make-cs-v101 branch March 28, 2025 08:16
    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