#111052Provide OpenAPI description and API documentation for the Action API
Description
The Action API (#111046) describes every action with JSON Schema, but there is no machine-readable description of its HTTP endpoints and no way for developers to browse them. External clients have to know routes, methods, parameters and responses by heart.
Generate an OpenAPI 3.1 description from the action registry:
- every action is described as path operation with HTTP method, parameters (route, query or JSON body), request and response schemas
- errors declared via throws annotation on the action method are listed as responses with their HTTP status code
- shared object schemas are provided as
components/schemas, bearer token authentication as security scheme - the description itself is available as action at
GET /typo3/api/schema - further API routes can contribute their path items via
RouteHandlerInterface
Additionally, render the description with Swagger UI as “API Documentation” in the backend module System > Configuration, to explore and try out the available endpoints
Reviews 1
History 17
-
Gerrit Code Review pushed patch set 33 for main to change 91666 status
In ProgressUnder Review <span data-processor="relativetime" data-value="2026-10-14T12:54:01+00:00" > 10/14/26, 12:54 </span> -
Benjamin Franzke changed parent task #111053 <span data-processor="relativetime" data-value="2026-10-14T12:57:57+00:00" > 10/14/26, 12:57 </span>
-
Gerrit Code Review pushed patch set 34 for main to change 91666 <span data-processor="relativetime" data-value="2026-10-28T13:44:19+00:00" > 10/28/26, 13:44 </span>
-
Gerrit Code Review pushed patch set 35 for main to change 91666 <span data-processor="relativetime" data-value="2026-11-03T17:36:58+00:00" > 11/03/26, 17:36 </span>
-
Gerrit Code Review pushed patch set 36 for main to change 91666 <span data-processor="relativetime" data-value="2026-11-03T20:11:41+00:00" > 11/03/26, 20:11 </span>
-
Gerrit Code Review pushed patch set 37 for main to change 91666 <span data-processor="relativetime" data-value="2026-11-04T16:04:09+00:00" > 11/04/26, 16:04 </span>
-
Gerrit Code Review pushed patch set 38 for main to change 91666 <span data-processor="relativetime" data-value="2026-11-06T10:12:01+00:00" > 11/06/26, 10:12 </span>