Skip to content

Conversation

@HenrikHL
Copy link
Contributor

@HenrikHL HenrikHL commented Nov 11, 2025

User description

SD-2650: Update latitude and longitude descriptions to make it clear the value is expressed using ISO 6709 data interchange numeric format


PR Type

Documentation


Description

  • Update latitude and longitude descriptions across multiple API specs

  • Clarify values use ISO 6709 data interchange numeric format

  • Update release notes in all affected API versions


Diagram Walkthrough

flowchart LR
  A["API Specifications<br/>BKG, EBL, EBL ISS, PINT"] -- "Update GeoCoordinate<br/>descriptions" --> B["ISO 6709 Format<br/>Clarification"]
  A -- "Update release notes" --> C["README Files"]
  B --> D["Decimal degrees format<br/>specification"]
Loading

File Walkthrough

Relevant files
Documentation
BKG_v2.0.3.yaml
Update GeoCoordinate descriptions with ISO 6709 format     

bkg/v2/BKG_v2.0.3.yaml

  • Updated latitude description to specify ISO 6709 data interchange
    numeric format
  • Updated longitude description to specify ISO 6709 data interchange
    numeric format
  • Changed descriptions from generic geographic coordinate definitions to
    format-specific ones
+4/-2     
README.md
Add ISO 6709 format clarification to release notes             

bkg/v2/README.md

  • Added release note clarifying latitude and longitude use ISO 6709 data
    interchange numeric format
+1/-0     
EBL_v3.0.2.yaml
Update GeoCoordinate descriptions with ISO 6709 format     

ebl/v3/EBL_v3.0.2.yaml

  • Updated latitude description to specify ISO 6709 data interchange
    numeric format
  • Updated longitude description to specify ISO 6709 data interchange
    numeric format
  • Changed descriptions from generic geographic coordinate definitions to
    format-specific ones
+4/-2     
README.md
Add ISO 6709 format clarification to release notes             

ebl/v3/README.md

  • Added release note clarifying latitude and longitude use ISO 6709 data
    interchange numeric format
+1/-0     
EBL_ISS_v3.0.2.yaml
Update GeoCoordinate descriptions with ISO 6709 format     

ebl/v3/issuance/EBL_ISS_v3.0.2.yaml

  • Updated latitude description to specify ISO 6709 data interchange
    numeric format
  • Updated longitude description to specify ISO 6709 data interchange
    numeric format
  • Changed descriptions from generic geographic coordinate definitions to
    format-specific ones
+4/-2     
README.md
Add ISO 6709 format clarification to release notes             

ebl/v3/issuance/README.md

  • Added release note clarifying latitude and longitude use ISO 6709 data
    interchange numeric format
+1/-0     
EBL_PINT_v3.0.0.yaml
Update GeoCoordinate descriptions with ISO 6709 format     

pint/v3/EBL_PINT_v3.0.0.yaml

  • Updated latitude description to specify ISO 6709 data interchange
    numeric format
  • Updated longitude description to specify ISO 6709 data interchange
    numeric format
  • Changed descriptions from generic geographic coordinate definitions to
    format-specific ones
+4/-2     
README.md
Add ISO 6709 format clarification to release notes             

pint/v3/README.md

  • Added release note clarifying latitude and longitude use ISO 6709 data
    interchange numeric format
+1/-0     

@qodo-code-review
Copy link

qodo-code-review bot commented Nov 11, 2025

PR Compliance Guide 🔍

(Compliance updated until commit 4c44469)

Below is a summary of compliance checks for this PR:

Security Compliance
🟢
No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
🟢
🎫 #SD-2650
🟢 Update GeoCoordinate latitude description to state value is expressed as decimal degrees
using ISO 6709 data interchange numeric format across BKG, eBL, Issuance, and PINT specs.
Update GeoCoordinate longitude description to state value is expressed as decimal degrees
using ISO 6709 data interchange numeric format across BKG, eBL, Issuance, and PINT specs.
Update release notes/readme in all affected API versions to mention the clarification for
latitude and longitude.
Note that maximum length increase from 10 to 20 characters is for next major version (no
change required now).
Codebase Duplication Compliance
Codebase context is not defined

Follow the guide to enable codebase context checks.

Custom Compliance
🟢
Generic: Meaningful Naming and Self-Documenting Code

Objective: Ensure all identifiers clearly express their purpose and intent, making code
self-documenting

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Secure Error Handling

Objective: To prevent the leakage of sensitive system information through error messages while
providing sufficient detail for internal debugging.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Secure Logging Practices

Objective: To ensure logs are useful for debugging and auditing without exposing sensitive
information like PII, PHI, or cardholder data.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Comprehensive Audit Trails

Objective: To create a detailed and reliable record of critical system actions for security analysis
and compliance.

Status:
Not Applicable: The PR only updates documentation strings in OpenAPI specs and READMEs without introducing
executable logic or actions to audit; no new critical actions are present to assess
logging.

Referred Code
  description: |
    Latitude expressed as decimal degrees using the ISO 6709 data interchange numeric format.
  maxLength: 10
  example: '48.8585500'
longitude:
  type: string
  description: |
    Longitude expressed as decimal degrees using the ISO 6709 data interchange numeric format.
  maxLength: 11
  example: '2.294492036'

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Robust Error Handling and Edge Case Management

Objective: Ensure comprehensive error handling that provides meaningful context and graceful
degradation

Status:
Not Applicable: The changes only adjust field descriptions in the OpenAPI schema and README release notes;
no new error handling paths or runtime behavior are introduced to evaluate.

Referred Code
  description: |
    Latitude expressed as decimal degrees using the ISO 6709 data interchange numeric format.
  maxLength: 10
  example: '48.8585500'
longitude:
  type: string
  description: |
    Longitude expressed as decimal degrees using the ISO 6709 data interchange numeric format.
  maxLength: 11

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Security-First Input Validation and Data Handling

Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent
vulnerabilities

Status:
Schema Clarity: While the description clarifies ISO 6709 decimal degrees, no validation rules
(format/pattern/range) were added for latitude and longitude, which may leave input
constraints unspecified at the schema level.

Referred Code
  description: |
    Latitude expressed as decimal degrees using the ISO 6709 data interchange numeric format.
  maxLength: 10
  example: '48.8585500'
longitude:
  type: string
  description: |
    Longitude expressed as decimal degrees using the ISO 6709 data interchange numeric format.
  maxLength: 11

Learn more about managing compliance generic rules or creating your own custom rules

Compliance status legend 🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

Previous compliance checks

Compliance check up to commit 2ea0f95
Security Compliance
Data truncation risk

Description: Latitude and longitude remain typed as strings with maxLength 10/11 which may be
insufficient for ISO 6709 precision and could lead to truncation if implementers assume
ISO 6709 numeric format; verify downstream validation does not truncate or reject valid
values.
BKG_v2.0.3.yaml [2855-2865]

Referred Code
  type: string
  description: |
    Latitude expressed as decimal degrees using the ISO 6709 data interchange numeric format.
  maxLength: 10
  example: '48.8585500'
longitude:
  type: string
  description: |
    Longitude expressed as decimal degrees using the ISO 6709 data interchange numeric format.
  maxLength: 11
  example: '2.294492036'
Data truncation risk

Description: Same potential truncation risk for ISO 6709 numeric values due to maxLength 10/11 string
constraints; ensure clients are not encouraged to send longer precise values that get
rejected.
EBL_v3.0.2.yaml [4347-4357]

Referred Code
  type: string
  description: |
    Latitude expressed as decimal degrees using the ISO 6709 data interchange numeric format.
  maxLength: 10
  example: '48.8585500'
longitude:
  type: string
  description: |
    Longitude expressed as decimal degrees using the ISO 6709 data interchange numeric format.
  maxLength: 11
  example: '2.294492036'
Data truncation risk

Description: Same potential truncation risk for ISO 6709 numeric values due to maxLength 10/11 string
constraints; ensure consistency with ISO 6709 expectations across services.
EBL_ISS_v3.0.2.yaml [2711-2722]

Referred Code
latitude:
  type: string
  description: |
    Latitude expressed as decimal degrees using the ISO 6709 data interchange numeric format.
  maxLength: 10
  example: '48.8585500'
longitude:
  type: string
  description: |
    Longitude expressed as decimal degrees using the ISO 6709 data interchange numeric format.
  maxLength: 11
  example: '2.294492036'
Data truncation risk

Description: Same potential truncation risk for ISO 6709 numeric values due to maxLength 10/11 string
constraints in PINT; confirm intended limits until next major version.
EBL_PINT_v3.0.0.yaml [3424-3435]

Referred Code
latitude:
  type: string
  description: |
    Latitude expressed as decimal degrees using the ISO 6709 data interchange numeric format.
  maxLength: 10
  example: '48.8585500'
longitude:
  type: string
  description: |
    Longitude expressed as decimal degrees using the ISO 6709 data interchange numeric format.
  maxLength: 11
  example: '2.294492036'
Ticket Compliance
🟡
🎫 #SD-2650
🟢 Update GeoCoordinate object descriptions in BKG to state latitude and longitude are
decimal degrees using ISO 6709 data interchange numeric format.
Update GeoCoordinate object descriptions in eBL to state latitude and longitude are
decimal degrees using ISO 6709 data interchange numeric format.
Update GeoCoordinate object descriptions in Issuance to state latitude and longitude are
decimal degrees using ISO 6709 data interchange numeric format.
Update GeoCoordinate object descriptions in PINT to state latitude and longitude are
decimal degrees using ISO 6709 data interchange numeric format.
Reflect these description changes in the respective README release notes.
🔴 Note that max length increase to 20 characters is planned for next major version (no
change needed now, but awareness of note).
Codebase Duplication Compliance
Codebase context is not defined

Follow the guide to enable codebase context checks.

Custom Compliance
🟢
Generic: Comprehensive Audit Trails

Objective: To create a detailed and reliable record of critical system actions for security analysis
and compliance.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Meaningful Naming and Self-Documenting Code

Objective: Ensure all identifiers clearly express their purpose and intent, making code
self-documenting

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Robust Error Handling and Edge Case Management

Objective: Ensure comprehensive error handling that provides meaningful context and graceful
degradation

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Secure Error Handling

Objective: To prevent the leakage of sensitive system information through error messages while
providing sufficient detail for internal debugging.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Secure Logging Practices

Objective: To ensure logs are useful for debugging and auditing without exposing sensitive
information like PII, PHI, or cardholder data.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Security-First Input Validation and Data Handling

Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent
vulnerabilities

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

@qodo-code-review
Copy link

qodo-code-review bot commented Nov 11, 2025

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
High-level
Update examples to match requirements

The PR should update the example values for latitude and longitude in all
OpenAPI specification files to match the new values provided in the ticket. The
current examples are outdated and don't reflect all use cases, such as negative
longitude.

Examples:

bkg/v2/BKG_v2.0.3.yaml [2854-2865]
        latitude:
          type: string
          description: |
            Latitude expressed as decimal degrees using the ISO 6709 data interchange numeric format.
          maxLength: 10
          example: '48.8585500'
        longitude:
          type: string
          description: |
            Longitude expressed as decimal degrees using the ISO 6709 data interchange numeric format.

 ... (clipped 2 lines)
ebl/v3/EBL_v3.0.2.yaml [4346-4357]
        latitude:
          type: string
          description: |
            Latitude expressed as decimal degrees using the ISO 6709 data interchange numeric format.
          maxLength: 10
          example: '48.8585500'
        longitude:
          type: string
          description: |
            Longitude expressed as decimal degrees using the ISO 6709 data interchange numeric format.

 ... (clipped 2 lines)

Solution Walkthrough:

Before:

# In BKG_v2.0.3.yaml and other spec files
GeoCoordinate:
  properties:
    latitude:
      description: |
        Latitude expressed as decimal degrees using the ISO 6709 data interchange numeric format.
      example: '48.8585500'
    longitude:
      description: |
        Longitude expressed as decimal degrees using the ISO 6709 data interchange numeric format.
      example: '2.294492036'

After:

# In BKG_v2.0.3.yaml and other spec files
GeoCoordinate:
  properties:
    latitude:
      description: |
        Latitude expressed as decimal degrees using the ISO 6709 data interchange numeric format.
      example: '33.629152'
    longitude:
      description: |
        Longitude expressed as decimal degrees using the ISO 6709 data interchange numeric format.
      example: '-118.587187'
Suggestion importance[1-10]: 7

__

Why: The suggestion correctly identifies that the PR failed to fully implement the ticket's requirements by not updating the example values, which is a significant omission for an API specification change.

Medium
Possible issue
Align latitude field with ISO 6709

To align the latitude field with the ISO 6709 format, add a leading sign to the
example and increase maxLength to 11.

bkg/v2/BKG_v2.0.3.yaml [2854-2859]

 latitude:
   type: string
   description: |
     Latitude expressed as decimal degrees using the ISO 6709 data interchange numeric format.
-  maxLength: 10
-  example: '48.8585500'
+  maxLength: 11
+  example: '+48.8585500'
  • Apply / Chat
Suggestion importance[1-10]: 7

__

Why: The suggestion correctly identifies that the example and maxLength for latitude are inconsistent with the newly added ISO 6709 format requirement, and fixing this improves the correctness of the API specification.

Medium
Align longitude field with ISO 6709

To align the longitude field with the ISO 6709 format, add a leading sign to the
example and increase maxLength to 12.

bkg/v2/BKG_v2.0.3.yaml [2860-2865]

 longitude:
   type: string
   description: |
     Longitude expressed as decimal degrees using the ISO 6709 data interchange numeric format.
-  maxLength: 11
-  example: '2.294492036'
+  maxLength: 12
+  example: '+2.294492036'
  • Apply / Chat
Suggestion importance[1-10]: 7

__

Why: The suggestion correctly identifies that the example and maxLength for longitude are inconsistent with the newly added ISO 6709 format requirement, and fixing this improves the correctness of the API specification.

Medium
  • Update

@HenrikHL HenrikHL merged commit 8e6aed4 into master Nov 11, 2025
1 check passed
@HenrikHL HenrikHL deleted the SD-2650_Update-latitude-longitude-description branch November 11, 2025 14:27
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