CS 1.0: SD-2782: Add facilityName to PortScheduleLocation and TransportCallLocation

[HenrikHL]

User description

SD-2782: Adding facilityName to Port and Vessel endPoints

---

PR Type

Enhancement

---

Description

• Add facilityName field to PortScheduleLocation schema

• Add facilityName field to TransportCallLocation schema

• Field includes description, max length, and example value

---

Diagram Walkthrough

flowchart LR
  A["PortScheduleLocation"] -->|"add facilityName"| B["Enhanced Schema"]
  C["TransportCallLocation"] -->|"add facilityName"| B
  B -->|"maxLength: 100, type: string"| D["Facility Name Field"]

Loading

File Walkthrough

	Relevant files
Enhancement	CS_v1.0.2.yaml Add facilityName to location schemas                                          cs/v1/CS_v1.0.2.yaml Added facilityName field to PortScheduleLocation schema with maxLength 100, string type, and example "Building 123" Added facilityName field to TransportCallLocation schema with identical specifications Both fields include descriptive text "The name of the facility" +10/-0
Configuration changes	styleguide.json Styleguide configuration changes                                                  .stoplight/styleguide.json File modified but insufficient token budget to process details +1/-1

---

[qodo-code-review]

PR Compliance Guide 🔍

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-2782 🟢 Ensure `facilityName` is a string with `maxLength: 100`. Ensure `facilityName` has description: "The name of the facility." 🔴 Add a new optional attribute facilityName inside the Facility object to support identifying facilities that are not represented by SMDG/BIC codes.
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

Compliance status legend

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

[qodo-code-review]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
General	Abstract field into reusable component To avoid duplication, extract the facilityName property into a reusable schema component and reference it using $ref in both PortScheduleLocation and TransportCallLocation. cs/v1/CS_v1.0.2.yaml [1752-1756] facilityName: - maxLength: 100 - type: string - description: The name of the facility. - example: Building 123 + $ref: '#/components/schemas/FacilityName' Apply / Chat Suggestion importance[1-10]: 6 __ Why: The suggestion correctly identifies duplicated code and proposes a valid improvement using $ref, which enhances maintainability and adheres to the DRY principle for OpenAPI specifications.	Low
More

[emiliodcsa]

It looks fine to me

[pedrocarvalhodcsa]

It looks fine to me

@emiliodcsa you are also looking fine in your profile pic