Repository navigation
Release/4.0.1 update1 - #272
Merged
Merged
Conversation
Remove unused components from the generated OpenAPI spec (dist/openapi/confirmation-funds-openapi.yaml): the 404Error response (with x-fapi-interaction-id header) and the Identification_0 schema were deleted to clean up redundant/unused definitions in the components section.
Replace a typographic curly apostrophe with a straight ASCII apostrophe in dist/openapi/confirmation-funds-openapi.yaml to standardize encoding and formatting in the Funds Confirmation Consents delete description.
Replace the YAML block scalar indicator '|' with the chomp indicator '|-' in dist/openapi/confirmation-funds-openapi.yaml to strip trailing newlines and standardize formatting. Affected descriptions: info.description, components.parameters.x-idempotency-key.description, components.parameters.x-client-id.description, components.headers.RateLimit-Policy.description, and components.headers.RateLimit.description.
Delete the Authorization parameter definition and remove its references from the confirmation-funds OpenAPI spec (dist/openapi/confirmation-funds-openapi.yaml). Cleans up the components/parameters section and path parameter lists by removing the now-unneeded Authorization header entry.
Adds top-level OpenAPI tags for Funds Confirmation Consents and Funds Confirmations in the generated confirmation funds spec. This improves operation grouping and discoverability in API documentation tooling.
Adds a required `Authorization` header parameter to all confirmation-funds operations and defines it in `components.parameters`. This aligns the generated OpenAPI spec with RFC6750 bearer token requirements and keeps header definitions reusable and consistent.
Expand the OpenAPI descriptions for confirmation of funds consent and request endpoints. The updated docs now spell out successful response contents, explain consent status expectations, and clarify that creating, retrieving, deleting, and checking funds do not implicitly authorise, reserve, or move funds.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Extract OBInternalAccountIdentification4Code into a reusable schema and update confirmation-of-funds SchemeName fields to reference it. Also link codeset descriptions to the specific source CSV files. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Restore the generated JSON spec to the PR base version so this PR only changes the YAML spec. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Use the existing multiline description style for the reusable account identification codeset description. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
…s-enums Refactor confirmation funds account ID enum
…examples # Conflicts: # dist/openapi/confirmation-funds-openapi.yaml
Document direct codeset CSV links and the reusable OBInternalAccountIdentification4Code schema refactor. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Extract CBPII Confirmation of Funds inline data dictionary schemas into reusable OpenAPI components and document the mapping in the changelog. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
…a-refs Refactor CBPII confirmation funds schemas
…examples # Conflicts: # dist/openapi/confirmation-funds-openapi.yaml
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
…ples Add CBPII OpenAPI examples
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
…i-openapi Clarify CBPII security scheme descriptions
Updates the v4.0.1 Swagger update notes and aligns the generated confirmation-funds OpenAPI JSON with the YAML source. Adds CBPII tags, richer operation/field examples and descriptions, makes x-jws-signature optional in requests, adds x-jws-signature response headers across success/error responses, and refactors repeated payload/account/amount structures into reusable component schemas for clearer, more consistent API documentation.
Refresh the SVG UML annotations for funds confirmation and account/transaction models by improving description formatting, clarifying inline field/code references, and updating code set links. Also add the `CRYP` value to the transaction payment purpose code list.
Add the missing required constraint for SchemeName and Identification on the AIS debtor account schema and document the Update 1 fix. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Clarify that the AIS debtor account required-field fix is an Update 1 correction for alignment intended in the v4.0.1 baseline. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Move the AIS debtor account required-field correction into the Swagger Update 1 changelog section. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Update ref for Transaction payload changes in changelog
Updated mandatory status of `SchemeName` and `Identification`. in Transactions UNL diagram
Added release date
Refresh the Confirmation of Funds OpenAPI `Authorization` header description to use the current RFC 6750 datatracker URL in both YAML and generated JSON
v4.0.1 Swagger Update 1: CBPII OpenAPI improvements
There was a problem hiding this comment.
🔵 Needs a closer look
Public banking API contract and security-profile changes require final domain-owner confirmation despite internally consistent artifacts.
Pull request overview
Refines the v4.0.1 CBPII OpenAPI contract and corrects AIS debtor-account requirements.
Changes:
- Adds optional JWS headers, examples, tags, and clearer CBPII documentation.
- Refactors CBPII schemas into reusable components while synchronizing YAML and JSON.
- Requires AIS debtor-account scheme and identification fields.
File summaries
| File | Description |
|---|---|
.gitignore |
Ignores VS Code settings. |
changelog.md |
Documents Update 1. |
dist/openapi/confirmation-funds-openapi.yaml |
Updates the CBPII specification. |
dist/openapi/confirmation-funds-openapi.json |
Synchronizes the CBPII JSON artifact. |
dist/openapi/account-info-openapi.yaml |
Corrects AIS required fields. |
dist/openapi/account-info-openapi.json |
Synchronizes the AIS JSON artifact. |
uml-diagrams/OBReadTransaction6.svg |
Updates AIS cardinalities and codes. |
uml-diagrams/OBReadAccount6.svg |
Corrects codeset attribution. |
uml-diagrams/OBFundsConfirmationResponse1.svg |
Updates CBPII documentation. |
uml-diagrams/OBFundsConfirmationConsentResponse1.svg |
Updates consent-response documentation. |
uml-diagrams/OBFundsConfirmationConsent1.svg |
Updates consent documentation. |
uml-diagrams/OBFundsConfirmation1.svg |
Updates amount documentation. |
Review details
- Files reviewed: 1/12 changed files
- Comments generated: 0
- Review effort level: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
v4.0.1 Swagger Update 1 - 2026-09-18
This update covers Swagger/OpenAPI refinements for the Confirmation of Funds (CBPII) API in v4.0.1.
Added
Funds Confirmation ConsentsandFunds Confirmationsto improve Swagger UI grouping and navigation.x-jws-signaturerequest header support across all CBPII operations to align with the Open Banking spec pages/standard.x-jws-signatureresponse header support across CBPII success and error responses to align with the Open Banking spec pages/standard.Changed
>-/|-block scalar usage where appropriate, paragraph spacing, inline code formatting, and emphasised notes).x-jws-signatureto be optional in CBPII request/response modelling to align with the Open Banking spec pages/standard. Additionally a fully formed example value has been provided in the OpenAPI specification.OBInternalAccountIdentification4Codeinto a reusable schema reference.OBFundsConfirmationConsent1/Datanow referencesOBFundsConfirmationConsentData1OBFundsConfirmationConsentResponse1/Datanow referencesOBFundsConfirmationConsentDataResponse1OBFundsConfirmation1/Datanow referencesOBFundsConfirmationData1OBFundsConfirmationResponse1/Datanow referencesOBFundsConfirmationDataResponse1OBFundsConfirmationConsent1/Data/DebtorAccountandOBFundsConfirmationConsentResponse1/Data/DebtorAccountnow referenceOBCashAccountDebtorWithNameOBFundsConfirmation1/Data/InstructedAmountandOBFundsConfirmationResponse1/Data/InstructedAmountnow referenceOBActiveOrHistoricCurrencyAndAmountOBFundsConfirmation1/Data/InstructedAmount/AmountandOBFundsConfirmationResponse1/Data/InstructedAmount/Amountnow referenceOBActiveCurrencyAndAmount_SimpleTypeOBFundsConfirmation1/Data/InstructedAmount/CurrencyandOBFundsConfirmationResponse1/Data/InstructedAmount/Currencynow referenceActiveOrHistoricCurrencyCodeAuthorizationheader description.Removed
404ErrorandIdentification_0.x-idempotency-key(CBPII has no idempotent endpoints).Fixed
OBCashAccount6_1in Update 1 by makingSchemeNameandIdentificationrequired forOBReadTransaction6/Data/Transaction/DebtorAccount; this completes theOBCashAccountDebtorWithNamealignment that was intended for the v4.0.1 baseline.