feat(OpenAPISpecWriter): add description to schema

knuckleswtf · Oct 1, 2024 · db0d315 · db0d315
1 parent e6e014c
commit db0d315
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/src/Writing/OpenAPISpecWriter.php b/src/Writing/OpenAPISpecWriter.php
@@ -586,10 +586,13 @@ public function generateSchemaForValue(mixed $value, OutputEndpointData $endpoin
                 $properties[$subField] = $this->generateSchemaForValue($subValue, $endpoint, $subFieldPath);
             }
 
-            return [
+            $schema = [
                 'type' => 'object',
                 'properties' => $this->objectIfEmpty($properties),
             ];
+            $this->setDescription($schema, $endpoint, $path);
+
+            return $schema;
         }
 
         $schema = [
@@ -615,6 +618,9 @@ public function generateSchemaForValue(mixed $value, OutputEndpointData $endpoin
         return $schema;
     }
 
+    /**
+     * Set the description for the schema. If the field has a description, it is set in the schema.
+     */
     private function setDescription(array &$schema, OutputEndpointData $endpoint, string $path): void
     {
         if (isset($endpoint->responseFields[$path]->description)) {