Implementation

Author: SOHELAHMED7

src/generator/ApiGenerator.php

@@ -456,6 +456,7 @@ public function makeConfig():Config
                 unset($props[$key]);
             }
             $this->config = new Config($props);
+            $this->config->resolvedOpenApi = $this->getOpenApiWithoutReferences();
             $this->config->setFileRenderer(function ($template, $params) {
                 return $this->render($template, $params);
             });
@@ -511,9 +512,9 @@ protected function getOpenApiWithoutReferences():OpenApi
         if ($this->_openApiWithoutRef === null) {
             $file = Yii::getAlias($this->openApiPath);
             if (StringHelper::endsWith($this->openApiPath, '.json', false)) {
-                $this->_openApiWithoutRef = Reader::readFromJsonFile($file, OpenApi::class, true);
+                $this->_openApiWithoutRef = Reader::readFromJsonFile($file, OpenApi::class, true, true);
             } else {
-                $this->_openApiWithoutRef = Reader::readFromYamlFile($file, OpenApi::class, true);
+                $this->_openApiWithoutRef = Reader::readFromYamlFile($file, OpenApi::class, true, true);
             }
         }
         return $this->_openApiWithoutRef;

src/lib/AttributeResolver.php

@@ -76,10 +76,19 @@ class AttributeResolver
     /** @var Config */
     private $config;
 
-    public function __construct(string $schemaName, ComponentSchema $schema, JunctionSchemas $junctions, ?Config $config = null)
+    public $resolvedComponentSchema;
+
+    public function __construct(
+        string $schemaName,
+        ComponentSchema $schema,
+        JunctionSchemas $junctions,
+        ?Config $config = null,
+        $resolvedComponentSchema = null
+    )
     {
         $this->schemaName = $schemaName;
         $this->componentSchema = $schema;
+        $this->resolvedComponentSchema = $resolvedComponentSchema;
         $this->tableName = $schema->resolveTableName($schemaName);
         $this->junctions = $junctions;
         $this->isJunctionSchema = $junctions->isJunctionSchema($schemaName);
@@ -94,9 +103,18 @@ public function __construct(string $schemaName, ComponentSchema $schema, Junctio
      */
     public function resolve():DbModel
     {
-        foreach ($this->componentSchema->getProperties() as $property) {
+        foreach ($this->componentSchema->getProperties() as $key => $property) {
             /** @var $property \cebe\yii2openapi\lib\openapi\PropertySchema */
 
+            $resolvedProperty = null;
+            if ($this->resolvedComponentSchema) {
+                foreach ($this->resolvedComponentSchema->getProperties() as $key2 => $prop) {
+                    if ($key === $key2) {
+                        $resolvedProperty = $prop;
+                    }
+                }
+            }
+
             $isRequired = $this->componentSchema->isRequiredProperty($property->getName());
             $nullableValue = $property->getProperty()->getSerializableData()->nullable ?? null;
             if ($nullableValue === false) { // see docs in README regarding NOT NULL, required and nullable
@@ -106,9 +124,9 @@ public function resolve():DbModel
             if ($this->isJunctionSchema) {
                 $this->resolveJunctionTableProperty($property, $isRequired);
             } elseif ($this->hasMany2Many) {
-                $this->resolveHasMany2ManyTableProperty($property, $isRequired);
+                $this->resolveHasMany2ManyTableProperty($property, $isRequired, $resolvedProperty);
             } else {
-                $this->resolveProperty($property, $isRequired, $nullableValue);
+                $this->resolveProperty($property, $isRequired, $nullableValue, $resolvedProperty);
             }
         }
         return Yii::createObject(DbModel::class, [
@@ -169,7 +187,7 @@ protected function resolveJunctionTableProperty(PropertySchema $property, bool $
      * @throws \cebe\yii2openapi\lib\exceptions\InvalidDefinitionException
      * @throws \yii\base\InvalidConfigException
      */
-    protected function resolveHasMany2ManyTableProperty(PropertySchema $property, bool $isRequired):void
+    protected function resolveHasMany2ManyTableProperty(PropertySchema $property, bool $isRequired, $resolvedProperty = null):void
     {
         if ($this->junctions->isManyToManyProperty($this->schemaName, $property->getName())) {
             return;
@@ -203,7 +221,7 @@ protected function resolveHasMany2ManyTableProperty(PropertySchema $property, bo
             return;
         }
 
-        $this->resolveProperty($property, $isRequired);
+        $this->resolveProperty($property, $isRequired, $resolvedProperty);
     }
 
     /**
@@ -216,14 +234,15 @@ protected function resolveHasMany2ManyTableProperty(PropertySchema $property, bo
     protected function resolveProperty(
         PropertySchema $property,
         bool $isRequired,
-        $nullableValue = 'ARG_ABSENT'
+        $nullableValue = 'ARG_ABSENT',
+        $resolvedProperty = null
     ):void {
         if ($nullableValue === 'ARG_ABSENT') {
             $nullableValue = $property->getProperty()->getSerializableData()->nullable ?? null;
         }
         $attribute = Yii::createObject(Attribute::class, [$property->getName()]);
         $attribute->setRequired($isRequired)
-                  ->setDescription($property->getAttr('description', ''))
+                  ->setDescription($resolvedProperty ? $resolvedProperty->getAttr('description', '') : $property->getAttr('description', ''))
                   ->setReadOnly($property->isReadonly())
                   ->setDefault($property->guessDefault())
                   ->setXDbType($property->getAttr(CustomSpecAttr::DB_TYPE))
@@ -262,7 +281,7 @@ protected function resolveProperty(
             $attribute->setPhpType($fkProperty->guessPhpType())
                       ->setDbType($fkProperty->guessDbType(true))
                       ->setSize($fkProperty->getMaxLength())
-                      ->setDescription($property->getRefSchema()->getDescription())
+                      ->setDescription($resolvedProperty ? $resolvedProperty->getAttr('description', '') : $property->getRefSchema()->getDescription())
                       ->setDefault($fkProperty->guessDefault())
                       ->setLimits($min, $max, $fkProperty->getMinLength());
 

src/lib/Config.php

@@ -164,6 +164,8 @@ class Config extends BaseObject
      */
     private $openApi;
 
+    public $resolvedOpenApi;
+
     /**
      * @return \cebe\openapi\spec\OpenApi
      * @throws \cebe\openapi\exceptions\IOException

src/lib/SchemaToDatabase.php

@@ -81,6 +81,7 @@ public function prepareModels():array
         $junctions = $this->findJunctionSchemas();
         foreach ($openApi->components->schemas as $schemaName => $openApiSchema) {
             $schema = Yii::createObject(ComponentSchema::class, [$openApiSchema, $schemaName]);
+            $resolvedComponentSchema = Yii::createObject(ComponentSchema::class, [$this->config->resolvedOpenApi->components->schemas[$schemaName], $schemaName]);
 
             if (!$this->canGenerateModel($schemaName, $schema)) {
                 continue;
@@ -89,7 +90,7 @@ public function prepareModels():array
                 $schemaName = $junctions->trimPrefix($schemaName);
             }
             /**@var \cebe\yii2openapi\lib\AttributeResolver $resolver */
-            $resolver = Yii::createObject(AttributeResolver::class, [$schemaName, $schema, $junctions, $this->config]);
+            $resolver = Yii::createObject(AttributeResolver::class, [$schemaName, $schema, $junctions, $this->config, $resolvedComponentSchema]);
             $models[$schemaName] = $resolver->resolve();
         }
         foreach ($models as  $model) {