Problem statement
For the action API as well as the REST API, there should be a policy that explicitly states stability guarantees, along with the procedure for announcing deprecations and breaking changes. This documentation should be easily discoverable on https://www.mediawiki.org/wiki/REST_API and https://www.mediawiki.org/wiki/API:Main_page. We do have https://www.mediawiki.org/wiki/API_versioning, but that (so far) only applies to RESTbase.
Solution summary
Standardize use of API mailing lists for API notifications for MediaWiki APIs and related APIs:
- mediawiki-api: Updates, new features, and non-breaking changes
- mediawiki-api-announce: Low-traffic mailing list for breaking changes as defined by individual API stability policies
Proposed documentation updates
- Update https://www.mediawiki.org/wiki/Communication#Mailing_lists to include mediawiki-api
- For the Action API main page, update the footer to include both mediawiki-api and mediawiki-api-announce
- For the Action API, create a page within the Action API docs with the deprecation policy from the API roadmap RFC. (See proposed text.) Reference this page from the Action API FAQ
- For the RESTBase API, update the versioning policy to clarify that mediawiki-api will be used as the communication channel for breaking changes to unstable endpoints and for non-breaking updates and announcements.
- For the MediaWiki REST API, update the main page to specify that mediawiki-api will be used as the communication channel for API updates.
- For the Wikidata stable interface policy, add mediawiki-api-announce to the list of notification channels for breaking changes to stable public APIs and mediawiki-api for significant changes.
- Once the following updates are in place, reach out to tech news contributors to see if they'd be interested in API updates.
Additional considerations
- Addressing stability guarantees for the Action API in RFC stable interface policy
- Referencing API update policies on the Action API extensions and MediaWiki REST API extensions docs