Issue Task Under Review Quiet

#111052Provide OpenAPI description and API documentation for the Action API

Benjamin Franzke 10/14/26, 12:52 updated 11/06/26, 10:12

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

  1. Gerrit Code Review pushed patch set 33 for main to change 91666 status In Progress Under Review <span data-processor="relativetime" data-value="2026-10-14T12:54:01+00:00" > 10/14/26, 12:54 </span>