API: Define common API endpoints - Githubissues

bcgov / cas-obps

0 stars 0 forks source link

API: Define common API endpoints #250

Closed pbastia closed 2 months ago

pbastia commented 3 months ago

Description:

Identify the common API endpoints and how to expose them

Acceptance Criteria:

Given When Then

Development Checklist:

[ ] Checklist item
[ ] Checklist item
[ ] Checklist item
[ ] Meets the DOD

Definition of Ready (Note: If any of these points are not applicable, mark N/A)

[ ] User story is included
[ ] User role and type are identified
[ ] Acceptance criteria are included
[ ] Wireframes are included (if required)
[ ] Design / Solution is accepted by Product Owner
[ ] Dependencies are identified (technical, business, regulatory/policy)
[ ] Story has been estimated (under 13 pts)

·Definition of Done (Note: If any of these points are not applicable, mark N/A)

[ ] Acceptance criteria are tested by the CI pipeline
[ ] UI meets accessibility requirements
[ ] Configuration changes are documented, documentation and designs are updated
[ ] Passes code peer-review
[ ] Passes QA of Acceptance Criteria with verification in Dev and Test
[ ] Ticket is ready to be merged to main branch
[ ] Can be demoed in Sprint Review
[ ] Bugs or future work cards are identified and created
[ ] Reviewed and approved by Product Owner

Notes:

Dependencies

Blocked by
Blocking

mikevespi commented 2 months ago

A directory for common end points has been added
Known existing common endpoints are in there
As new endpoints are proposed / introduced, the API team should look ahead to see if other modules are likely to need the end point, and place it in common as necessary

patriciarussellCAS commented 2 months ago

to discuss with @pbastia

pbastia commented 2 months ago

@patriciarussellCAS closing as the strategy for creating new endpoints has been documented.