Core REST API endpoint that outputs an OpenAPI spec of a set of routes. More...

Collaboration diagram for MediaWiki\Rest\Handler\ModuleSpecHandler:

[legend]

Public Member Functions
	__construct (Config $config)

	getParamSettings ()
	Fetch ParamValidator settings for parameters.

	run ( $moduleName, $version='')

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.

	getBodyParamSettings ()
	Fetch ParamValidator settings for body fields.

	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.

	getPath ()
	Returns the path this handler is bound to relative to the module prefix.

	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().

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

	getValidatedBody ()
	Fetch the validated body.

	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.

Public Attributes
const	MODULE_SPEC_PATH = '/coredev/v0/specs/module/{module}'

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_SOURCE = Validator::PARAM_SOURCE

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

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.

	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.

	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.

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

	getRouter ()

	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 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.

Detailed Description

Core REST API endpoint that outputs an OpenAPI spec of a set of routes.

Definition at line 21 of file ModuleSpecHandler.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 37 of file ModuleSpecHandler.php.

References MediaWiki\Config\ServiceOptions\assertRequiredOptions().

Member Function Documentation

◆ getParamSettings()

MediaWiki\Rest\Handler\ModuleSpecHandler::getParamSettings ( )

Fetch ParamValidator settings for parameters.

Every setting must include self::PARAM_SOURCE to specify which part of the request is to contain the parameter.

Can be used for the request body as well, by setting self::PARAM_SOURCE to "post". Note that the values of "post" parameters will be accessible through getValidatedParams(). "post" parameters are used with form data (application/x-www-form-urlencoded or multipart/form-data).

For "query" parameters, a PARAM_REQUIRED setting of "false" means the caller does not have to supply the parameter. For "path" parameters, the path matcher will always require the caller to supply all path parameters for a route, regardless of the PARAM_REQUIRED setting. However, "path" parameters may be specified in getParamSettings() as non-required to indicate that the handler services multiple routes, some of which may not supply the parameter.

Stability: stable: to override

Returns: array[] Associative array mapping parameter names to ParamValidator settings arrays

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 173 of file ModuleSpecHandler.php.

◆ getResponseBodySchemaFileName()

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

protected

Returns the path and name of a JSON file containing an OpenAPI Schema Object specification structure.

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

Returns null by default. Subclasses with a suitable JSON file should implement this method.

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 169 of file ModuleSpecHandler.php.

◆ run()

MediaWiki\Rest\Handler\ModuleSpecHandler::run	(		$moduleName,
			$version = '' )

Definition at line 43 of file ModuleSpecHandler.php.

Member Data Documentation

◆ MODULE_SPEC_PATH

const MediaWiki\Rest\Handler\ModuleSpecHandler::MODULE_SPEC_PATH = '/coredev/v0/specs/module/{module}'

Definition at line 23 of file ModuleSpecHandler.php.

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

includes/Rest/Handler/ModuleSpecHandler.php

Public Member Functions

Public Attributes

Protected Member Functions