MediaWiki\Rest\Handler\RootSpecHandler Class Reference
Core REST API endpoint that outputs an OpenAPI spec of a set of routes. More...
Inherits MediaWiki\Rest\SimpleHandler.
Collaboration diagram for MediaWiki\Rest\Handler\RootSpecHandler:
Public Member Functions | |
| __construct (Config $config) | |
| run () | |
 Public Member Functions inherited from MediaWiki\Rest\SimpleHandler | |
| execute () | |
| Execute the handler. | |
| Public Member Functions inherited from MediaWiki\Rest\Handler | |
| applyCacheControl (ResponseInterface $response) | |
| Apply cache control to enforce privacy. | |
| applyConditionalResponseHeaders (ResponseInterface $response) | |
| Apply verifier headers to the response, per RFC 7231 ยง7.2. | |
| checkPreconditions () | |
| Check the conditional request headers and generate a response if appropriate. | |
| checkSession () | |
| Check the session (and session provider) | |
| getAuthority () | |
| Get the current acting authority. | |
| getBodyValidator ( $contentType) | |
| Fetch the BodyValidator. | |
| getConfig () | |
| Get the configuration array for the current route. | |
| getOpenApiSpec (string $method) | |
| Returns an OpenAPI Operation Object specification structure as an associative array. | |
| getParamSettings () | |
| Fetch ParamValidator settings for parameters. | |
| getPath () | |
| Returns the path this handler is bound to, including path variables. | |
| getRequest () | |
| Get the current request. | |
| getResponseFactory () | |
| Get the ResponseFactory which can be used to generate Response objects. | |
| getSession () | |
| Get the Session. | |
| getSupportedPathParams () | |
| Get a list of parameter placeholders present in the route's path as returned by getPath(). | |
| getValidatedBody () | |
| Fetch the validated body. | |
| getValidatedParams () | |
| Fetch the validated parameters. | |
| init (Router $router, RequestInterface $request, array $config, Authority $authority, ResponseFactory $responseFactory, HookContainer $hookContainer, Session $session) | |
| Initialise with dependencies from the Router. | |
| initContext (Router $router, array $routeConfig) | |
| Injects information about the handler's context in the Router. | |
| needsReadAccess () | |
| Indicates whether this route requires read rights. | |
| needsWriteAccess () | |
| Indicates whether this route requires write access. | |
| parseBodyData (RequestInterface $request) | |
| Returns the parsed body of the request. | |
| requireSafeAgainstCsrf () | |
| Indicates whether this route can be accessed only by session providers safe vs csrf. | |
| validate (Validator $restValidator) | |
| Validate the request parameters/attributes and body. | |
Additional Inherited Members | |
| Public Attributes inherited from MediaWiki\Rest\Handler | |
| const | KNOWN_PARAM_SOURCES = Validator::KNOWN_PARAM_SOURCES |
| const | PARAM_DESCRIPTION = Validator::PARAM_DESCRIPTION |
| const | PARAM_SOURCE = Validator::PARAM_SOURCE |
| Protected Member Functions inherited from MediaWiki\Rest\Handler | |
| detectExtraneousBodyFields (Validator $restValidator) | |
| Subclasses may override this to disable or modify checks for extraneous body fields. | |
| getConditionalHeaderUtil () | |
| Get a ConditionalHeaderUtil object. | |
| getETag () | |
| The subclass should override this to provide an ETag for the current state of the requested resource. | |
| getHookContainer () | |
| Get a HookContainer, for running extension hooks or for hook metadata. | |
| getHookRunner () | |
| Get a HookRunner for running core hooks. | |
| getLastModified () | |
| The subclass should override this to provide the maximum last modified timestamp of the requested resource. | |
| getRequestSpec () | |
| Returns an OpenAPI Request Body Object specification structure as an associative array. | |
| getResponseBodySchema () | |
| Returns an OpenAPI Schema Object specification structure as an associative array. | |
| getResponseSpec () | |
| Returns an OpenAPI Responses Object specification structure as an associative array. | |
| getRouter () | |
| Get the Router. | |
| getRouteUrl ( $pathParams=[], $queryParams=[]) | |
| Get the URL of this handler's endpoint. | |
| hasRepresentation () | |
| The subclass should override this to indicate whether the resource exists. | |
| postInitSetup () | |
| The handler can override this to do any necessary setup after init() is called to inject the dependencies. | |
| postValidationSetup () | |
| The handler can override this to do any necessary setup after validate() has been called. | |
| urlEncodeTitle ( $title) | |
| URL-encode titles in a "pretty" way. | |
Detailed Description
Core REST API endpoint that outputs an OpenAPI spec of a set of routes.
Definition at line 15 of file RootSpecHandler.php.
Constructor & Destructor Documentation
◆ __construct()
| MediaWiki\Rest\Handler\RootSpecHandler::__construct | ( | Config | $config | ) |
- Parameters
-
Config $config
Definition at line 32 of file RootSpecHandler.php.
Member Function Documentation
◆ run()
| MediaWiki\Rest\Handler\RootSpecHandler::run | ( | ) |
Definition at line 38 of file RootSpecHandler.php.
The documentation for this class was generated from the following file:
- includes/Rest/Handler/RootSpecHandler.php
