v4.0.1 Swagger Update 1: CBPII OpenAPI improvements - #261
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
cjrobbertse-ob
changed the title
cjrobbertse-ob
marked this pull request as ready for review
July 17, 2026 13:17
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
There was a problem hiding this comment.
🟡 Changes recommended
A few newly edited codeset references still point to repo roots (not the intended CSV targets) and the changelog section header uses a “TBD” placeholder that should be resolved for consistency/clarity.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR updates the v4.0.1 Confirmation of Funds (CBPII) OpenAPI artefacts (YAML + generated JSON) to improve Swagger/UI usability and consumer clarity, while aligning request/response header modelling and refactoring repeated schemas into reusable components.
Changes:
- Adds operation grouping via top-level tags, expands/standardises endpoint and schema descriptions, and enriches examples across the CBPII OpenAPI.
- Models optional
x-jws-signatureas a request header parameter and as a response header across success and error responses. - Refactors CBPII request/response payload schemas into reusable component schemas; updates diagrams, changelog, and
.gitignore.
File summaries
| File | Description |
|---|---|
| uml-diagrams/OBReadTransaction6.svg | Adds an extra enumerated value in the diagram tooltip. |
| uml-diagrams/OBReadAccount6.svg | Updates codeset wording/link reference for an enum in the diagram tooltip. |
| uml-diagrams/OBFundsConfirmationResponse1.svg | Improves formatting/readability of tooltip descriptions and inline examples. |
| uml-diagrams/OBFundsConfirmationConsentResponse1.svg | Improves tooltip formatting and links to codesets. |
| uml-diagrams/OBFundsConfirmationConsent1.svg | Improves tooltip formatting and codeset link specificity. |
| uml-diagrams/OBFundsConfirmation1.svg | Adjusts tooltip wording/formatting for instructed amount. |
| dist/openapi/confirmation-funds-openapi.yaml | Main CBPII OpenAPI YAML updates: tags, descriptions, examples, x-jws-signature, schema refactors, cleanup. |
| dist/openapi/confirmation-funds-openapi.json | Regenerated JSON kept aligned with YAML changes. |
| dist/openapi/account-info-openapi.yaml | Makes SchemeName/Identification required for OBCashAccount6_1. |
| dist/openapi/account-info-openapi.json | Mirrors the same required-field change in JSON. |
| changelog.md | Adds a “Swagger Update 1” changelog section describing the CBPII OpenAPI updates. |
| .gitignore | Ignores .vscode directory. |
Review details
- Files reviewed: 1/12 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
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.
Summary
This PR represents Swagger Update 1 for v4.0.1 for the Confirmation of Funds (CBPII) API.
x-jws-signaturerequest and response header modelling across CBPII operations and responses, aligned with the Open Banking spec pages/standard.404Error,Identification_0, andx-idempotency-key) and records the changes in thev4.0.1 Swagger Update 1changelog section..vscodeto.gitignore.Testing
dist/openapi/confirmation-funds-openapi.yamlsuccessfully with Ruby's YAML parser.dist/openapi/confirmation-funds-openapi.jsonsuccessfully with Ruby's JSON parser.