Controller for REST API version. More...

Inheritance diagram for Fossology\UI\Api\Controllers\InfoController:

Collaboration diagram for Fossology\UI\Api\Controllers\InfoController:

Public Member Functions
	getInfo ($request, $response)

	getHealth ($request, $response, $args)

	getOpenApi ($request, $response)

Public Member Functions inherited from Fossology\UI\Api\Controllers\RestController
	__construct ($container)

Additional Inherited Members
Protected Member Functions inherited from Fossology\UI\Api\Controllers\RestController
	getParsedBody (ServerRequestInterface $request)
	Parse request body as JSON and return associative PHP array. More...

	throwNotAdminException ()

	uploadAccessible ($id)

	isItemExists (int $uploadId, int $itemId)

Protected Attributes inherited from Fossology\UI\Api\Controllers\RestController
	$container

	$restHelper

	$dbHelper

Detailed Description

Controller for REST API version.

Definition at line 27 of file InfoController.php.

Member Function Documentation

Fossology\UI\Api\Controllers\InfoController::getHealth	(	$request,
		$response,
		$args
	)

Get the API health status

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args	Set to -1 in index.php if DB connection failed

Definition at line 105 of file InfoController.php.

Fossology\UI\Api\Controllers\InfoController::getInfo	(	$request,
		$response
	)

Get the current API info

Parameters

ServerRequestInterface	$request
ResponseHelper	$response

Exceptions

HttpErrorException

Definition at line 37 of file InfoController.php.

Fossology\UI\Api\Controllers\InfoController::getOpenApi	(	$request,
		$response
	)

Get the current OpenAPI info

Parameters

ServerRequestInterface	$request
ResponseHelper	$response

Exceptions

HttpErrorException

Definition at line 141 of file InfoController.php.

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