Page MenuHomePhabricator
Create Task
Maniphest T432694

Epic: Action API Modernization (PP3.5.3 26/27)
Open, Needs TriagePublic
Actions

Description

Hypothesis: If we experiment with creating dedicated endpoints for actions within the Action API, we can demonstrate making the Action API more approachable and predictable.

The idea is that we can provide access to RPC-style action API endpoints (not query modules) via routes that specify the action as part of the path. This will allow them to be exposed and versioned together with REST modules, and they can be described using OpenAPI specs.

Similarly, list-style API query modules could be exposed as paginated REST endpoints. For generators and prop modules, we should explore appropriate GraphQL mappings.

Details

Other Assignee
AGhirelli-WMF
Related Changes in Gerrit:
SubjectAuthorRepoBranchLines +/-
REST: Add a generic wrapper for action API modulesDaniel Kinzlermediawiki/coremaster+1 K -69
Customize query in gerrit

Related Objects
Search...

StatusSubtypeAssignedTask
 OpenAGhirelli-WMFT433534 [Hypothesis] PP3.5.2 REST API v2 Beta Launch
 OpenAGhirelli-WMFT432794 Epic: REST API vNext Beta Module > Shared Error Responses (PP3.5.2 26/27)
 ResolvedAGhirelli-WMFT432799 REST API vNext: Create dedicated REST shared-schema repository
 OpendanielT432694 Epic: Action API Modernization (PP3.5.3 26/27)
 ResolveddanielT432696 Experiment: Expose an RPC action API endpoint in a REST-framework module
 OpendanielT432703 Create a generic machanism for exposing RPC-style ApiModule instances via the REST framework.
 OpenNoneT436749 vNext: Support certain global parameters when exposing action API modules through REST routes
 OpenNoneT436750 Experiment: find a home for warnings when exposing an action API module via a REST path
 OpendanielT432697 Experiment: Expose an a list query API endpoint in a REST-framework module
 OpendanielT436748 Experiment: Expose a collection element API endpoint in a REST-framework module
 OpenNoneT440117 vNext: Establish a shared vocabulary for use in API responses [SPIKE]
 OpendanielT440445 vNext: Decide on the schema for pagination envelopes
 OpendanielT432701 Experiment: Expose a GraphQL endpoint for querying pages, providing access to prop and generator modules.
 ResolvedAGhirelli-WMFT432870 REST API vNext: create a beta vNext module
 ResolvedSpikeAGhirelli-WMFT432795 REST API vNext: [SPIKE] Error format versioning — explicit declaration vs. schema-derived
 ResolvedAGhirelli-WMFT432868 REST API vNext: Error handling refactoring
 ResolvedAGhirelli-WMFT432797 REST API vNext: [SPIKE] Finalize standard error response shape for vNext REST modules
 ResolvedAGhirelli-WMFT432798 REST API vNext: Wire standard error shape into REST framework as the default, and apply it to one vNext module
 ResolvedAGhirelli-WMFT438207 REST API vNext: create JSON Schemas for the error response body (V1, V2, RESTBase-compat)
 ResolvedAGhirelli-WMFT438208 REST API vNext: deploy api-platform-schemas repo under schema.wikimedia.org (puppet)
 In ProgressAGhirelli-WMFT438209 REST API vNext: validate REST API error response body against published schemas
 ResolvedAGhirelli-WMFT438746 REST API vNext: OpenAPI error response spec doesn't reflect module's errorSchemaVersion
 OpendanielT440143 vNext: Action adapter: override param settings

Event Timeline

daniel created this task.Jul 21 2026, 9:29 AM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJul 21 2026, 9:29 AM
daniel updated the task description. (Show Details)Jul 21 2026, 9:32 AM
daniel created subtask T432696: Experiment: Expose an RPC action API endpoint in a REST-framework module.Jul 21 2026, 9:37 AM
daniel created subtask T432697: Experiment: Expose an a list query API endpoint in a REST-framework module.Jul 21 2026, 9:40 AM
daniel created subtask T432701: Experiment: Expose a GraphQL endpoint for querying pages, providing access to prop and generator modules..Jul 21 2026, 9:45 AM
AGhirelli-WMF added a subtask: T432870: REST API vNext: create a beta vNext module.Jul 22 2026, 2:31 PM
AGhirelli-WMF moved this task from Incoming (Needs Triage) to Needs Further Discussion on the MediaWiki-API-Platform-Team board.Jul 23 2026, 10:30 PM
AGhirelli-WMF moved this task from Needs Further Discussion to Incoming (Needs Triage) on the MediaWiki-API-Platform-Team board.
HCoplin-WMF edited projects, added: FY2026-27 Q1_delete; removed: MediaWiki-API-Platform-Team.Jul 28 2026, 11:46 PM
HCoplin-WMF moved this task from Backlog to Next on the FY2026-27 Q1_delete board.Jul 31 2026, 1:56 PM
OWresch-WMF edited projects, added: [MW-API] FY2026-27 Q1; removed: FY2026-27 Q1_delete.Aug 7 2026, 8:40 AM
OWresch-WMF moved this task from Backlog to Next on the [MW-API] FY2026-27 Q1 board.Aug 7 2026, 8:45 AM
OWresch-WMF renamed this task from Epic: Action API Modernization (PP3.5.3 26/27) to [Hypothesis] PP3.5.3 Action API Modernization.Aug 7 2026, 12:10 PM
OWresch-WMF renamed this task from [Hypothesis] PP3.5.3 Action API Modernization to Epic: Action API Modernization (PP3.5.3 26/27).
gerritbot added a comment.Aug 26 2026, 4:12 PM

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

[mediawiki/core@master] REST: Add ApiRestHybrid opt-in and error/response mapping

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

gerritbot added a project: Patch-For-Review.Aug 26 2026, 4:12 PM
AGhirelli-WMF changed the status of subtask T432870: REST API vNext: create a beta vNext module from Open to In Progress.Sep 4 2026, 4:01 PM
gerritbot added a comment.Sep 7 2026, 4:14 PM

Change #1329601 merged by jenkins-bot:

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

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

Maintenance_bot removed a project: Patch-For-Review.Sep 7 2026, 4:31 PM
ReleaseTaggerBot added a project: MW-1.47-notes (1.47.0-wmf.19; 2026-09-08).Sep 7 2026, 5:00 PM
gerritbot added a comment.Sep 8 2026, 8:57 AM

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

[mediawiki/core@master] REST: Decouple JsonLocalizer from ResponseFactory

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

gerritbot added a project: Patch-For-Review.Sep 8 2026, 8:57 AM
AGhirelli-WMF closed subtask T432870: REST API vNext: create a beta vNext module as Resolved.Tue, Sep 15, 9:43 PM
daniel closed subtask T432696: Experiment: Expose an RPC action API endpoint in a REST-framework module as Resolved.Fri, Sep 25, 4:10 PM
daniel created subtask T440143: vNext: Action adapter: override param settings.Sun, Oct 4, 4:54 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits