Skip to content

Update Spectral rules and fix eBL required properties#623

Merged
HenrikHL merged 2 commits intomasterfrom
Update-spectral
Apr 13, 2026
Merged

Update Spectral rules and fix eBL required properties#623
HenrikHL merged 2 commits intomasterfrom
Update-spectral

Conversation

@HenrikHL
Copy link
Copy Markdown
Contributor

No description provided.

@qodo-code-review
Copy link
Copy Markdown

Review Summary by Qodo

Add required properties and descriptions to eBL and CS schemas

✨ Enhancement 🐞 Bug fix

Grey Divider

Walkthroughs

Description
• Add required properties to AmendmentReceived schema in eBL
• Add description to TransportCall schema in CS
• Update Spectral rules configuration
Diagram
flowchart LR
  A["AmendmentReceived Schema"] -->|"Add required properties"| B["amendedTransportDocumentStatus<br/>amendedTransportDocument"]
  C["TransportCall Schema"] -->|"Add description"| D["Schedule transport call definition"]
  E["Spectral Rules"] -->|"Update configuration"| F["styleguide.json"]
Loading

Grey Divider

File Changes

1. ebl/v3/EBL_v3.0.3.yaml 🐞 Bug fix +3/-0

Add required properties to AmendmentReceived

• Add required array to AmendmentReceived schema
• Mark amendedTransportDocumentStatus and amendedTransportDocument as required properties

ebl/v3/EBL_v3.0.3.yaml


2. cs/v1/CS_v1.0.3.yaml 📝 Documentation +2/-0

Add description to TransportCall schema

• Add description to TransportCall schema
• Clarify that transportCall can be either a Port or terminalCall

cs/v1/CS_v1.0.3.yaml


3. .stoplight/styleguide.json ⚙️ Configuration changes +1/-1

Update Spectral rules configuration

• Update Spectral rules configuration

.stoplight/styleguide.json


Grey Divider

Qodo Logo

@qodo-code-review
Copy link
Copy Markdown

qodo-code-review bot commented Apr 13, 2026

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0) 🖥 UI issues (0) 🎨 UX Issues (0)

Grey Divider


Action required

1. Forbidden file modified🐞
Description
This PR modifies ebl/v3/EBL_v3.0.3.yaml, but that path is explicitly listed in
.github/forbidden_changes.txt, so the "Check Forbidden Changes" workflow will fail the PR. The
change must be moved to an allowed file/version (or the forbidden list updated per policy) before
merge.
Code

ebl/v3/EBL_v3.0.3.yaml[R10267-10269]

+      required:
+        - amendedTransportDocumentStatus
+        - amendedTransportDocument
Evidence
The workflow reads regex patterns from .github/forbidden_changes.txt and fails the job if any
changed file matches one of those patterns; the forbidden list contains an explicit entry for
ebl/v3/EBL_v3.0.3.yaml, and this PR changes that file (adds a required section under
TransportDocumentAmend).

.github/workflows/check_forbidden_changes.yml[15-80]
.github/forbidden_changes.txt[18-27]
ebl/v3/EBL_v3.0.3.yaml[10249-10270]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
`ebl/v3/EBL_v3.0.3.yaml` is a forbidden path enforced by CI. Any PR that changes it will fail the `Check Forbidden Changes` GitHub Action and be unmergeable.

### Issue Context
The PR adds `required` properties to `TransportDocumentAmend` inside `ebl/v3/EBL_v3.0.3.yaml`. However, `ebl/v3/EBL_v3.0.3.yaml` appears in `.github/forbidden_changes.txt`, and the workflow fails if a changed filename matches any forbidden regex.

### Fix Focus Areas
- .github/forbidden_changes.txt[18-27]
- .github/workflows/check_forbidden_changes.yml[15-80]
- ebl/v3/EBL_v3.0.3.yaml[10264-10269]

### What to do
- Preferred: create a new versioned spec file (e.g., `ebl/v3/EBL_v3.0.4.yaml`) containing this change, and update any repo references to point to the new version as needed.
- Alternative (only if policy allows): update `.github/forbidden_changes.txt` to permit modifying `ebl/v3/EBL_v3.0.3.yaml` (but this likely defeats the purpose of freezing released specs).

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


Grey Divider

ⓘ The new review experience is currently in Beta. Learn more

Grey Divider

Qodo Logo

@github-actions
Copy link
Copy Markdown

Error: The following file(s) are not allowed to be changed: ebl/v3/EBL_v3.0.3.yaml

@HenrikHL HenrikHL merged commit df52798 into master Apr 13, 2026
1 check passed
@HenrikHL HenrikHL deleted the Update-spectral branch April 13, 2026 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant