Skip to content

CS 1.0: SD-2982: Add cargoType filter #620

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.

Sign up for GitHub

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

Merged
HenrikHL merged 1 commit into from
Apr 10, 2026
+18 −1
Merged

CS 1.0: SD-2982: Add cargoType filter #620

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .stoplight/styleguide.json
View file
Open in desktop

Large diffs are not rendered by default.

17 changes: 17 additions & 0 deletions cs/v1/CS_v1.0.3.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,23 @@ paths:
- `CY` (Container yard (incl. rail ramp))
- `SD` (Store Door)
- `CFS` (Container Freight Station)
- schema:
type: string
default: DRY
example: REEFER
in: query
name: cargoType
description: |
This parameter can influence:
* the routing solutions returned
* the feasibility of individual transport legs
* the reported footprint values, when provided

Possible values:
- `DRY` (For DRY cargo)
- `REEFER` (Reefer cargo)

The default value is `DRY` in case this filter parameter is not used.
Comment on lines +236 to +252
Copy link
Copy Markdown

@qodo-code-review qodo-code-review bot Apr 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Action required

1. cargotype missing enum + optionality 📎 Requirement gap ≡ Correctness

The new cargoType query parameter is documented without a schema enum for DRY/REEFER and
does not state that provider support for this filter is optional (only a default is described). This
fails the documentation requirements for supported values and optional provider support.
Agent Prompt 
## Issue description
The OpenAPI parameter `cargoType` does not enforce/document the allowed values via schema `enum`, and it does not explicitly state that provider support for the filter is optional (as required).

## Issue Context
Compliance requires documentation to enumerate supported values `DRY` and `REEFER`, and to state that provider support is optional; when supported, consumer usage is optional and provider defaults apply when omitted.

## Fix Focus Areas
- cs/v1/CS_v1.0.3.yaml[236-252]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

- schema:
type: integer
format: int32
Expand Down
Loading