v4.0.1 Swagger Update 1: CBPII OpenAPI improvements - #261
Open
cjrobbertse-ob wants to merge 34 commits into
Open
v4.0.1 Swagger Update 1: CBPII OpenAPI improvements#261cjrobbertse-ob wants to merge 34 commits into
cjrobbertse-ob wants to merge 34 commits into
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.
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
1 participant
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.