| HCoplin-WMF | |
| Dec 18 2024, 11:45 PM |
We do not currently have a mechanism for identifying and documenting MediaWiki REST API header parameters. This means that the current documentation is incomplete. Historically, this has resulted in introducing unexpected breaking changes by altering how unknown optional header parameters behave during endpoint rerouting. By introducing a layer of middleware, we can capture, document, and localise these parameters similarly to how we currently handle request and query parameters.
| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Open | None | T382441 Hypothesis 5.1.12 (FY24-25 Q3): Launch fully localised, generated API documentation for MediaWiki REST API | |||
| Open | None | T382459 [5.1.12 Milestone] Capture and document header parameters across endpoints | |||
| Resolved | • Atieno | T382460 [SPIKE] Determine a strategy for documenting header parameters | |||
| Resolved | • Atieno | T412668 OpenAPI Specs: Include Request and Response Header information |
Change #1225632 had a related patch set uploaded (by Atieno; author: Atieno):
[mediawiki/core@master] OpenApiSpec: Support for request headers in the REST OpenAPI spec
Change #1235744 had a related patch set uploaded (by Atieno; author: Atieno):
[mediawiki/core@master] OpenApiSpec: Support for request headers in the REST OpenAPI spec
Change #1236275 had a related patch set uploaded (by Atieno; author: Atieno):
[mediawiki/core@master] OpenApiSpec: Add support for response headers in the REST OpenAPI spec
Change #1236290 had a related patch set uploaded (by Atieno; author: Atieno):
[mediawiki/core@master] OpenApiSpec: Add response headers in the REST OpenAPI spec for remaining endpoints
Change #1225632 merged by jenkins-bot:
[mediawiki/core@master] OpenApiSpec: Support for request headers in the REST OpenAPI spec
Change #1235744 merged by jenkins-bot:
[mediawiki/core@master] OpenApiSpec: Add request headers in the REST OpenAPI spec for remaining endpoints
Change #1236290 abandoned by Atieno:
[mediawiki/core@master] OpenApiSpec: Add response headers in the REST OpenAPI spec for remaining endpoints
Reason:
This changes merged into the other patch https://gerrit.wikimedia.org/r/c/mediawiki/core/+/1236275
Change #1236275 merged by jenkins-bot:
[mediawiki/core@master] OpenApiSpec: Add support for response headers in the REST OpenAPI spec