DatasetApiDocs.php

Go to the documentation of this file.

<?php
 
namespace Drupal\metastore;
 
use Drupal\common\DkanApiDocsGenerator;
use Drupal\common\Util\ApiDocsPathModifier;
use Drupal\Core\Site\Settings;
 
class DatasetApiDocs {
 
  const SPEC_PARAMETERS = [
    'datasetUuid',
    'showReferenceIds',
    'datastoreDistributionUuid',
    'datastoreQueryProperties',
    'datastoreQueryConditions',
    'datastoreQueryLimit',
    'datastoreQueryOffset',
    'datastoreQuerySorts',
    'datastoreQueryCount',
    'datastoreQueryResults',
    'datastoreQuerySchema',
    'datastoreQueryKeys',
    'datastoreQueryFormat',
    'datastoreQueryRowIds',
    'datastoreDatasetUuid',
    'datastoreDistributionIndex',
  ];
 
  const SPEC_SCHEMAS = [
    'dataset',
    'errorResponse',
    'datastoreResourceQuery',
    'datastoreQueryResource',
    'datastoreQueryProperty',
    'datastoreQueryExpression',
    'datastoreQueryCondition',
    'datastoreQueryConditionGroup',
    'datastoreQuerySort',
    'datastoreQueryResourceProperty',
    'datastoreQuery',
 
  ];
 
  const SPEC_RESPONSES = [
    '404IdNotFound',
    '200JsonOrCsvQueryOk',
    '400BadJson',
  ];
 
  private $docsGenerator;
 
  private $metastore;
 
  private Settings $settings;
 
  public function __construct(DkanApiDocsGenerator $docsGenerator, Service $metastore, Settings $settings) {
    $this->docsGenerator = $docsGenerator;
    $this->metastore = $metastore;
    $this->settings = $settings;
  }
 
  public function getDatasetSpecific(string $identifier) {
    $specs = ['metastore_api_docs', 'datastore_api_docs'];
    $fullSpec = $this->docsGenerator->buildSpec($specs)->{"$"};
 
    $datasetSpec = [
      'openapi' => $fullSpec['openapi'],
      'info' => $fullSpec['info'],
    ];
 
    $metastorePath = $fullSpec['paths']['/api/1/metastore/schemas/dataset/items/{identifier}']['get'];
    unset($metastorePath['parameters'][0]);
    $metastorePath['parameters'] = array_values($metastorePath['parameters']);
    $datasetSpec['paths']["/api/1/metastore/schemas/dataset/items/$identifier"]['get'] = $metastorePath;
 
    $datasetSpec['paths']["/api/1/datastore/query/$identifier/{index}"]
      = $this->getDatastoreIndexPath($fullSpec, $identifier);
 
    $datasetSpec['paths']['/api/1/datastore/query/{distributionId}'] =
      $fullSpec['paths']['/api/1/datastore/query/{distributionId}'];
 
    $datasetSpec['paths']['/api/1/datastore/sql'] =
      $fullSpec['paths']['/api/1/datastore/sql'];
 
    $datasetSpec['components'] = $this->datasetSpecificComponents($fullSpec, $identifier);
 
    $this->alterDatastoreParameters($datasetSpec, $identifier);
    $this->modifySqlEndpoints($datasetSpec, $identifier);
    if ($dkanApiBase = $this->settings->get('dkan_api_base')) {
      $datasetSpec = ApiDocsPathModifier::prepend($datasetSpec, $dkanApiBase);
    }
 
    return $datasetSpec;
  }
 
  private function datasetSpecificComponents($fullSpec, $identifier) {
    $components = [];
    $components['parameters'] =
      $this->datasetSpecificParameters($fullSpec['components']['parameters'], $identifier);
    $components['schemas'] =
      $this->datasetSpecificSchemas($fullSpec['components']['schemas']);
    $components['responses'] =
      $this->datasetSpecificResponses($fullSpec['components']['responses']);
 
    return $components;
  }
 
  private function getDatastoreIndexPath($fullSpec, $identifier) {
    $datastoreIndexPath = $fullSpec['paths']['/api/1/datastore/query/{datasetId}/{index}'];
    unset($datastoreIndexPath['get']['parameters'][0]);
    $datastoreIndexPath['get']['parameters'] = array_values($datastoreIndexPath['get']['parameters']);
    unset($datastoreIndexPath['post']['parameters'][0]);
    $datastoreIndexPath['post']['parameters'] = array_values($datastoreIndexPath['post']['parameters']);
    return $datastoreIndexPath;
  }
 
  private function datasetSpecificSchemas(array $schemas) {
    $newSchemas = array_filter($schemas, function ($key) {
      if (in_array($key, self::SPEC_SCHEMAS)) {
        return TRUE;
      }
      return FALSE;
    }, ARRAY_FILTER_USE_KEY);
    return $newSchemas;
  }
 
  private function datasetSpecificParameters(array $parameters, $identifier) {
    $newParameters = array_filter($parameters, function ($key) {
      if (in_array($key, self::SPEC_PARAMETERS)) {
        return TRUE;
      }
      return FALSE;
    }, ARRAY_FILTER_USE_KEY);
    $newParameters['datasetUuid']['example'] = $identifier;
    return $newParameters;
  }
 
  private function datasetSpecificResponses(array $responses) {
    $newResponses = array_filter($responses, function ($key) {
      if (in_array($key, self::SPEC_RESPONSES)) {
        return TRUE;
      }
      return FALSE;
    }, ARRAY_FILTER_USE_KEY);
    return $newResponses;
  }
 
  private function alterDatastoreParameters(array &$spec, string $identifier) {
    $spec['components']['parameters']['datastoreDatasetUuid']['example'] = $identifier;
    foreach ($this->getDistributions($identifier) as $index => $dist) {
      unset($spec['components']['parameters']['datastoreDistributionUuid']['example']);
      $spec['components']['parameters']['datastoreDistributionUuid']['examples'][$dist['identifier']] = [
        'value' => $dist['identifier'],
        'summary' => $dist["data"]["title"] ?? $dist['identifier'],
      ];
      unset($spec['components']['parameters']['datastoreDistributionIndex']['example']);
      $spec['components']['parameters']['datastoreDistributionIndex']['examples']["index{$index}"] = [
        'value' => "$index",
        'summary' => $dist["data"]["title"] ?? $dist['identifier'],
      ];
    }
  }
 
  private function modifySqlEndpoints(array &$spec, string $identifier) {
 
    foreach ($this->getSqlPathsAndOperations($spec['paths']) as $path => $operations) {
      foreach ($this->getDistributions($identifier) as $dist) {
        $newOperations = $this->modifySqlEndpoint($operations, $dist);
        $spec['paths'][$path] = $newOperations;
      }
    }
  }
 
  private function getSqlPathsAndOperations($pathsAndOperations) {
    foreach (array_keys($pathsAndOperations) as $path) {
      if (substr_count($path, 'sql') == 0) {
        unset($pathsAndOperations[$path]);
      }
    }
    return $pathsAndOperations;
  }
 
  private function modifySqlEndpoint($operations, $distribution) {
    $distKey = isset($distribution['data']['title']) ? $distribution['data']['title'] : $distribution['identifier'];
    unset($operations['get']['parameters'][0]['example']);
    $operations['get']['parameters'][0]['examples'][$distKey] = [
      "summary" => "Query distribution {$distribution['identifier']}",
      "value" => "[SELECT * FROM {$distribution['identifier']}][LIMIT 2]",
    ];
    return $operations;
  }
 
  private function getDistributions(string $identifier) {
 
    $data = $this->metastore->swapReferences($this->metastore->get("dataset", $identifier));
 
    return $data->{"$.distribution"} ?? [];
  }
 
}