Maniphest T350161

Cleanup: REST framework: Add support for outputting an OpenAPI (swagger) spec
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	Atieno
	Oct 31 2023, 3:50 PM

Tags

Referenced Files

None

Subscribers

Description

FixMEs and TODOs that have come up from, and close T323786

Related Objects
Search...

		Status	Subtype	Assigned	Task
		Stalled		None	T324931 Clean up open RESTBase related tickets
		Open		None	T262315 <CORE TECHNOLOGY> API Migration & RESTBase Sunset
		Stalled		None	T353157 Port CampaignEvents REST API documentation to swagger
		Resolved		daniel	T362006 Provide a Swagger-UI for exploring the core REST API
		Resolved		BPirkle	T323786 REST framework: Add support for outputting an OpenAPI (swagger) spec
		Resolved		BPirkle	T350161 Cleanup: REST framework: Add support for outputting an OpenAPI (swagger) spec
		Invalid		None	T350060 Split the init method, so instantiateHandlerObject can inject the spec.
		Invalid		None	T350059 Add fields based on the output mode
		Invalid		None	T350057 We should reference a re-usable "user" type. The license structure should also be re-usable.
		Declined		None	T350053 Create a JsonBodyValidator if getParamSettings() returns body params
		Resolved		BPirkle	T350050 Create a utility function for loading spec files.
		Invalid		None	T350051 Add info about redirects, and maybe a default for errors?
		Invalid		None	T351741 Enable filtering the spec by endpoints/path prefix
		Resolved		BPirkle	T352183 Support i18n for JSON body descriptions
		Resolved		Atieno	T352664 Add unit testing for RootSpecHandler

Event Timeline

Atieno created this task.Oct 31 2023, 3:50 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptOct 31 2023, 3:50 PM

Atieno updated the task description. (Show Details)Oct 31 2023, 3:51 PM

Atieno added subtasks: T350060: Split the init method, so instantiateHandlerObject can inject the spec., T350059: Add fields based on the output mode, T350057: We should reference a re-usable "user" type. The license structure should also be re-usable., T350053: Create a JsonBodyValidator if getParamSettings() returns body params, T350050: Create a utility function for loading spec files., T350051: Add info about redirects, and maybe a default for errors?.Oct 31 2023, 3:55 PM

Atieno added a parent task: T323786: REST framework: Add support for outputting an OpenAPI (swagger) spec .

Atieno added a subtask: T351741: Enable filtering the spec by endpoints/path prefix.Nov 21 2023, 4:24 PM

Atieno added a subtask: T352183: Support i18n for JSON body descriptions.Nov 28 2023, 3:39 PM

Atieno added a subtask: T352664: Add unit testing for RootSpecHandler.Dec 4 2023, 1:17 PM

Atieno added a project: User-Atieno.Jan 2 2024, 4:35 PM

Atieno closed subtask T352664: Add unit testing for RootSpecHandler as Resolved.Jan 9 2024, 4:29 PM

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

[mediawiki/core@master] REST: add OpenApiModule

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

gerritbot added a project: Patch-For-Review.May 17 2024, 4:43 PM

daniel closed subtask T350053: Create a JsonBodyValidator if getParamSettings() returns body params as Declined.Jun 6 2024, 7:04 PM

Pppery edited projects, added MediaWiki-REST-API; removed Patch-For-Review, MediaWiki-Action-API.Dec 26 2024, 6:24 PM

Pppery subscribed.

This comment was removed by Pppery.

Pppery unsubscribed.May 18 2025, 2:35 AM

Maintenance_bot added a project: MW-Interfaces-Team.May 18 2025, 3:30 AM

HCoplin-WMF moved this task from Incoming (Needs Triage) to Needs Further Discussion on the MW-Interfaces-Team board.May 21 2025, 1:24 PM

BPirkle closed subtask T350060: Split the init method, so instantiateHandlerObject can inject the spec. as Invalid.May 23 2025, 1:36 AM

BPirkle closed subtask T350059: Add fields based on the output mode as Invalid.May 23 2025, 1:39 AM

BPirkle closed subtask T350057: We should reference a re-usable "user" type. The license structure should also be re-usable. as Invalid.May 23 2025, 1:43 AM

BPirkle closed subtask T350050: Create a utility function for loading spec files. as Resolved.May 23 2025, 1:48 AM

BPirkle closed subtask T352183: Support i18n for JSON body descriptions as Resolved.May 23 2025, 1:51 AM

BPirkle closed subtask T351741: Enable filtering the spec by endpoints/path prefix as Invalid.

Substantially done. Future improvements can be tracked under separate tasks.