Open Data Catalog v2.0.0
Drupal\metastore\DatasetApiDocs Class Reference

Public Member Functions

 __construct (DkanApiDocsGenerator $docsGenerator, Service $metastore)
 
 getDatasetSpecific (string $identifier)
 

Public Attributes

const SPEC_PARAMETERS
 
const SPEC_SCHEMAS
 
const SPEC_RESPONSES
 

Detailed Description

Provides dataset-specific OpenAPI documentation.

Definition at line 10 of file DatasetApiDocs.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructs a new MetastoreDocsController.

Parameters
\Drupal\common\DkanApiDocsGenerator$docsGeneratorServes openapi spec.
\Drupal\metastore\Service$metastoreThe metastore service.

Definition at line 74 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$identifierDataset uuid.
Returns
array OpenAPI spec.

Definition at line 88 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 12 of file DatasetApiDocs.php.

◆ SPEC_RESPONSES

const Drupal\metastore\DatasetApiDocs::SPEC_RESPONSES
Initial value:
= [
'404IdNotFound',
'200JsonOrCsvQueryOk',
'400BadJson',
]

Definition at line 46 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 31 of file DatasetApiDocs.php.