Core REST API endpoint that outputs discovery information, including a list of registered modules. More...

Collaboration diagram for MediaWiki\Rest\Handler\DiscoveryHandler:

Public Member Functions
	__construct (Config $config)

	execute ()
	Execute the handler.This is called after parameter validation. The return value can either be a Response or any type accepted by ResponseFactory::createFromReturnValue().To automatically construct an error response, execute() should throw a \MediaWiki\Rest\HttpException. Such exceptions will not be logged like a normal exception.If execute() throws any other kind of exception, the exception will be logged and a generic 500 error page will be shown. Stability: stable to override Returns mixed

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.

	applyDeprecationHeader (ResponseInterface $response)
	Apply Deprecation header per RFC 9745.

	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.

	getBodyParamSettings ()
	Fetch ParamValidator settings for body fields.

	getBodyValidator ( $contentType)
	Fetch the BodyValidator.

	getConfig ()
	Get the configuration array for the current route.

	getHeaderParamSettings ()
	Fetch ParamValidator settings for request headers.

	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 relative to the module prefix.

	getRequest ()
	Get the current request.

	getRequestBodyDescription ()
	Returns a description for the OpenAPI Request Body Object, or null if no description should be included.

	getRequestBodyExample (string $mediaType)
	Returns an example value for the OpenAPI Media Type Object, or null if no example should be included.

	getResponseFactory ()
	Get the ResponseFactory which can be used to generate Response objects.

	getResponseHeaderSettings ()
	Fetch the settings array mapping response headers to their descriptions and schemas.

	getRoutePath ()
	Returns the path this handler is bound to relative to the base router prefix.

	getSession ()
	Get the Session.

	getSupportedPathParams ()
	Get a list of parameter placeholders present in the route's path as returned by getPath().

	getSupportedRequestTypes ()
	Returns the content types that should be accepted by parseBodyData().

	getValidatedBody ()
	Fetch the validated body.

	getValidatedBodyArray ()
	Fetch the validated body, asserting that it is an array.

	getValidatedParams ()
	Fetch the validated parameters.

	initContext (Module $module, string $path, array $routeConfig, array $openApiSpec=[])
	Injects information about the handler's context in the Module.

	initForExecute (RequestInterface $request)
	Initialise for execution based on the given request.

	initServices (Authority $authority, ResponseFactory $responseFactory, HookContainer $hookContainer)
	Inject service objects.

	initSession (Session $session)
	Inject session information.

	needsReadAccess ()
	Indicates whether this route requires read rights.

	needsWriteAccess ()
	Indicates whether this route requires write access to the wiki.

	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.

Protected Member Functions
	getResponseBodySchemaFileName (string $method)
	Returns the absolute path of a JSON file containing an OpenAPI Schema Object specification structure describing the response body.

Protected Member Functions inherited from MediaWiki\Rest\Handler
	detectExtraneousBodyFields (Validator $restValidator)
	Subclasses may override this to disable or modify checks for extraneous body fields.

	generateResponseSpec (string $method)
	Returns an OpenAPI Responses Object specification structure as an associative array.

	getConditionalHeaderUtil ()
	Get a ConditionalHeaderUtil object.

	getDeprecatedDate ()
	Returns the timestamp at which this was or will be deprecated, or null if none.

	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.

	getJsonLocalizer ()
	Get a JsonLocalizer object.

	getLastModified ()
	The subclass should override this to provide the maximum last modified timestamp of the requested resource.

	getModule ()
	Get the Module this handler belongs to.

	getModulePathPrefix ()
	Get the path prefix of the Module this handler belongs to.

	getRequestBodySchema (string $mediaType)
	Returns a content schema per the OpenAPI spec.

	getRequestSpec (string $method)
	Returns an OpenAPI Request Body Object specification structure as an associative array.

	getResponseBodyExample (string $method)
	Returns an example response body for use in the OpenAPI description.

	getResponseBodyExampleFileName (string $method)
	Returns the absolute path of a JSON file containing an example response body.

	getResponseBodySchema (string $method)
	Returns an OpenAPI Schema Object specification structure as an associative array.

	getRouter ()
	Get the Router of the Module that this handler belongs to.

	getRouteUrl ( $pathParams=[], $queryParams=[])
	Get the URL of this handler's endpoint.

	hasRepresentation ()
	The subclass should override this to indicate whether the resource exists.

	isDeprecated ()
	Indicates whether this is deprecated.

	postInitSetup ()
	The handler can override this to do any necessary setup after the init functions are called to inject 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.

Additional Inherited Members
Public Attributes inherited from MediaWiki\Rest\Handler
const	KNOWN_PARAM_SOURCES = Validator::KNOWN_PARAM_SOURCES

const	OPENAPI_DESCRIPTION_KEY = 'description'

const	PARAM_DESCRIPTION = Validator::PARAM_DESCRIPTION

const	PARAM_EXAMPLE = Validator::PARAM_EXAMPLE

const	PARAM_SOURCE = Validator::PARAM_SOURCE

Detailed Description

Core REST API endpoint that outputs discovery information, including a list of registered modules.

Inspired by Google's API directory, see https://developers.google.com/discovery/v1/reference.

Definition at line 17 of file DiscoveryHandler.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Handler\DiscoveryHandler::__construct ( Config $config )

Definition at line 34 of file DiscoveryHandler.php.

References MediaWiki\Config\ServiceOptions\assertRequiredOptions().

Member Function Documentation

◆ execute()

MediaWiki\Rest\Handler\DiscoveryHandler::execute ( )

Execute the handler.This is called after parameter validation. The return value can either be a Response or any type accepted by ResponseFactory::createFromReturnValue().To automatically construct an error response, execute() should throw a \MediaWiki\Rest\HttpException. Such exceptions will not be logged like a normal exception.If execute() throws any other kind of exception, the exception will be logged and a generic 500 error page will be shown.

Stability: stable: to override

Returns: mixed

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 41 of file DiscoveryHandler.php.

◆ getResponseBodySchemaFileName()

MediaWiki\Rest\Handler\DiscoveryHandler::getResponseBodySchemaFileName ( string $method )

protected

Returns the absolute path of a JSON file containing an OpenAPI Schema Object specification structure describing the response body.

See also: https://swagger.io/specification/#schema-object

Returns null by default. Subclasses that return a JSON response should override this method to return a schema file path.

The returned path must be absolute. Use __DIR__ to construct the path relative to the handler file, e.g. ‘__DIR__ . ’/Schema/Foo.json'`.

Parameters

string $method The HTTP method to produce a spec for ("get", "post", etc).

Stability: stable: to override

Since: 1.43

Returns: ?string

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 145 of file DiscoveryHandler.php.

The documentation for this class was generated from the following file:

includes/Rest/Handler/DiscoveryHandler.php

Public Member Functions