Automatically generating interactive MediaWiki REST API documentation using OpenAPI spec definitions. The MW-Interfaces-Team will utilize these specs to perform automated validation to guarantee that the documentation matches actual endpoint behavior, in addition to creating an interactive Sandbox experience powered by SwaggerUI. This work will make the platform more sustainable by reducing reliance on manual documentation management for API publishers, while also improving endpoint stability for API consumers.
Details
Details
Today
Today
Wed, Jul 16
Wed, Jul 16
gerritbot added a comment to T384750: Translate response body property descriptions for remaining endpoints.
Change #1170127 had a related patch set uploaded (by Reedy; author: Fgoodwin):
[mediawiki/core@REL1_43] Translate response body property descriptions for remaining endpoints
gerritbot added a comment to T376603: Create JSON schema definitions for all response bodies on remaining MediaWiki REST API endpoints.
Change #1169630 merged by jenkins-bot:
[mediawiki/core@REL1_43] REST: JSON schema definitions for additional response bodies
gerritbot added a comment to T375530: Define and store MediaWiki REST API ‘page’ endpoint responses as JSON schemas.
Change #1169629 merged by jenkins-bot:
[mediawiki/core@REL1_43] Define and store MediaWiki REST API ‘page’ endpoint responses as JSON schemas
Tue, Jul 15
Tue, Jul 15
gerritbot added a comment to T376603: Create JSON schema definitions for all response bodies on remaining MediaWiki REST API endpoints.
Change #1169630 had a related patch set uploaded (by Reedy; author: WQuarshie):
[mediawiki/core@REL1_43] REST: JSON schema definitions for additional response bodies
gerritbot added a comment to T375530: Define and store MediaWiki REST API ‘page’ endpoint responses as JSON schemas.
Change #1169629 had a related patch set uploaded (by Reedy; author: WQuarshie):
[mediawiki/core@REL1_43] Define and store MediaWiki REST API ‘page’ endpoint responses as JSON schemas
Tue, Jul 1
Tue, Jul 1
HCoplin-WMF closed T388528: Add translatable OpenAPI endpoint descriptions for all remaining endpoints as Resolved.
Marking as resolved so I can archive this sprint board. Added a follow up task here for the description changes that were missed: https://phabricator.wikimedia.org/T398309
Jun 25 2025
Jun 25 2025
tstarling added a comment to T375511: Hypothesis 5.1.7 (FY24-25 Q2): Define and Validate Response Bodies in Generated OpenAPI Specs.
Thanks @BPirkle. That answers my question for now.
Jun 24 2025
Jun 24 2025
BPirkle added a comment to T375511: Hypothesis 5.1.7 (FY24-25 Q2): Define and Validate Response Bodies in Generated OpenAPI Specs.
Jun 20 2025
Jun 20 2025
tstarling added a comment to T375511: Hypothesis 5.1.7 (FY24-25 Q2): Define and Validate Response Bodies in Generated OpenAPI Specs.
Is there any developer documentation for this?
Jun 19 2025
Jun 19 2025
HCoplin-WMF moved T384537: [5.1.12 Milestone]: Endpoint Description Support from Now to Recently Completed on the MW-Interfaces-Team (MWI-Roadmap) board.
Jun 17 2025
Jun 17 2025
Jun 13 2025
Jun 13 2025
gerritbot added a comment to T388528: Add translatable OpenAPI endpoint descriptions for all remaining endpoints.
Change #1149994 merged by jenkins-bot:
[mediawiki/core@master] REST: Add translatable OpenAPI endpoint descriptions for all remaining endpoints
Jun 9 2025
Jun 9 2025
HCoplin-WMF added a comment to T388528: Add translatable OpenAPI endpoint descriptions for all remaining endpoints.
- Missing endpoint descriptions:
Jun 3 2025
Jun 3 2025
May 27 2025
May 27 2025
May 26 2025
May 26 2025
Atieno added a comment to T388528: Add translatable OpenAPI endpoint descriptions for all remaining endpoints.
Hi @HCoplin-WMF The non-checked boxes are missing descriptions
May 25 2025
May 25 2025
Atieno updated the task description for T388528: Add translatable OpenAPI endpoint descriptions for all remaining endpoints.
gerritbot added a comment to T388528: Add translatable OpenAPI endpoint descriptions for all remaining endpoints.
Change #1149994 had a related patch set uploaded (by Atieno; author: Atieno):
[mediawiki/core@master] REST: Add translatable OpenAPI endpoint descriptions for all remaining endpoints
May 20 2025
May 20 2025
May 19 2025
May 19 2025
May 15 2025
May 15 2025
BPirkle updated the task description for T388527: Add translatable OpenAPI endpoint descriptions for all content endpoints.
gerritbot added a comment to T388527: Add translatable OpenAPI endpoint descriptions for all content endpoints.
Change #1138901 merged by jenkins-bot:
[mediawiki/core@master] REST: add localizable endpoint descriptions to content OpenAPI specs
May 14 2025
May 14 2025
gerritbot added a comment to T388527: Add translatable OpenAPI endpoint descriptions for all content endpoints.
Change #1143965 merged by jenkins-bot:
[mediawiki/core@master] REST: Fix component definition schema to support i18n
May 12 2025
May 12 2025
OWresch-WMF renamed T382457: [BLOCKED] Add response validation check to end-to-end testing on MediaFile MW Rest API endpoint from Add response validation check to end-to-end testing on MediaFile MW Rest API endpoint to [BLOCKED] Add response validation check to end-to-end testing on MediaFile MW Rest API endpoint.
HCoplin-WMF moved T384537: [5.1.12 Milestone]: Endpoint Description Support from Recently Completed to Now on the MW-Interfaces-Team (MWI-Roadmap) board.
May 11 2025
May 11 2025
gerritbot added a comment to T388527: Add translatable OpenAPI endpoint descriptions for all content endpoints.
Change #1143965 had a related patch set uploaded (by Daniel Kinzler; author: Daniel Kinzler):
[mediawiki/core@master] REST: Fix component definition schema to support i18n
May 9 2025
May 9 2025