BKG 2.0, EBL 3.0: SD-3300: Add ventilationOpeningPercentage

[HenrikHL]

SD-3300: Add ventilationOpeningPercentage to ActiveReeferSettings object

This change does not introduce any conditions. Conditions should be added to conformance instead

[qodo-code-review]

PR Summary by Qodo

Add ventilationOpeningPercentage to ActiveReeferSettings (BKG 2.0, EBL 3.0)

✨ Enhancement ⚙️ Configuration changes 🕐 20-40 Minutes

AI Description

• Extend ActiveReeferSettings with ventilationOpeningPercentage (0–100%) across specs.
• Update example payloads to illustrate the new reefer ventilation opening percentage.
• Keep validation/conditions out of the schema (to be handled by conformance).

Diagram

graph TD
  C["ActiveReeferSettings schema"] --> B["bkg/v2/BKG_v2.0.5.yaml"] --> U["API consumers"]
  C["ActiveReeferSettings schema"] --> E["ebl/v3/EBL_v3.0.4.yaml"] --> U["API consumers"]
  C["ActiveReeferSettings schema"] --> I["ebl/v3/issuance/EBL_ISS_v3.0.4.yaml"] --> U["API consumers"]
  C["ActiveReeferSettings schema"] --> P["pint/v3/EBL_PINT_v3.0.0.yaml"] --> U["API consumers"]

Loading

High-Level Assessment

The following are alternative approaches to this PR:

1. Centralize ActiveReeferSettings via shared $ref

• ➕ Avoids duplicating the same property definition across multiple spec files
• ➕ Reduces risk of drift (e.g., min/max, description text, example values)
• ➖ Requires repo/spec structure support for shared components and reference resolution
• ➖ May complicate tooling if consumers expect fully self-contained specs

2. Add schema-level guardrails (oneOf/anyOf or dependent constraints)

• ➕ Can express relationships like "percentage only when ventilation open" directly in OpenAPI/JSON Schema (where supported)
• ➕ Provides earlier validation feedback for API users
• ➖ OpenAPI tooling support for advanced JSON Schema constraints can be inconsistent
• ➖ PR explicitly prefers conformance-managed conditions, so this may conflict with current governance

3. Introduce spec linting / example validation in CI

• ➕ Would catch typos like "ventilationOpeningPercenate" in examples before merge
• ➕ Improves long-term spec quality with minimal per-change overhead
• ➖ Requires CI wiring and selecting/configuring a linter/validator
• ➖ May introduce initial noise until existing issues are cleaned up

Recommendation: The approach (adding a bounded numeric field with clear semantics and deferring conditions to conformance) is sound and consistent with the PR intent. However, fix the BKG example typo ("ventilationOpeningPercenate" → "ventilationOpeningPercentage") before merge, and consider adding lightweight spec/example validation to prevent similar contract-breaking documentation errors.

Files changed (4) +34 / -0

Enhancement (4) +34 / -0

BKG_v2.0.5.yamlAdd ventilationOpeningPercentage schema and BKG examples +10/-0

Add ventilationOpeningPercentage schema and BKG examples

• Adds ventilationOpeningPercentage (0–100) to ActiveReeferSettings and updates request examples to include the new field. Note: one example appears to contain a misspelled property name (ventilationOpeningPercenate).

bkg/v2/BKG_v2.0.5.yaml

EBL_v3.0.4.yamlExtend ActiveReeferSettings with ventilationOpeningPercentage +8/-0

Extend ActiveReeferSettings with ventilationOpeningPercentage

• Adds ventilationOpeningPercentage to the ActiveReeferSettings schema as a float number bounded between 0 and 100, with descriptive text and an example.

ebl/v3/EBL_v3.0.4.yaml

EBL_ISS_v3.0.4.yamlExtend issuance schema with ventilationOpeningPercentage +8/-0

Extend issuance schema with ventilationOpeningPercentage

• Introduces ventilationOpeningPercentage to ActiveReeferSettings in the issuance spec, matching the main EBL schema constraints and documentation.

ebl/v3/issuance/EBL_ISS_v3.0.4.yaml

EBL_PINT_v3.0.0.yamlAdd ventilationOpeningPercentage to PINT ActiveReeferSettings +8/-0

Add ventilationOpeningPercentage to PINT ActiveReeferSettings

• Adds ventilationOpeningPercentage to the PINT variant of ActiveReeferSettings with the same bounds (0–100) and example value.

pint/v3/EBL_PINT_v3.0.0.yaml

[qodo-code-review]

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0) 📜 Skill insights (0)

1. ventilationOpeningPercenate misspelled field ✓ Resolved 📎 Requirement gap ≡ Correctness

Description

An example payload in BKG_v2.0.5.yaml uses the misspelled property ventilationOpeningPercenate
instead of the required ventilationOpeningPercentage, making the example inconsistent with the
schema and effectively omitting the newly added field. This can mislead implementers, break
cross-standard naming consistency, and cause tooling that validates examples against schemas to
fail.

Code

bkg/v2/BKG_v2.0.5.yaml[758]

+                        ventilationOpeningPercenate: 25

Evidence

Compliance expects the property name ventilationOpeningPercentage to be used consistently across
impacted standards/objects, and this PR’s schema introduces/defines that exact property (e.g., on
ActiveReeferSettings). However, the BKG example added/updated in BKG_v2.0.5.yaml uses a
different, misspelled key (ventilationOpeningPercenate), demonstrating that the example is
non-conformant with the specification change and inconsistent with the required naming, which can
also trigger example/schema validation or Stoplight linting errors.

Consistency of ActiveReeferSettings ventilation percentage across booking and documentation flow
Add ventilationOpeningPercentage to ActiveReeferSettings across impacted standards
bkg/v2/BKG_v2.0.5.yaml[758-758]
bkg/v2/BKG_v2.0.5.yaml[754-760]
bkg/v2/BKG_v2.0.5.yaml[4422-4434]

Agent prompt

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

## Issue description
The BKG example payload uses a misspelled property name (`ventilationOpeningPercenate`) instead of the required schema property `ventilationOpeningPercentage`, so the example does not actually demonstrate the new field and is inconsistent with compliance naming requirements.

## Issue Context
This PR adds/defines `ventilationOpeningPercentage` (e.g., on `ActiveReeferSettings`) and compliance requires the same property name/semantics across impacted standards and artifacts. Examples must use the exact, correctly spelled property name to avoid misleading integrators and to prevent failures in tooling that validates examples against schemas (including Stoplight linting).

## Fix Focus Areas
- bkg/v2/BKG_v2.0.5.yaml[754-760]

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

---

Context sources

✅ Tickets: 🎫 Update BKG, EBL (TD), ISS, PINT: Add support for Reefer ventilation opening percentage

Tip of the day

💡 Did you know, you can tweak Display preferences with a live preview to see your comment before it ships

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

[HenrikHL]

/agentic_review

[qodo-code-review]

Code review by qodo was updated up to the latest commit 7e1cea8