Description

We have built a lot of capabilities through the REST API framework within MediaWIki, yet few of our processes are currently documented. While some examples and reference implementations exist, we are receiving feedback form developers across the foundation that they are confused about how to follow our desired standards and how to use the tools that already exist. Although there is still more work to improve overall developer experiences to make the processes themselves more intuitive, documentation is a good starting point for guiding developers through our new systems. Additionally, by documenting our current processes, we are more likely to identify potential areas for improvement.

Conditions of acceptance

Document the following scenarios:

• Register an extension API through Module Manager
• Register an API module for a set of MediaWiki Core endpoints
• T426851: Create user guide for generating an OpenAPI spec from within the MediaWiki REST API framework
• T426852: Create user guide for how to register an externally managed API so that it is surfaced in the REST Sandbox
• How to run and preview spec changes locally T399512: Document how to preview changes to MediaWiki OpenAPI specs locally
• Linting processes
• T426856: Create a user guide for how to implement spec testing for API accuracy
• Introduce new API monitoring events & alarms
• T426860: Create a user guide for how to use the 'beta' audience designation
• Semantic versioning guide