Browse Source

OAS: Include group descriptions as tags

shalvah 3 years ago
parent
commit
84e2c95ce3
2 changed files with 14 additions and 0 deletions
  1. 7 0
      src/Writing/OpenAPISpecWriter.php
  2. 7 0
      tests/Fixtures/openapi.yaml

+ 7 - 0
src/Writing/OpenAPISpecWriter.php

@@ -13,6 +13,7 @@ use Knuckles\Camel\Output\Parameter;
 use Knuckles\Scribe\Extracting\ParamHelpers;
 use Knuckles\Scribe\Tools\DocumentationConfig;
 use Knuckles\Scribe\Tools\Utils;
+use function array_map;
 
 class OpenAPISpecWriter
 {
@@ -57,6 +58,12 @@ class OpenAPISpecWriter
                 ],
             ],
             'paths' => $this->generatePathsSpec($groupedEndpoints),
+            'tags' => array_map(function (array $group) {
+                return [
+                    'name' => $group['name'],
+                    'description' => $group['description'],
+                ];
+            }, $groupedEndpoints),
         ], $this->generateSecurityPartialSpec());
     }
 

+ 7 - 0
tests/Fixtures/openapi.yaml

@@ -318,4 +318,11 @@ paths:
                                     - contacts
                                     - roles
             security: [ ]
+tags:
+    -
+        name: 'Group A'
+        description: ''
+    -
+        name: Other😎
+        description: ''