Skip to content

Conversation

@HenrikHL
Copy link
Contributor

@HenrikHL HenrikHL commented Aug 11, 2025

User description

Booking 2.0.2, eBL 3.0.1, ISS 3.0.1 and SUR 3.0.1 have all been released and cannot be modified


PR Type

Other


Description

  • Add four released API versions to forbidden changes list

  • Prevent modification of Booking 2.0.2, eBL 3.0.1, ISS 3.0.1, SUR 3.0.1


Diagram Walkthrough

flowchart LR
  A["Released APIs"] --> B["Forbidden Changes File"]
  B --> C["Protection from Modifications"]
Loading

File Walkthrough

Relevant files
Configuration changes
forbidden_changes.txt
Add four released API versions                                                     

.github/forbidden_changes.txt

  • Add BKG_v2.0.2.yaml to booking API forbidden list
  • Add EBL_v3.0.1.yaml to eBL API forbidden list
  • Add EBL_ISS_v3.0.1.yaml to issuance API forbidden list
  • Add EBL_SUR_v3.0.1.yaml to surrender API forbidden list
+4/-0     

Booking 2.0.2, eBL 3.0.1, ISS 3.0.1 and SUR 3.0.1 have all been released and cannot be modified
@qodo-code-review
Copy link

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Path Consistency

Ensure the newly added filenames exactly match repository paths and naming conventions (case sensitivity like 'EBL' vs 'ebl') to avoid false negatives in the forbidden check.

ebl/v3/EBL_v3.0.1.yaml
ebl/v3/ebl_v3.0.0-Beta-1.yaml
ebl/v3/EBL_v3.0.0-Beta-2.yaml
ebl/v3/issuance/EBL_ISS_v3.0.0.yaml
ebl/v3/issuance/EBL_ISS_v3.0.1.yaml
ebl/v3/issuance/ebl_iss_v3.0.0-Beta-1.yaml
ebl/v3/issuance/EBL_ISS_v3.0.0-Beta-2.yaml
ebl/v3/issuance_response/*
ebl/v3/notification/*
ebl/v3/surrender/EBL_SUR_v3.0.0.yaml
ebl/v3/surrender/EBL_SUR_v3.0.1.yaml
Coverage Check

Confirm that related artifact directories (e.g., notification/issuance_response/surrender_response) do not require additional versioned files for the same release to be forbidden as well.

ebl/v2/ebl_v2.0.0-Beta-2.yaml
ebl/v2/ebl_v2.0.0-Beta-3.yaml
ebl/v3/EBL_v3.0.0.yaml
ebl/v3/EBL_v3.0.1.yaml
ebl/v3/ebl_v3.0.0-Beta-1.yaml
ebl/v3/EBL_v3.0.0-Beta-2.yaml
ebl/v3/issuance/EBL_ISS_v3.0.0.yaml
ebl/v3/issuance/EBL_ISS_v3.0.1.yaml
ebl/v3/issuance/ebl_iss_v3.0.0-Beta-1.yaml
ebl/v3/issuance/EBL_ISS_v3.0.0-Beta-2.yaml
ebl/v3/issuance_response/*
ebl/v3/notification/*
ebl/v3/surrender/EBL_SUR_v3.0.0.yaml
ebl/v3/surrender/EBL_SUR_v3.0.1.yaml
ebl/v3/surrender/ebl_sur_v3.0.0-Beta-1.yaml
ebl/v3/surrender/EBL_SUR_v3.0.0-Beta-2.yaml
ebl/v3/surrender_response/*

@qodo-code-review
Copy link

qodo-code-review bot commented Aug 11, 2025

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Verify consistent path casing

Ensure the case and naming convention match existing entries for consistency and
correct path matching. If all BKG filenames use uppercase prefixes, verify the
directory and filename exist as written to avoid false negatives in checks.

.github/forbidden_changes.txt [7]

+bkg/v2/BKG_v2.0.2.yaml
 
-
  • Apply / Chat
Suggestion importance[1-10]: 5

__

Why: The suggestion correctly advises verifying path casing for consistency, which is important for case-sensitive systems, although the new entry BKG_v2.0.2.yaml is already consistent with other v2 entries.

Low
Ensure filename-case consistency

Align filename casing with surrounding entries to prevent mismatches; several
existing lines use lowercase prefixes like 'ebl_v3...' while new ones are
uppercase. Confirm the repository paths exactly match these names to ensure the
forbidden pattern is enforced.

.github/forbidden_changes.txt [20-30]

+ebl/v3/EBL_v3.0.1.yaml
+ebl/v3/issuance/EBL_ISS_v3.0.1.yaml
+ebl/v3/surrender/EBL_SUR_v3.0.1.yaml
 
-
  • Apply / Chat
Suggestion importance[1-10]: 5

__

Why: The suggestion correctly points out mixed casing in the file and advises confirming the path, which is a valid check, but the added uppercase entries are consistent with existing non-beta v3 entries.

Low
  • Update

@HenrikHL HenrikHL merged commit 2d2e21a into master Aug 11, 2025
1 check passed
@HenrikHL HenrikHL deleted the Update_Forbidden_changes branch August 11, 2025 09:48
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