Drupal\metastore\DatasetApiDocs Class Reference

Public Member Functions
	__construct (DkanApiDocsGenerator $docsGenerator, Service $metastore, Settings $settings)
	getDatasetSpecific (string $identifier)

Public Attributes
const	SPEC_PARAMETERS
const	SPEC_SCHEMAS
const	SPEC_RESPONSES

Detailed Description

Provides dataset-specific OpenAPI documentation.

Definition at line 12 of file DatasetApiDocs.php.

Constructor & Destructor Documentation

__construct()

Drupal\metastore\DatasetApiDocs::__construct	(	DkanApiDocsGenerator	$docsGenerator,
		Service	$metastore,
		Settings	$settings
	)

Constructs a new MetastoreDocsController.

Parameters

\Drupal\common\DkanApiDocsGenerator	$docsGenerator	Serves openapi spec.
\Drupal\metastore\Service	$metastore	The metastore service.
\Drupal\Core\Site\Settings	$settings	The Drupal settings service.

Definition at line 85 of file DatasetApiDocs.php.

Member Function Documentation

getDatasetSpecific()

Drupal\metastore\DatasetApiDocs::getDatasetSpecific

(

string

$identifier

)

Returns only dataset-specific GET requests for the API spec.

Parameters

string

$identifier

Dataset uuid.

Returns

array OpenAPI spec.

Definition at line 100 of file DatasetApiDocs.php.

Member Data Documentation

SPEC_PARAMETERS

const Drupal\metastore\DatasetApiDocs::SPEC_PARAMETERS

Initial value:

= [
    'datasetUuid',
    'showReferenceIds',
    'datastoreDistributionUuid',
    'datastoreQueryProperties',
    'datastoreQueryConditions',
    'datastoreQueryLimit',
    'datastoreQueryOffset',
    'datastoreQuerySorts',
    'datastoreQueryCount',
    'datastoreQueryResults',
    'datastoreQuerySchema',
    'datastoreQueryKeys',
    'datastoreQueryFormat',
    'datastoreQueryRowIds',
    'datastoreDatasetUuid',
    'datastoreDistributionIndex',
  ]

Definition at line 14 of file DatasetApiDocs.php.

SPEC_RESPONSES

const Drupal\metastore\DatasetApiDocs::SPEC_RESPONSES

Initial value:

= [
    '404IdNotFound',
    '200JsonOrCsvQueryOk',
    '400BadJson',
  ]

Definition at line 48 of file DatasetApiDocs.php.

SPEC_SCHEMAS

const Drupal\metastore\DatasetApiDocs::SPEC_SCHEMAS

Initial value:

= [
    'dataset',
    'errorResponse',
    'datastoreResourceQuery',
    'datastoreQueryResource',
    'datastoreQueryProperty',
    'datastoreQueryExpression',
    'datastoreQueryCondition',
    'datastoreQueryConditionGroup',
    'datastoreQuerySort',
    'datastoreQueryResourceProperty',
    'datastoreQuery',
 
  ]

Definition at line 33 of file DatasetApiDocs.php.