Hypothesis text [DRAFT]:
KR 5.1.12: If we release an interactive documentation sandbox for MediaWiki REST APIs, it will introduce a repeatable pattern for low maintenance, high quality API documentation while making the APIs easier to adopt for developers around the world. This will ensure that our API documentation is fully up to date, testable, and localised for generations of developers, while reducing the maintenance cost and increasing sustainability for API publishers. .
Related Documentation
Q3 Planning Doc
Milestones
- Capture and document header parameters across endpoints.
- Include header parameters as part of generated OpenAPI spec.
- Enable translatable header parameter descriptions.
- Implement client-side translation of standard SwaggerUI labels.
- Launch on 5 Wikimedia projects, requesting feedback from users.
- Define a canonical location for schema versions.
- Publish canonical, generated “discovery document” to the schema location.
- [Stretch] Launch across all remaining Wikimedia projects.
- [Stretch] Automatically validate and/or generate spec translation keys.