Extend the REST framework so that OpenAPI specifications include request and response header information. Currently, headers are not represented in our OpenAPI specs, which has caused confusion and breakages (see
T382459).
The goal is to make header expectations and outputs clear, consistent, and discoverable in the OpenAPI definitions, without adding unnecessary complexity to Handler.
Acceptance Criteria
- Request header implementation done with atleast one endpoint working
- Request header Test coverage is at least as strong as before.
- Request header All builds and automated checks pass.
- OpenAPI specs correctly represent request headers for remaining core endpoints.
- Response header implementation done with atleast one endpoint working
- Response header Test coverage is at least as strong as before.
- Test regression is not applicable (the new code is already covered by testing);
- Response header All builds and automated checks pass.
- OpenAPI specs correctly represent request headers for remaining core endpoints.
- Documentation clearly explains how to declare and consume header information in specs
- Followup task created for the documentation