DFE-Digital / DFE-Digital/compass
API – Demand intake endpoints
Open
@andyjones81 is already working on this.
Since Dec 5, 2025.
- Dominant language
- HTML
- Stars
- 0
- Forks
- 1
- Avg merge
- 1m
- Merged PRs (30d)
- 3
Description
User story
As a frontend developer, I need REST endpoints for creating and retrieving demand requests so the UI can interact with COMPASS consistently.
Description
Create secure REST endpoints under /api/v1/demand-requests to support CRUD operations for DemandRequest records (within agreed scope).
Acceptance criteria
- Endpoint implemented:
POST /api/v1/demand-requests(create) - Endpoint implemented:
GET /api/v1/demand-requests(list with basic filters) - Endpoint implemented:
GET /api/v1/demand-requests/{id}(read single) - Endpoint implemented:
PATCH /api/v1/demand-requests/{id}(restricted update) - RBAC checks enforced on all endpoints
- Input validation and sanitisation implemented
- API error responses follow platform error schema (codes, messages, structure)
- All create / update operations generate audit log entries
- Basic API documentation added (paths, params, example requests/responses)
Non-functional
- Endpoints protected by authentication middleware
- Rate limits or equivalent protection considered / documented
- Unit tests and basic integration tests implemented
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.