project icon indicating copy to clipboard operation
project copied to clipboard

Align the PISP v2 documentation and API definition

Open shashi165 opened this issue 1 month ago • 0 comments

Goal:

As a contributor

I want to align the PISP v2 documentation, sequence diagrams and API definitions. Right now there are some discrepancies in all 3. e.g. the documentation/sequence diagram names the endpoints as /tppAccountsRequest while the swagger defines it as /tppAccountRequest.

Also some of the examples given in the swagger do not align with the actual API definition

so that documentation, sequence diagrams, API definitions and implementation are in sync

Acceptance Criteria:

  • [ ] The sequence diagram shows correct endpoint names diagram:
  • [ ] The documentation shows correct endpoint names documentation
  • [ ] The swagger API definition shows correct endpoint names and examples swagger
  • [ ] The implementation is updated to follow the updates swagger API definition

Complexity: Medium - These are reasonably simple functions

Uncertainty: Medium -Should be well defined by specification

Notes: 1.

Tasks:

Done

  • [ ] Acceptance Criteria pass
  • [ ] Designs are up-to date
  • [ ] Unit Tests pass
  • [ ] Integration Tests pass
  • [ ] Code Style & Coverage meets standards
  • [ ] Changes made to config (default.json) are broadcast to team and follow-up tasks added to update helm charts and other deployment config.
  • [ ] TBD

Pull Requests:

  • [ ] TBD

Follow-up:

  • N/A

Dependencies:

  • N/A

Accountability:

  • Owner: TBC
  • QA/Review: TBC

shashi165 avatar Nov 13 '25 17:11 shashi165