Merge pull request #3437 from appwrite/feat-spec-global-attributes

feat: global attributes in specs

app/config/services.php

@@ -65,6 +65,9 @@ return [
         'tests' => false,
         'optional' => true,
         'icon' => '/images/services/databases.png',
+        'globalAttributes' => [
+            'databaseId'
+        ]
     ],
     'locale' => [
         'key' => 'locale',

app/tasks/specs.php

@@ -197,6 +197,7 @@ $cli
                     $services[] = [
                         'name' => $service['key'] ?? '',
                         'description' => $service['subtitle'] ?? '',
+                        'x-globalAttributes' => $service['globalAttributes'] ?? [],
                     ];
                 }
 

src/Appwrite/Specification/Format/OpenAPI3.php

@@ -263,6 +263,12 @@ class OpenAPI3 extends Format
                     'required' => !$param['optional'],
                 ];
 
+                foreach ($this->services as $service) {
+                    if ($route->getLabel('sdk.namespace', 'default') === $service['name'] && in_array($name, $service['x-globalAttributes'] ?? [])) {
+                        $node['x-global'] = true;
+                    }
+                }
+
                 switch ((!empty($validator)) ? \get_class($validator) : '') {
                     case 'Utopia\Validator\Text':
                         $node['schema']['type'] = $validator->getType();
@@ -390,6 +396,10 @@ class OpenAPI3 extends Format
                     if (\array_key_exists('items', $node['schema'])) {
                         $body['content'][$consumes[0]]['schema']['properties'][$name]['items'] = $node['schema']['items'];
                     }
+
+                    if ($node['x-global'] ?? false) {
+                        $body['content'][$consumes[0]]['schema']['properties'][$name]['x-global'] = true;
+                    }
                 }
 
                 $url = \str_replace(':' . $name, '{' . $name . '}', $url);

src/Appwrite/Specification/Format/Swagger2.php

@@ -252,6 +252,12 @@ class Swagger2 extends Format
                     'required' => !$param['optional'],
                 ];
 
+                foreach ($this->services as $service) {
+                    if ($route->getLabel('sdk.namespace', 'default') === $service['name'] && in_array($name, $service['x-globalAttributes'] ?? [])) {
+                        $node['x-global'] = true;
+                    }
+                }
+
                 switch ((!empty($validator)) ? \get_class($validator) : '') {
                     case 'Utopia\Validator\Text':
                         $node['type'] = $validator->getType();
@@ -378,6 +384,10 @@ class Swagger2 extends Format
                         'x-example' => $node['x-example'] ?? null,
                     ];
 
+                    if ($node['x-global'] ?? false) {
+                        $body['schema']['properties'][$name]['x-global'] = true;
+                    }
+
                     if (\array_key_exists('items', $node)) {
                         $body['schema']['properties'][$name]['items'] = $node['items'];
                     }