Fix naming

ioxio-dataspace · Jul 19, 2024 · cef6041 · cef6041
1 parent 2f4ed40
commit cef6041
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 17 deletions.
diff --git a/definition_tooling/converter/converter.py b/definition_tooling/converter/converter.py
@@ -203,7 +203,9 @@ def request(
         x_authorization_provider: Optional[str] = Header(
             None, description="The bare domain of the system that provided the token."
         ),
-        x_api_token: Optional[str] = Header(None, description="API token"),
+        x_api_key: Optional[str] = Header(
+            None, description="API key or token", title="X-API-Token"
+        ),
     ):
         pass
 

diff --git a/definition_tooling/converter/tests/__snapshots__/test_converter/test_air_quality.json b/definition_tooling/converter/tests/__snapshots__/test_converter/test_air_quality.json
@@ -333,9 +333,9 @@
             }
           },
           {
-            "description": "API token",
+            "description": "API key or token",
             "in": "header",
-            "name": "x-api-token",
+            "name": "x-api-key",
             "required": false,
             "schema": {
               "anyOf": [
@@ -346,8 +346,8 @@
                   "type": "null"
                 }
               ],
-              "description": "API token",
-              "title": "X-Api-Token"
+              "description": "API key or token",
+              "title": "X-API-Token"
             }
           }
         ],

diff --git a/..._tooling/converter/tests/__snapshots__/test_converter/test_company_basic_info_errors.json b/..._tooling/converter/tests/__snapshots__/test_converter/test_company_basic_info_errors.json
@@ -287,9 +287,9 @@
             }
           },
           {
-            "description": "API token",
+            "description": "API key or token",
             "in": "header",
-            "name": "x-api-token",
+            "name": "x-api-key",
             "required": false,
             "schema": {
               "anyOf": [
@@ -300,8 +300,8 @@
                   "type": "null"
                 }
               ],
-              "description": "API token",
-              "title": "X-Api-Token"
+              "description": "API key or token",
+              "title": "X-API-Token"
             }
           }
         ],

diff --git a/...g/converter/tests/__snapshots__/test_converter/test_current_weather_required_headers.json b/...g/converter/tests/__snapshots__/test_converter/test_current_weather_required_headers.json
@@ -348,9 +348,9 @@
             }
           },
           {
-            "description": "API token",
+            "description": "API key or token",
             "in": "header",
-            "name": "x-api-token",
+            "name": "x-api-key",
             "required": false,
             "schema": {
               "anyOf": [
@@ -361,8 +361,8 @@
                   "type": "null"
                 }
               ],
-              "description": "API token",
-              "title": "X-Api-Token"
+              "description": "API key or token",
+              "title": "X-API-Token"
             }
           }
         ],

diff --git a/definition_tooling/converter/tests/__snapshots__/test_converter/test_teapot_deprecated.json b/definition_tooling/converter/tests/__snapshots__/test_converter/test_teapot_deprecated.json
@@ -320,9 +320,9 @@
             }
           },
           {
-            "description": "API token",
+            "description": "API key or token",
             "in": "header",
-            "name": "x-api-token",
+            "name": "x-api-key",
             "required": false,
             "schema": {
               "anyOf": [
@@ -333,8 +333,8 @@
                   "type": "null"
                 }
               ],
-              "description": "API token",
-              "title": "X-Api-Token"
+              "description": "API key or token",
+              "title": "X-API-Token"
             }
           }
         ],