Page MenuHomePhabricator

REST: Introduce module definition files
Closed, ResolvedPublic

Description

The standard way to define a REST module should be by writing a module definition file. Module definitions are similar to OpenAPI Spec (OAS) files, and share parts of their schema with OAS. Some notable differences are:

  • include a module name (path prefix) [required]
  • include an audience designation (see T366567) [proposed]
  • do not include parameter specs, since these will be generatde (see T366834)
  • do not include body schemas, since these will be generatde (see T366834)

Event Timeline

Change #1005589 had a related patch set uploaded (by Daniel Kinzler; author: Daniel Kinzler):

[mediawiki/core@master] REST: Make module definition files more like OpenAPI specs

https://gerrit.wikimedia.org/r/1005589

Change #1005589 merged by jenkins-bot:

[mediawiki/core@master] REST: Make module definition files more like OpenAPI specs

https://gerrit.wikimedia.org/r/1005589