Page MenuHomePhabricator

Experiment: Expose an RPC action API endpoint in a REST-framework module
Closed, ResolvedPublic

Description

Demonstrate that we can provide access to one RPC-style action API endpoint via a route registered in a module definition file and routed via the REST framework.

Goals:

  • the code of the action API module should not need to be changed (but we may add glue code / mapping declarations / schema definitions)
  • the endpoint is defined in a module definition file
  • we can generate an OpenAPI spec for the endpoint, including a response body schema
  • parameter validation and error representations follow the conventions of the REST API

Event Timeline

daniel updated the task description. (Show Details)

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

[mediawiki/core@master] ParamValidator: Add BinaryBooleanDef type

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

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

[mediawiki/core@master] Api: Expose module init and typedef override for framework reuse

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

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

[mediawiki/core@master] REST: Add a generic wrapper for action API modules

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

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

[mediawiki/core@master] REST: Expose page move as a v2-beta endpoint

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

Change #1329333 merged by jenkins-bot:

[mediawiki/core@master] ParamValidator: Add BinaryBooleanDef type

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

Change #1329334 merged by jenkins-bot:

[mediawiki/core@master] Api: Expose module init and typedef override for framework reuse

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

Change #1329335 merged by jenkins-bot:

[mediawiki/core@master] REST: Register action modules via module files

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

Change #1329336 merged by jenkins-bot:

[mediawiki/core@master] REST: Expose page move as a v2-beta endpoint

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