Drupal\common\DkanApiDocsGenerator Class Reference

Public Member Functions
	__construct (DkanApiDocsPluginManager $dkanApiDocsPluginManager, Settings $settings)
	buildSpec (array $plugins=[])

Protected Attributes
DkanApiDocsPluginManager	$docManager
Settings	$settings

Detailed Description

Generator for DKAN OpenApi docs.

Definition at line 13 of file DkanApiDocsGenerator.php.

Constructor & Destructor Documentation

__construct()

Drupal\common\DkanApiDocsGenerator::__construct	(	DkanApiDocsPluginManager	$dkanApiDocsPluginManager,
		Settings	$settings
	)

Constructor.

Parameters

\Drupal\common\Plugin\DkanApiDocsPluginManager	$dkanApiDocsPluginManager	The DKAN API Docs Plugin Manager service.
\Drupal\Core\Site\Settings	$settings	The Drupal settings service.

Definition at line 37 of file DkanApiDocsGenerator.php.

Member Function Documentation

buildSpec()

Drupal\common\DkanApiDocsGenerator::buildSpec

(

array

$plugins = []

)

Generate a spec from plugins.

Parameters

array

$plugins

Array of plugin ids to include. Will use all if empty.

Returns

Drupal\common\Plugin\OpenApiSpec Valid openapi spec.

Definition at line 51 of file DkanApiDocsGenerator.php.

Member Data Documentation

$docManager

DkanApiDocsPluginManager Drupal\common\DkanApiDocsGenerator::$docManager

protected

Definition at line 20 of file DkanApiDocsGenerator.php.

$settings

Settings Drupal\common\DkanApiDocsGenerator::$settings

protected

Definition at line 27 of file DkanApiDocsGenerator.php.