feat: Added more OpenApi context to generated api resources

roadiz · Jul 26, 2023 · 29c8fa3 · 29c8fa3
1 parent 535cad7
commit 29c8fa3
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 2 deletions.
diff --git a/config/api_resources/nsarticle.yml b/config/api_resources/nsarticle.yml
@@ -60,3 +60,10 @@ App\GeneratedEntity\NSArticle:
                     - walker_metadata
                     - meta
                     - children
+            openapiContext:
+                tags:
+                    - WebResponse
+                summary: 'Get a resource by its path wrapped in a WebResponse object'
+                description: 'Get a resource by its path wrapped in a WebResponse'
+                parameters:
+                    - { type: string, name: path, in: query, required: true, description: 'Resource path, or `/` for home page', schema: { type: string } }
diff --git a/config/api_resources/nsoffer.yml b/config/api_resources/nsoffer.yml
@@ -51,3 +51,10 @@ App\GeneratedEntity\NSOffer:
                     - walker_metadata
                     - meta
                     - children
+            openapiContext:
+                tags:
+                    - WebResponse
+                summary: 'Get a resource by its path wrapped in a WebResponse object'
+                description: 'Get a resource by its path wrapped in a WebResponse'
+                parameters:
+                    - { type: string, name: path, in: query, required: true, description: 'Resource path, or `/` for home page', schema: { type: string } }
diff --git a/config/api_resources/nspage.yml b/config/api_resources/nspage.yml
@@ -66,3 +66,10 @@ App\GeneratedEntity\NSPage:
                     - walker_metadata
                     - meta
                     - children
+            openapiContext:
+                tags:
+                    - WebResponse
+                summary: 'Get a resource by its path wrapped in a WebResponse object'
+                description: 'Get a resource by its path wrapped in a WebResponse'
+                parameters:
+                    - { type: string, name: path, in: query, required: true, description: 'Resource path, or `/` for home page', schema: { type: string } }
diff --git a/lib/RoadizCoreBundle/config/services.yaml b/lib/RoadizCoreBundle/config/services.yaml
@@ -1,7 +1,7 @@
 ---
 parameters:
-    roadiz_core.cms_version: '2.1.32'
-    roadiz_core.cms_version_prefix: 'main'
+    roadiz_core.cms_version: '2.2.x-dev'
+    roadiz_core.cms_version_prefix: 'develop'
     env(APP_NAMESPACE): "roadiz"
     env(APP_VERSION): "0.1.0"
     env(APP_USE_ACCEPT_LANGUAGE_HEADER): 'false'

diff --git a/lib/RoadizCoreBundle/src/NodeType/ApiResourceGenerator.php b/lib/RoadizCoreBundle/src/NodeType/ApiResourceGenerator.php
@@ -210,6 +210,23 @@ protected function getItemOperations(NodeTypeInterface $nodeType): array
                         'children',
                     ])
                 ],
+                'openapiContext' => [
+                    'tags' => ['WebResponse'],
+                    'summary' => 'Get a resource by its path wrapped in a WebResponse object',
+                    'description' => 'Get a resource by its path wrapped in a WebResponse',
+                    'parameters' => [
+                        [
+                            'type' => 'string',
+                            'name' => 'path',
+                            'in' => 'query',
+                            'required' => true,
+                            'description' => 'Resource path, or `/` for home page',
+                            'schema' => [
+                                'type' => 'string',
+                            ],
+                        ]
+                    ]
+                ]
             ];
         }