diff --git a/README.md b/README.md index e1029f9..30bb625 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,6 @@ If you desire to use Drupal core rest functionality with [OpenApi.js](https://gi drush dl openapi ``` -``` -drush -y en openapi openapi_json_schema -``` - ## Documentation The Open API specification document in JSON format that describes all of the diff --git a/modules/openapi_docs/openapi_docs.info.yml b/modules/openapi_docs/openapi_docs.info.yml index 16f400c..7f97225 100644 --- a/modules/openapi_docs/openapi_docs.info.yml +++ b/modules/openapi_docs/openapi_docs.info.yml @@ -3,5 +3,3 @@ type: module description: Documentation using the Swagger JS library core: 8.x package: OpenAPI -dependencies: - - openapi_json_schema diff --git a/modules/openapi_json_schema/README.md b/modules/openapi_json_schema/README.md deleted file mode 100644 index 4a495cd..0000000 --- a/modules/openapi_json_schema/README.md +++ /dev/null @@ -1,120 +0,0 @@ -#IMPORTANT -The openapi_json_schema module is copied for the Schemata project. -It is only intended to be needed until there is stable version of the Schemata -module(or another module that provides json_schema). -The original Schemata README follows: - -# Schemata - -> Facilitate generation of schema definitions of Drupal 8 data models. - -A schema is a declarative definition of an entity's makeup. A way of describing -the different pieces that make up the entity, much like an interface defines a -class and exactly like an XML DTD describes an XML document. This project uses -Drupal's new Typed Data system to faciliate the creation of schemas for your -site. - -This is especially powerful in conjunction with the Drupal REST system, as your -content model schemata can help with testing, client code generation, -documentation generation, and more, especially in conjunction with external -tools that process schemas. - -## What has a Schema? - -All Entity Types and Bundles have a schema automatically via the Schemata module. - -## Where is the Schema? - -Schemata are accessed via REST endpoints. Once enabled, Schemata resources are -found at `/schemata/{entity_type}/{bundle?}`. These resources are dynamically -generated based on the Typed Data Definition system in Drupal core, which means -any change to fields on an Entity will automatically be reflected in the schema. - -## Requirements - -Schema will only apply if [Issue #2751325: Specifically-typed properties in json output](https://www.drupal.org/node/2751325) -is fixed or patched in your Drupal instance. Otherwise your serialized API -output for JSON and HAL will only produce string values. - -Schemata-the-module is a dependency for the sub-modules of the project: - -* **JSON Schema**: A serializer which processes Schemata schema objects into - [JSON Schema v4](http://json-schema.org). Describes the output of content - entities via the core JSON serializer. -* **HAL JSON Schema**: A serializer which builds on JSON Schema serializer to - describe the output of content entities via the core HAL JSON serializer. - -From a "product" standpoint, JSON Schema is the valuable thing, and Schemata -the technical dependency. Only install Schemata if you plan to install a -serializer that can do something with it - -## Architecture - -The Schemata project contains the Schemata module. The module provides REST -endpoints to retrieve a schema object. The Schema is assembled by Drupal based -on the [Typed Data API](https://www.drupal.org/node/1794140), configuration, -and in the future, router introspection. The resulting Schema object can then -be requested via a GET request using a `_format` parameter to select a -particular serializer. - -In order to serialize the Schema Object, the serializer must be able to support -implementations of the Drupal\schemata\Schema\SchemaInterface class. At this -time, the only serializer support for Schemata is within this project, you can -see an example of this in the packaged submodule **JSON Schema**. - -## Configuration - -* Enable the Schemata module and a Schemata Serializer. For now, that means the - JSON Schema module. -* Enable both Schemata resources with the json_schema format. -* Grant permission to access the schemata resources to roles that need it. -* Visit a URL such as `/schemata/user?_format=json_schema` to see it. - -## Security - -* Bug reports should follow [Drupal.org security reporting procedures](https://www.drupal.org/node/101494). - -## URLs - -* [Homepage](https://www.drupal.org/project/schemata) -* [Development](https://github.com/phase2/schemata) - -## Maintainers - -Adam Ross a.k.a. Grayside - -## Contributors - -Creation of this module was sponsored by [Norwegian Cruise Line](https://www.drupal.org/norwegian-cruise-line). - -Fubhy's work on [GraphQL](https://www.drupal.org/project/graphql) was a great -help in early architecture of this project. Thank you to [Fubhy](https://www.drupal.org/u/fubhy) -and the GraphQL sponsors. - -## F.A.Q. - -### Will there be a Drupal 7 backport? - -This module can be summarized as follows: - -A Drupal 8 subsystem (REST) and a Symfony subsystem (Serialization) use a touchy -Drupal 8 subsystem (Typed Data) to describe the output of another Drupal 8 -subsystem (Entity). - -It gets worse--the use cases of this module are most applicable when said entity -output comes by way of the REST and Serialization systems. - -It does not make sense to discuss a backport unless you first backport large -swathes of Drupal 8. - -### Why not use some other module? - -[Self Documenting REST API](https://www.drupal.org/project/rest_api_doc) produces -webpage reports about REST resources on the site. This project might eventually -compete with that if it builds out support for the [Swagger specification](http://swagger.io/). - -[Field Report](https://www.drupal.org/project/field_report) enhances the core -reports about fields and content types. This has some similarity with this -project, but the reports provided by Field Report are for people orienting on -a site. This project produces schemas that can be used for machine integrations -or feeding into other report generation systems. diff --git a/modules/openapi_json_schema/composer.json b/modules/openapi_json_schema/composer.json deleted file mode 100644 index 52a46ae..0000000 --- a/modules/openapi_json_schema/composer.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "name": "drupal/openapi_json_schema", - "type": "drupal-module", - "description": "Provide schema definitions of Drupal entities for type validation, code generation, and documentation.", - "keywords": ["Drupal"], - "license": "GPL-2.0+", - "homepage": "https://www.drupal.org/project/openapi", - "minimum-stability": "dev", - "support": { - "issues": "http://drupal.org/project/issues/openapi", - "source": "http://cgit.drupalcode.org/openapi" - }, - "require": { } -} diff --git a/modules/openapi_json_schema/openapi_json_schema.info.yml b/modules/openapi_json_schema/openapi_json_schema.info.yml deleted file mode 100644 index 12742b2..0000000 --- a/modules/openapi_json_schema/openapi_json_schema.info.yml +++ /dev/null @@ -1,5 +0,0 @@ -name: OpenAPI JSON Schema -type: module -description: Provide schema definitions of Drupal entities for type validation, code generation, and documentation. -core: 8.x -package: Web services diff --git a/modules/openapi_json_schema/openapi_json_schema.module b/modules/openapi_json_schema/openapi_json_schema.module deleted file mode 100644 index bd2542c..0000000 --- a/modules/openapi_json_schema/openapi_json_schema.module +++ /dev/null @@ -1,24 +0,0 @@ -' . t('About') . ''; - $output .= '

' . t('Provide schema definitions of Drupal entities for type validation, code generation, and documentation.') . '

'; - return $output; - - default: - } -} diff --git a/modules/openapi_json_schema/openapi_json_schema.services.yml b/modules/openapi_json_schema/openapi_json_schema.services.yml deleted file mode 100644 index dc181e5..0000000 --- a/modules/openapi_json_schema/openapi_json_schema.services.yml +++ /dev/null @@ -1,80 +0,0 @@ -services: - - # Assemble Schemas based on entity type definitions. As a standalone class, - # the SchemaFactory can be pulled in to custom menu routes, drush commands, - # and REST plugins. The SchemaFactory::create() creates instances of - # Drupal\openapi_json_schema\Schema\SchemaInterface. - openapi_json_schema.schema_factory: - class: Drupal\openapi_json_schema\SchemaFactory - arguments: ['@logger.channel.openapi_json_schema', '@entity_type.manager', '@entity_type.bundle.info', '@typed_data_manager'] - - # Factory wrapper to generate URLs for Schemas. This has static methods and - # can be directly included in any code without dependency injection, much like - # Drupal\Core\Url. - openapi_json_schema.schema_url: - class: Drupal\openapi_json_schema\SchemaUrl - - # Create a log channel for the Schemata module. This simplifies logging setup - # code in Schemata code that will do logging. As a tradeoff, it also adds this - # fairly specific logging channel to the system for all requests. - logger.channel.openapi_json_schema: - parent: logger.channel_base - arguments: ['schemata'] - -# References should be converted to other schemata resources for the type. - # This priority ensures the DataReferenceDefinition is handled before - # DataDefinition. Since it is orthagonal to ComplexDataDefinition, they share - # the same priority. - serializer.normalizer.data_reference_definition.json_schema: - class: Drupal\openapi_json_schema\Normalizer\DataReferenceDefinitionNormalizer - arguments: ['@entity_type.manager'] - tags: - - { name: normalizer, priority: 25 } - - # Normalize complex data properties. - # This priority ensures the ComplexDataDefinition is handled before - # DataDefinition. Since it is orthagonal to DataReferenceDefinition, they - # share the same priority. - serializer.normalizer.complex_data_definition.json_schema: - class: Drupal\openapi_json_schema\Normalizer\ComplexDataDefinitionNormalizer - tags: - - { name: normalizer, priority: 20 } - - # Field definitions are a variant of List definitions, with additional access - # to the particular schema and configuration pieces from the field system. As - # a subclass of ListDataDefinitionInterface, FieldDefinitionInterface needs a - # higher priority. - serializer.normalizer.field_definition.json_schema: - class: Drupal\openapi_json_schema\Normalizer\FieldDefinitionNormalizer - tags: - - { name: normalizer, priority: 30 } - - # If the typed data definition is a list (as most are somewhere along the - # property hierarchy) this triggers the recursion to the next layer. - serializer.normalizer.list_data_definition.json_schema: - class: Drupal\openapi_json_schema\Normalizer\ListDataDefinitionNormalizer - tags: - - { name: normalizer, priority: 20 } - - # Typed data definitions in general can take many forms. This handles final items. - serializer.normalizer.data_definition.json_schema: - class: Drupal\openapi_json_schema\Normalizer\DataDefinitionNormalizer - tags: - - { name: normalizer, priority: 10 } - - # This is the main JSON Schema normalizer. - serializer.normalizer.schema.json_schema: - class: Drupal\openapi_json_schema\Normalizer\SchemataSchemaNormalizer - arguments: ['@router.route_provider'] - tags: - - { name: normalizer, priority: 10 } - - serializer.encoder.json_schema: - class: Drupal\openapi_json_schema\Encoder\JsonEncoder - tags: - - { name: encoder, priority: 10, format: json_schema } - - plugin.manager.json_schema.type_mapper: - class: Drupal\openapi_json_schema\Plugin\Type\TypeMapperPluginManager - arguments: ['@container.namespaces', '@module_handler'] - diff --git a/modules/openapi_json_schema/src/Annotation/TypeMapper.php b/modules/openapi_json_schema/src/Annotation/TypeMapper.php deleted file mode 100644 index 22b41d5..0000000 --- a/modules/openapi_json_schema/src/Annotation/TypeMapper.php +++ /dev/null @@ -1,25 +0,0 @@ -extractPropertyData($entity); - $normalized['type'] = 'object'; - - // Retrieve 'properties' and possibly 'required' nested arrays. - $properties = $this->normalizeProperties( - $entity->getPropertyDefinitions(), - $format, - $context - ); - - $normalized = NestedArray::mergeDeep($normalized, $properties); - return $normalized; - } - - /** - * Determine if the current field is a reference field. - * - * @param \Drupal\Core\TypedData\ComplexDataDefinitionInterface $entity - * The complex data definition to be checked. - * - * @return bool - * TRUE if it is a reference, FALSE otherwise. - */ - protected function isReferenceField(ComplexDataDefinitionInterface $entity, $context = NULL) { - $main = $entity->getPropertyDefinition($entity->getMainPropertyName()); - // @todo use an interface or API call instead of an object check. - return ($main instanceof DataReferenceTargetDefinition); - } - -} diff --git a/modules/openapi_json_schema/src/Normalizer/DataDefinitionNormalizer.php b/modules/openapi_json_schema/src/Normalizer/DataDefinitionNormalizer.php deleted file mode 100644 index 3ccfc12..0000000 --- a/modules/openapi_json_schema/src/Normalizer/DataDefinitionNormalizer.php +++ /dev/null @@ -1,99 +0,0 @@ -getSetting('text source') - || $entity->getSetting('date source')) { - - return []; - } - - $property = $this->extractPropertyData($entity, $context); - if (!empty($context['parent']) && $context['name'] == 'value') { - if ($maxLength = $context['parent']->getSetting('max_length')) { - $property['maxLength'] = $maxLength; - } - } - - $normalized = ['properties' => []]; - $normalized['properties'][$context['name']] = $property; - if ($this->requiredProperty($entity)) { - $normalized['required'][] = $context['name']; - } - - return $normalized; - } - - /** - * Extracts property details from a data definition. - * - * This method includes mapping primitive types in Drupal to JSON Schema - * type and format descriptions. This method is invoked by several of the - * normalizers. - * - * @param \Drupal\Core\TypedData\DataDefinitionInterface $property - * The data definition from which to extract values. - * @param array $context - * Serializer context. - * - * @return array - * Discrete values of the property definition. - * - * @todo identify how to cleanly inject the plugin manager without requiring - * updates to many of the normalizers. - */ - protected function extractPropertyData(DataDefinitionInterface $property, array $context = []) { - $type_mapper_manager = \Drupal::service('plugin.manager.json_schema.type_mapper'); - $data = $type_mapper_manager->createInstance($property->getDataType()) - ->getMappedValue($property); - - if (isset($context['parent']) && $context['parent']->getDataType() == 'field_item:uuid') { - $data['format'] = 'uuid'; - } - - return $data; - } - -} diff --git a/modules/openapi_json_schema/src/Normalizer/DataReferenceDefinitionNormalizer.php b/modules/openapi_json_schema/src/Normalizer/DataReferenceDefinitionNormalizer.php deleted file mode 100644 index 40d394c..0000000 --- a/modules/openapi_json_schema/src/Normalizer/DataReferenceDefinitionNormalizer.php +++ /dev/null @@ -1,86 +0,0 @@ -entityTypeManager = $entity_type_manager; - } - - /** - * {@inheritdoc} - */ - public function normalize($entity, $format = NULL, array $context = array()) { - /* @var $entity \Drupal\Core\TypedData\DataReferenceDefinitionInterface */ - if (!$this->validateEntity($entity)) { - return []; - } - - // DataDefinitionNormalizer::normalize() results in extraneous structures - // added to the schema for this field element (e.g., entity) - return $this->extractPropertyData($entity, $context); - } - - /** - * Ensure the entity type is one we support for schema reference. - * - * If somehow the entity does not exist, or is not a ContentEntity, skip it. - * - * @param mixed $entity - * The object to be normalized. - * - * @return bool - * TRUE if valid for use. - */ - protected function validateEntity($entity) { - // Only entity references have a schema. - // This leads to incompatibility with alternate reference modules such as - // Dynamic Entity Reference. - if ($entity->getDataType() != 'entity_reference') { - return FALSE; - } - - $entity_type_plugin = $this->entityTypeManager->getDefinition($entity->getConstraint('EntityType'), FALSE); - if (empty($entity_type_plugin) - || !($entity_type_plugin->isSubclassOf('\Drupal\Core\Entity\ContentEntityInterface'))) { - return FALSE; - } - - return TRUE; - } - -} diff --git a/modules/openapi_json_schema/src/Normalizer/FieldDefinitionNormalizer.php b/modules/openapi_json_schema/src/Normalizer/FieldDefinitionNormalizer.php deleted file mode 100644 index b141fc0..0000000 --- a/modules/openapi_json_schema/src/Normalizer/FieldDefinitionNormalizer.php +++ /dev/null @@ -1,46 +0,0 @@ -getDefaultValueLiteral(); - if (!empty($default_value)) { - $normalized['properties'][$context['name']]['default'] = $default_value; - } - - // The cardinality is the configured maximum number of values the field can - // contain. If unlimited, we do not include a maxItems attribute. - $cardinality = $entity->getFieldStorageDefinition()->getCardinality(); - if ($cardinality != FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED) { - $normalized['properties'][$context['name']]['maxItems'] = $cardinality; - } - - return $normalized; - } - -} diff --git a/modules/openapi_json_schema/src/Normalizer/ListDataDefinitionNormalizer.php b/modules/openapi_json_schema/src/Normalizer/ListDataDefinitionNormalizer.php deleted file mode 100644 index e85be1d..0000000 --- a/modules/openapi_json_schema/src/Normalizer/ListDataDefinitionNormalizer.php +++ /dev/null @@ -1,79 +0,0 @@ -extractPropertyData($entity, $context); - $property['type'] = 'array'; - - // This retrieves the definition common to ever item in the list, and - // serializes it so we can define how members of the array should look. - // There are no lists that might contain items of different types. - $property['items'] = $this->serializer->normalize( - $entity->getItemDefinition(), - $format, - $context - ); - - // FieldDefinitionInterface::isRequired() explicitly indicates there must be - // at least one item in the list. Extending this reasoning, the same must be - // true of all ListDataDefinitions. - if ($this->requiredProperty($entity)) { - $property['minItems'] = 1; - } - - $normalized = ['properties' => []]; - $normalized['properties'][$context['name']] = $property; - if ($this->requiredProperty($entity)) { - $normalized['required'][] = $context['name']; - } - - return $normalized; - } - - /** - * Determine if the current field is a reference field. - * - * @param \Drupal\Core\TypedData\ListDataDefinitionInterface $entity - * The list definition to be checked. - * - * @return bool - * TRUE if it is a reference, FALSE otherwise. - */ - protected function isReferenceField(ListDataDefinitionInterface $entity) { - $item = $entity->getItemDefinition(); - if ($item instanceof ComplexDataDefinitionInterface) { - $main = $item->getPropertyDefinition($item->getMainPropertyName()); - // @todo use an interface or API call instead of an object check. - return ($main instanceof DataReferenceTargetDefinition); - } - - return FALSE; - } - -} diff --git a/modules/openapi_json_schema/src/Normalizer/NormalizerBase.php b/modules/openapi_json_schema/src/Normalizer/NormalizerBase.php deleted file mode 100644 index fa0206f..0000000 --- a/modules/openapi_json_schema/src/Normalizer/NormalizerBase.php +++ /dev/null @@ -1,90 +0,0 @@ -formats) && parent::supportsNormalization($data, $format); - } - - /** - * {@inheritdoc} - */ - public function supportsDenormalization($data, $type, $format = NULL) { - return FALSE; - } - - /** - * {@inheritdoc} - */ - public function denormalize($data, $class, $format = NULL, array $context = array()) { - return FALSE; - } - - /** - * Normalize an array of data definitions. - * - * This normalization process gets an array of properties and an array of - * properties that are required by name. This is needed by the - * SchemataSchemaNormalizer, otherwise it would have been placed in - * DataDefinitionNormalizer. - * - * @param \Drupal\Core\TypedData\DataDefinitionInterface[] $items - * An array of data definition properties to be normalized. - * @param string $format - * Format identifier of the current serialization process. - * @param array $context - * Operating context of the serializer. - * - * @return array - * Array containing one or two nested arrays. - * - properties: The array of all normalized properties. - * - required: The array of required properties by name. - */ - protected function normalizeProperties($items, $format, $context = []) { - $normalized = []; - foreach ($items as $name => $property) { - $context['name'] = $name; - $item = $this->serializer->normalize($property, $format, $context); - if (!empty($item)) { - $normalized = NestedArray::mergeDeep($normalized, $item); - } - } - - return $normalized; - } - - /** - * Determine if the given property is a required element of the schema. - * - * @param \Drupal\Core\TypedData\DataDefinitionInterface $property - * The data property to be evaluated. - * - * @return bool - * Whether the property should be treated as required for schema - * purposes. - */ - protected function requiredProperty(DataDefinitionInterface $property) { - return $property->isRequired(); - } - -} diff --git a/modules/openapi_json_schema/src/Normalizer/SchemataSchemaNormalizer.php b/modules/openapi_json_schema/src/Normalizer/SchemataSchemaNormalizer.php deleted file mode 100644 index 3c767e2..0000000 --- a/modules/openapi_json_schema/src/Normalizer/SchemataSchemaNormalizer.php +++ /dev/null @@ -1,93 +0,0 @@ -routeProvider = $route_provider; - } - - /** - * {@inheritdoc} - */ - public function normalize($entity, $format = NULL, array $context = array()) { - // Create the array of normalized fields, starting with the URI. - /* @var $entity \Drupal\openapi_json_schema\Schema\SchemaInterface */ - $normalized = [ - '$schema' => 'http://json-schema.org/draft-04/schema#', - 'type' => 'object', - ]; - - // If REST route is enabled add id. - if ($routes = $this->routeProvider->getRoutesByNames([SchemaUrl::getRouteName($format)])) { - $normalized['id'] = SchemaUrl::fromSchema($format, $entity)->toString(); - } - $normalized = array_merge($normalized, $entity->getMetadata()); - - // Stash schema request parameters. - $context['entityTypeId'] = $entity->getEntityTypeId(); - $context['bundleId'] = $entity->getBundleId(); - - // Retrieve 'properties' and possibly 'required' nested arrays. - $properties = $this->normalizeProperties( - $this->getProperties($entity, $format, $context), - $format, - $context - ); - $normalized = NestedArray::mergeDeep($normalized, $properties); - - return $normalized; - } - - /** - * Identify properties of the data definition to normalize. - * - * This allow subclasses of the normalizer to build white or blacklisting - * functionality on what will be included in the serialized schema. The JSON - * Schema serializer already has logic to drop any properties that are empty - * values after processing, but this allows cleaner, centralized logic. - * - * @param \Drupal\openapi_json_schema\Schema\SchemaInterface $entity - * The Schema object whose properties the serializer will present. - * @param string $format - * The serializer format. Defaults to NULL. - * @param array $context - * The current serializer context. - * - * @return \Drupal\Core\TypedData\DataDefinitionInterface[] - * The DataDefinitions to be processed. - */ - protected static function getProperties(SchemaInterface $entity, $format = NULL, $context = []) { - return $entity->getProperties(); - } - -} diff --git a/modules/openapi_json_schema/src/Plugin/Type/TypeMapperPluginManager.php b/modules/openapi_json_schema/src/Plugin/Type/TypeMapperPluginManager.php deleted file mode 100644 index 0b48fa9..0000000 --- a/modules/openapi_json_schema/src/Plugin/Type/TypeMapperPluginManager.php +++ /dev/null @@ -1,47 +0,0 @@ - $this->getPluginId(), - ]; - - if ($item = $property->getLabel()) { - $value['title'] = $item; - } - if ($item = $property->getDescription()) { - $value['description'] = $item; - } - - return $value; - } - -} diff --git a/modules/openapi_json_schema/src/Plugin/TypeMapperInterface.php b/modules/openapi_json_schema/src/Plugin/TypeMapperInterface.php deleted file mode 100644 index 68c8363..0000000 --- a/modules/openapi_json_schema/src/Plugin/TypeMapperInterface.php +++ /dev/null @@ -1,23 +0,0 @@ -getDataType(); - return $value; - } - -} diff --git a/modules/openapi_json_schema/src/Plugin/json_schema/type_mapper/FilterFormatTypeMapper.php b/modules/openapi_json_schema/src/Plugin/json_schema/type_mapper/FilterFormatTypeMapper.php deleted file mode 100644 index 6d28cdd..0000000 --- a/modules/openapi_json_schema/src/Plugin/json_schema/type_mapper/FilterFormatTypeMapper.php +++ /dev/null @@ -1,26 +0,0 @@ -nodeType = NodeType::load($bundle); - parent::__construct($entity_type, $bundle, $properties); - } - - /** - * {@inheritdoc} - */ - protected function createDescription($entityType, $bundle = '') { - $description = $this->nodeType->getDescription(); - if (empty($description)) { - return parent::createDescription($entityType, $bundle); - } - - return $description; - } - -} diff --git a/modules/openapi_json_schema/src/Schema/Schema.php b/modules/openapi_json_schema/src/Schema/Schema.php deleted file mode 100644 index 4b142a3..0000000 --- a/modules/openapi_json_schema/src/Schema/Schema.php +++ /dev/null @@ -1,219 +0,0 @@ -entityType = $entity_type; - $this->bundle = $bundle; - $this->addProperties($properties); - - // These cache tags seem like they are essential to Schema cache variation. - // It is not clear how to verify these cache tags, or how to pull them from - // the injected dependencies. - $this->addCacheableDependency((new CacheableMetadata())->addCacheTags( - [ - 'entity_bundles', - 'entity_field_info', - 'entity_types', - ] - )); - - $this->metadata['title'] = $this->createTitle( - $this->getEntityTypeId(), - $this->getBundleId() - ) . ' Schema'; - - $this->metadata['description'] = $this->createDescription( - $this->getEntityTypeId(), - $this->getBundleId() - ); - - } - - /** - * {@inheritdoc} - */ - public function addProperties($properties) { - $this->properties += $properties; - } - - /** - * {@inheritdoc} - */ - public function getEntityTypeId() { - return $this->entityType->getEntityTypeId(); - } - - /** - * {@inheritdoc} - */ - public function getBundleId() { - return $this->bundle; - } - - /** - * {@inheritdoc} - */ - public function getProperties() { - return $this->properties; - } - - /** - * {@inheritdoc} - */ - public function getMetadata() { - return $this->metadata; - } - - /** - * Generates a title for the schema based on a simple trio of parameters. - * - * @param string $required - * This value will be used as the prefix. - * @param string $optional - * Optional value to be separated from the required prefix if present. - * @param string $sep - * Separator string to be used. - * - * @return string - * The title value. - */ - protected function createTitle($required, $optional = '', $sep = ':') { - return empty($optional) ? $required : $required . $sep . $optional; - } - - /** - * Generates a description for the schema based on the types. - * - * @param string $entityType - * Required entity type which the schema defines. - * @param string $bundle - * Optional value to be separated from the required prefix if present. - * - * @return string - * The description value. - */ - protected function createDescription($entityType, $bundle = '') { - $output = "Describes the payload for '$entityType' entities"; - if (!empty($bundle)) { - $output .= " of the '$bundle' bundle."; - } - else { - $output .= '.'; - } - - return $output; - } - - /** - * Magic method: Unsets a property. - * - * @param string $name - * The name of the property to unset; e.g., 'title' or 'name'. - */ - public function __unset($name) { - unset($this->properties[$name]); - } - - /** - * Magic method: Determines whether a property is set. - * - * @param string $name - * The name of the property to check; e.g., 'title' or 'name'. - * - * @return bool - * Returns TRUE if the property exists and is set, FALSE otherwise. - */ - public function __isset($name) { - return isset($this->properties[$name]); - } - - /** - * Magic method: Sets a property value. - * - * @param string $name - * The name of the property to set; e.g., 'title' or 'name'. - * @param \Drupal\Core\TypedData\DataDefinitionInterface $value - * The value to set. - */ - public function __set($name, DataDefinitionInterface $value) { - $this->properties[$name] = $value; - } - - /** - * Magic method: Gets a property value. - * - * @param string $name - * The name of the property to get; e.g., 'title' or 'name'. - * - * @param \Drupal\Core\TypedData\DataDefinitionInterface - * The property object. - */ - public function __get($name) { - $this->properties[$name] = $value; - } - -} diff --git a/modules/openapi_json_schema/src/Schema/SchemaInterface.php b/modules/openapi_json_schema/src/Schema/SchemaInterface.php deleted file mode 100644 index 6de174b..0000000 --- a/modules/openapi_json_schema/src/Schema/SchemaInterface.php +++ /dev/null @@ -1,57 +0,0 @@ -logger = $logger; - $this->entityTypeManager = $entity_type_manager; - $this->entityTypeBundleInfo = $entity_type_bundle_info; - $this->typedDataManager = $typed_data_manager; - } - - /** - * Assemble a schema object based on the requested entity type. - * - * @param string $entity_type - * URL input specifying an entity type to be processed. - * @param string $bundle - * URL input specifying an entity bundle to be processed. May be NULL - * for support of entities that do not have bundles. - * - * @return \Drupal\openapi_json_schema\Schema\Schema - * A Schema object which can be processed as a Rest Resource response. - * This will likely be converted into an interface or base class here. - */ - public function create($entity_type, $bundle = NULL) { - $entity_type_plugin = $this->entityTypeManager->getDefinition($entity_type, FALSE); - if (empty($entity_type_plugin)) { - $this->logger->warning('Invalid Entity Type "%entity_type" specified.', [ - '%entity_type' => $entity_type, - ]); - return []; - } - elseif (!($entity_type_plugin->isSubclassOf('\Drupal\Core\Entity\ContentEntityInterface'))) { - $this->logger->warning('Only Content Entities are supported.'); - return []; - } - - $bundles = $this->entityTypeBundleInfo->getBundleInfo($entity_type); - if (!empty($bundle) && !array_key_exists($bundle, $bundles)) { - $this->logger->warning('Specified Entity Bundle "%bundle" does not exist.', [ - '%bundle' => $bundle, - ]); - return []; - } - - if (!empty($bundle)) { - $data_definition = $this->typedDataManager->createDataDefinition("entity:" . $entity_type . ":" . $bundle); - } - else { - $data_definition = $this->typedDataManager->createDataDefinition("entity:" . $entity_type); - } - - if ($entity_type == 'node' && !empty($bundle)) { - $class = '\Drupal\openapi_json_schema\Schema\NodeSchema'; - } - else { - $class = '\Drupal\openapi_json_schema\Schema\Schema'; - } - - $schema = new $class( - $data_definition, - $bundle, - $data_definition->getPropertyDefinitions() - ); - - $this->logger->notice('Schema generated for Entity Type (%entity_type) and Bundle (%bundle).', [ - '%entity_type' => $entity_type, - '%bundle' => empty($bundle) ? 'N/A' : $bundle, - ]); - - return $schema; - } - -} diff --git a/modules/openapi_json_schema/src/SchemaUrl.php b/modules/openapi_json_schema/src/SchemaUrl.php deleted file mode 100644 index 3b7b9ef..0000000 --- a/modules/openapi_json_schema/src/SchemaUrl.php +++ /dev/null @@ -1,81 +0,0 @@ -getEntityTypeId(), - $schema->getBundleId() - ); - } - - /** - * Build a URI to a schema resource. - * - * @param string $format - * The format or type of schema. - * @param string $entity_type - * The entity type. - * @param string $bundle - * The entity bundle. - * - * @return \Drupal\Core\Url - * The schema resource Url object. - */ - public static function fromOptions($format, $entity_type, $bundle = NULL) { - $route = static::getRouteName($format, $bundle); - - $parameters = [ - 'entity_type' => $entity_type, - ]; - if (isset($bundle)) { - $parameters['bundle'] = $bundle; - } - - return Url::fromRoute($route, $parameters, [ - 'query' => [ - '_format' => $format, - ], - 'absolute' => TRUE, - ]); - } - - /** - * Determine the route name. - * - * @param string $format - * The route format. - * @param string $bundle - * The bundle name. - * - * @return string - * The route name. - */ - public static function getRouteName($format, $bundle = '') { - return empty($bundle) ? 'rest.schemata_entity_base.GET.' . $format - : 'rest.schemata_entity_bundle.GET.' . $format; - } - -} diff --git a/openapi.info.yml b/openapi.info.yml index ccea6a0..e4e5e07 100644 --- a/openapi.info.yml +++ b/openapi.info.yml @@ -4,5 +4,4 @@ description: Connects Drupal to the OpenAPI Javascript Library core: 8.x package: OpenAPI dependencies: - - rest (>= 8.2) - - openapi_json_schema + - rest (>= 8.2) \ No newline at end of file diff --git a/openapi.install b/openapi.install deleted file mode 100644 index 2967965..0000000 --- a/openapi.install +++ /dev/null @@ -1,13 +0,0 @@ -install(['openapi_json_schema']); -} diff --git a/src/Controller/OpenApiController.php b/src/Controller/OpenApiController.php index cd4a498..4ac7bb7 100644 --- a/src/Controller/OpenApiController.php +++ b/src/Controller/OpenApiController.php @@ -12,7 +12,6 @@ use Drupal\Core\Entity\FieldableEntityInterface; use Drupal\Core\Routing\RouteProviderInterface; use Drupal\rest\Plugin\Type\ResourcePluginManager; use Drupal\rest\RestResourceConfigInterface; -use Drupal\openapi_json_schema\SchemaFactory; use Symfony\Component\DependencyInjection\ContainerInterface; use Symfony\Component\HttpFoundation\JsonResponse; use Symfony\Component\Routing\Route; @@ -39,13 +38,6 @@ class OpenApiController extends ControllerBase implements ContainerInjectionInte protected $fieldManager; /** - * The Schemata SchemaFactory. - * - * @var \Drupal\schemata\SchemaFactory - */ - protected $schemaFactory; - - /** * The serializer. * * @var \Symfony\Component\Serializer\SerializerInterface @@ -68,18 +60,15 @@ class OpenApiController extends ControllerBase implements ContainerInjectionInte * The entity type manager. * @param \Drupal\Core\Entity\EntityFieldManagerInterface $field_manager * The field manager. - * @param \Drupal\openapi_json_schema\SchemaFactory $schema_factory - * The schema factory. * @param \Symfony\Component\Serializer\Serializer $serializer * The serializer. * @param \Drupal\Core\Routing\RouteProviderInterface $routing_provider * The route provider. */ - public function __construct(ResourcePluginManager $manager, EntityTypeManagerInterface $entity_type_manager, EntityFieldManagerInterface $field_manager, SchemaFactory $schema_factory, Serializer $serializer, RouteProviderInterface $routing_provider) { + public function __construct(ResourcePluginManager $manager, EntityTypeManagerInterface $entity_type_manager, EntityFieldManagerInterface $field_manager, Serializer $serializer, RouteProviderInterface $routing_provider) { $this->manager = $manager; $this->entityTypeManager = $entity_type_manager; $this->fieldManager = $field_manager; - $this->schemaFactory = $schema_factory; $this->serializer = $serializer; $this->routingProvider = $routing_provider; } @@ -92,7 +81,6 @@ class OpenApiController extends ControllerBase implements ContainerInjectionInte $container->get('plugin.manager.rest'), $container->get('entity_type.manager'), $container->get('entity_field.manager'), - $container->get('openapi_json_schema.schema_factory'), $container->get('serializer'), $container->get('router.route_provider') ); diff --git a/src/Tests/OpenAPIResourceTest.php b/src/Tests/OpenAPIResourceTest.php index 388eb36..d4aa2cb 100644 --- a/src/Tests/OpenAPIResourceTest.php +++ b/src/Tests/OpenAPIResourceTest.php @@ -23,7 +23,6 @@ class OpenAPIResourceTest extends OpenApiTestBase { 'serialization', 'rest', 'openapi', - 'openapi_json_schema', ]; /**