Description

The MediaWiki Interfaces team recently introduced a new pattern for defining self-contained REST API Modules within the MediaWiki REST framework for REST APIs. REST API modules represent collections of related endpoints, which can be independently managed from other REST API modules. They create controlled flexibility through federated ownership, while also ensuring that related capabilities are self-contained, can be independently versioned, and can share object definitions and the like. They are therefore particularly well-suited for extension REST API definitions, which are already self contained.

The CampaignEvents REST API endpoints are well-suited to become an API Module. Although they were built as part of MW core, they are already functionally differentiated and could benefit from additional separation for API management and versioning. One thing to note though is that the API can also be broken into multiple modules if preferred -- for example, separating event registration from people (participant, organizer) management.

Conditions of acceptance

• CampaignEvents API module is created
  • See: https://www.mediawiki.org/wiki/API:REST_API/Extensions
• A high(er) quality spec is generated for CampaignEvents API:
  • See: https://www.mediawiki.org/wiki/Documentation/API_documentation/Reference
  • A high level module description is created, with a link to the CampaignEvents extension documentation.
  • Endpoints all have short descriptions and summaries
  • Parameter descriptions are helpful to human readers
  • Schemas are defined, with useful descriptions for all properties
  • Examples are created where needed
• CampaignEvents API module is available in the REST Sandbox dropdown
• CampaignEvents endpoints are removed from the "flat" MediaWiki definition

Helpful documentation

• OpenAPI style guide
• API module creation for extensions

Implementation notes

• The process for creating a module is fairly straightforward; we expect the hardest part to be coming up with appropriate descriptions within the schema and endpoint definitions. Based on other teams completing this work, the whole process to takes a day or two. MediaWiki Interfaces is also down to help as much as necessary!