Introduces support for modules into the REST API framework
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	daniel
	Apr 14 2024, 10:22 AM

Description

Refactor the MediaWiki\Rest\Router class to support the concept of modules,

Instead of Router operating on a list of endpoint routes directly, it should operate on a list of modules, and each module then manages a list of routes.

This design allows things like versioning and OpenAPI specs to be implemented on the level of modules. It also allows special modules that handle requests in a way different from patch paths and instantiating Hnadler objects.

NOTE: the higher level proposal was moved to T366835. Some of the discussion on this ticket may be referring to things proposed there.

Details

Related Changes in Gerrit:

	Subject	Repo	Branch	Lines +/-
	Introduce Modules into the REST framework	mediawiki/core	master	+2 K -860

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Stalled	None	T324931 Clean up open RESTBase related tickets
Open	None	T262315 <CORE TECHNOLOGY> API Migration & RESTBase Sunset
Resolved	Jgiannelos	T344944 Move Parsoid endpoints out of RESTBase
In Progress	None	T374135 Migrate RESTbase page content endpoints
Open	MSantos	T334238 Create deprecation plan for public parsoid endpoints
In Progress	daniel	T366835 REST: API modularization and versioning (tracking)
Duplicate	None	T366838 Allow extensions to define REST modules
Resolved	daniel	T365754 REST: Allow extensions to define REST modules
Resolved	daniel	T366837 REST: Introduce module definition files
Resolved	daniel	T362480 Introduces support for modules into the REST API framework
Resolved	daniel	T365753 REST: expose a machine readable directory of available API modules
Resolved	daniel	T365755 REST: make module definition files compatible with OpenAPI specs

Event Timeline

daniel created this task.Apr 14 2024, 10:22 AM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptApr 14 2024, 10:22 AM

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

[mediawiki/core@master] Introduce Modules into the REST framework

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

gerritbot added a project: Patch-For-Review.Apr 14 2024, 10:22 AM

"Modules" is a somewhat unfortunate name IMO, given that the action API calls single endpoints "modules".

There is also ResourceLoader, which refers to its resource bundles as "modules".

daniel updated the task description. (Show Details)Apr 15 2024, 7:23 AM

In T362480#9711760, @Tgr wrote:

"Modules" is a somewhat unfortunate name IMO, given that the action API calls single endpoints "modules".

Yes, it's not ideal... do you have an alternative suggestion?

I was orgiginally going for "component APIs", but that seems more confusing: "component" is already super overloaded, and we keep talking about "the REST API".

In T362480#9712034, @Krinkle wrote:

There is also ResourceLoader, which refers to its resource bundles as "modules".

Is that a vote for or against?

It seemed to me that we are using the term "module" for "bundle of related things" in api.php and load.php, so using it in rest.php as well should work.

In T362480#9712286, @daniel wrote:

Yes, it's not ideal... do you have an alternative suggestion?
I was orgiginally going for "component APIs", but that seems more confusing: "component" is already super overloaded, and we keep talking about "the REST API".

I think component would be better, as these would typically have the same boundaries as software components.

Alternatively: group, bundle, set, collection, family, suite?

daniel triaged this task as Medium priority.Apr 17 2024, 4:25 PM

daniel moved this task from Incoming (Needs Triage) to Backlog (Triaged and Ready) on the MW-Interfaces-Team board.

I think “REST API module” is ok, contrasting with “Action API module” and “ResourceLoader module”. I also like “API group” or “API endpoint group”. It’s boring (in a good way), and I think it introduces the least amount of ambiguity.

• FJoseph-WMF changed the task status from Open to In Progress.Apr 25 2024, 3:37 PM

• FJoseph-WMF moved this task from Backlog (Triaged and Ready) to In Progress on the MW-Interfaces-Team board.

BPirkle mentioned this in T323786: REST framework: Add support for outputting an OpenAPI (swagger) spec .May 4 2024, 5:11 PM

BPirkle updated the task description. (Show Details)

WMDE-leszek updated the task description. (Show Details)May 6 2024, 9:29 AM

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

[mediawiki/core@master] REST: Emit machine readable directory of available modules

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

• FJoseph-WMF assigned this task to daniel.May 6 2024, 1:20 PM

Change #969811 merged by jenkins-bot:

[mediawiki/core@master] Introduce Modules into the REST framework

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

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

[mediawiki/core@master] REST: Add support for RestModules to extension.json

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

daniel mentioned this in T365752: REST: Introduce support for private modules.May 23 2024, 6:46 PM

daniel mentioned this in T365753: REST: expose a machine readable directory of available API modules.May 23 2024, 7:07 PM

daniel mentioned this in T365754: REST: Allow extensions to define REST modules.May 23 2024, 7:11 PM

daniel changed the status of subtask T365755: REST: make module definition files compatible with OpenAPI specs from Open to In Progress.May 30 2024, 3:40 PM

daniel changed the status of subtask T365754: REST: Allow extensions to define REST modules from Open to In Progress.

daniel changed the status of subtask T365753: REST: expose a machine readable directory of available API modules from Open to In Progress.

daniel renamed this task from Introduces the notion of modules into the REST API framework to Introduces support for modules into the REST API framework.Jun 6 2024, 6:41 PM

daniel closed this task as Resolved.

daniel updated the task description. (Show Details)

daniel added a parent task: T366837: REST: Introduce module definition files.Jun 6 2024, 6:48 PM

daniel removed a subtask: T365754: REST: Allow extensions to define REST modules.Jun 6 2024, 7:13 PM

• FJoseph-WMF closed subtask T365755: REST: make module definition files compatible with OpenAPI specs as Resolved.Jul 11 2024, 2:41 PM

daniel mentioned this in T370430: REST: define the content.v1 module that will replace Parsoid endpoints..Jul 18 2024, 3:33 PM

BPirkle mentioned this in T373716: Reroute RESTbase Parsoid endpoints to core's REST endpoints.Aug 30 2024, 8:57 PM

daniel closed subtask T365753: REST: expose a machine readable directory of available API modules as Resolved.Dec 19 2024, 4:21 PM

daniel mentioned this in T306150: API: Include redirects to sections or anchors (with fragment).Jan 5 2025, 4:49 PM