Maniphest T366837

REST: Introduce module definition files
Open, HighPublic
Actions

Assigned To

Authored By

	daniel
	Thu, Jun 6, 6:47 PM

Tags

Referenced Files

None

Subscribers

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)

Details

	Subject	Repo	Branch	Lines +/-
	REST: Make module definition files more like OpenAPI specs	mediawiki/core	master	+1 K -568

Customize query in gerrit

Related Objects
Search...

		Status	Subtype	Assigned	Task
		In Progress		daniel	T366835 REST: API modularization and versioning (tracking)
		Duplicate		None	T366838 Allow extensions to define REST modules
		In Progress		daniel	T365754 REST: Allow extensions to define REST modules
		Open		daniel	T366837 REST: Introduce module definition files
		Resolved		daniel	T362480 Introduces support for modules into the REST API framework
		In Progress		daniel	T365753 REST: expose a machine readable directory of available API modules
		In Progress		daniel	T365755 REST: make module definition files compatible with OpenAPI specs

Event Timeline

daniel created this task.Thu, Jun 6, 6:47 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptThu, Jun 6, 6:47 PM

daniel triaged this task as High priority.Thu, Jun 6, 6:48 PM

daniel added a parent task: T366835: REST: API modularization and versioning (tracking).

daniel added a subtask: T362480: Introduces support for modules into the REST API framework.

daniel moved this task from Incoming (Needs Triage) to In Progress on the MW-Interfaces-Team board.

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

gerritbot added a project: Patch-For-Review.Thu, Jun 6, 6:49 PM

daniel mentioned this in T366838: Allow extensions to define REST modules.Thu, Jun 6, 6:57 PM

daniel added a parent task: T366838: Allow extensions to define REST modules.

daniel added a parent task: T365754: REST: Allow extensions to define REST modules.Thu, Jun 6, 7:14 PM

daniel claimed this task.Wed, Jun 12, 3:45 PM