Skip to content
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

SD-350 Update placeofissue-ebl #242

Merged
merged 2 commits into from
Dec 10, 2024
Merged

Conversation

palatsangeetha
Copy link
Collaborator

@palatsangeetha palatsangeetha commented Dec 10, 2024

PR Type

enhancement, documentation


Description

  • Updated the eBL Issuance API documentation to consistently use the term eBL instead of EBL.
  • Improved the contact and changelog information for better clarity and accessibility.
  • Clarified the conditions for specifying the location in the PlaceOfIssue section.
  • Corrected a typo in the description of the Import License reference number.
  • Updated titles in the Document Parties sections to provide more context.

Changes walkthrough 📝

Relevant files
Documentation
EBL_ISS_v3.0.0.yaml
Update and clarify eBL Issuance API documentation and terminology

ebl-issuance/src/main/resources/standards/eblissuance/schemas/EBL_ISS_v3.0.0.yaml

  • Updated terminology to use eBL consistently.
  • Improved contact and changelog information.
  • Clarified conditions for specifying location in PlaceOfIssue.
  • Corrected a typo in the description of Import License.
  • +19/-19 
    EBL_v3.0.0.yaml
    Clarify titles in Document Parties sections                           

    ebl/src/main/resources/standards/ebl/schemas/EBL_v3.0.0.yaml

    • Updated titles for Document Parties sections.
    +2/-2     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity 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

    API Reference
    The error response description references an incorrect API endpoint name (DCSA_EBL_ISS_RSP) that was updated elsewhere to '/v3/ebl-issuance-responses'. This inconsistency should be reviewed.

    Documentation Clarity
    The PlaceOfIssue description states a condition about UN Location Code and CountryCode, but these fields are not shown in the properties section. The documentation should be reviewed for completeness.

    Copy link

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    General
    Ensure consistent API endpoint references throughout the error messages to avoid confusion

    The 409 error response references an incorrect API name 'DCSA_EBL_ISS_RSP' in the
    old code. Update the error message to consistently use '/v3/ebl-issuance-responses'
    as referenced earlier in the API specification.

    ebl-issuance/src/main/resources/standards/eblissuance/schemas/EBL_ISS_v3.0.0.yaml [81]

    -The eBL platform will inform the carrier when the carrier needs to act on this document again. If the issuance is pending, then the carrier will be notified via the `/v3/ebl-issuance-responses` endPoint once the issuance process completes. If the issuance has already succeeded, the eBL platform will notify the carrier when there is a surrender request via the DCSA_EBL_SUR API.
    +The eBL platform will inform the carrier when the carrier needs to act on this document again. If the issuance is pending, then the carrier will be notified via the `/v3/ebl-issuance-responses` endPoint once the issuance process completes. If the issuance has already succeeded, the eBL platform will notify the carrier when there is a surrender request via the `/v3/ebl-surrender` endPoint.
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    Why: The suggestion improves API documentation consistency by standardizing endpoint references, making it clearer for developers to understand the API flow. The change from DCSA_EBL_SUR to /v3/ebl-surrender matches the REST-style format used elsewhere.

    7
    Strengthen constraint language in API specifications to prevent invalid data combinations

    The PlaceOfIssue object's condition statement should be emphasized as a constraint
    using 'MUST' to clearly indicate mutual exclusivity between UN Location Code and
    CountryCode.

    ebl-issuance/src/main/resources/standards/eblissuance/schemas/EBL_ISS_v3.0.0.yaml [3277]

    -**Condition:** The location can be specified as one of `UN Location Code` or `CountryCode`, but not both.
    +**Condition:** The location MUST be specified using either `UN Location Code` or `CountryCode`. These fields are mutually exclusive and cannot be used together.
    • Apply this suggestion
    Suggestion importance[1-10]: 6

    Why: The suggestion enhances API clarity by using stronger, more explicit language (MUST) and explaining the mutual exclusivity constraint more clearly, which helps prevent implementation errors.

    6

    💡 Need additional feedback ? start a PR chat

    @jkosternl jkosternl changed the title SD-350-update placeofissue-ebl SD-350 Update placeofissue-ebl Dec 10, 2024
    @palatsangeetha palatsangeetha removed the request for review from preetamnpr December 10, 2024 13:51
    @palatsangeetha palatsangeetha merged commit e31403f into dev Dec 10, 2024
    1 check passed
    @palatsangeetha palatsangeetha deleted the SD-350-update-placeofissue-ebl branch December 10, 2024 14:47
    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