Generate newest code from openapi.yaml

bundesAPI · Aug 1, 2023 · 05a904a · 05a904a
1 parent 9cd72f9
commit 05a904a
Show file tree

Hide file tree

Showing 10 changed files with 127 additions and 78 deletions.
diff --git a/python-client/README.md b/python-client/README.md
@@ -8,7 +8,7 @@ Die Authentifizierung funktioniert per OAuth 2 Client Credentials mit JWTs. Folg
 
 **ClientSecret:** 93fce94c-5be2-4dc8-b040-c62818a4b003
 
-**Achtung**: der generierte Token muss bei folgenden GET-requests an https://rest.arbeitsagentur.de/jobboerse/bewerbersuche-service/pc/v1/bewerber im header als 'OAuthAccessToken' inkludiert werden.
+**Achtung**: der generierte Token muss bei folgenden GET-requests im header als *'OAuthAccessToken'* inkludiert werden. Alternativ kann man bei folgenden GET-requests auch direkt die *client_id* als Header-Parameter *'X-API-Key'* übergeben - *'OAuthAccessToken'* ist in diesem Fall nicht erforderlich. 🚀
 
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
@@ -67,6 +67,16 @@ configuration = Bewerberboerse.Configuration(
     host = "https://rest.arbeitsagentur.de/jobboerse/bewerbersuche-service"
 )
 
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: APIKeyHeaders
+configuration.api_key['APIKeyHeaders'] = 'YOUR_API_KEY'
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['APIKeyHeaders'] = 'Bearer'
 
 
 # Enter a context with an instance of the API client
@@ -110,12 +120,11 @@ Class | Method | HTTP request | Description
 ## Documentation For Authorization
 
 
-## clientCredAuth
+## APIKeyHeaders
 
-- **Type**: OAuth
-- **Flow**: application
-- **Authorization URL**: 
-- **Scopes**: N/A
+- **Type**: API key
+- **API key parameter name**: X-API-Key
+- **Location**: HTTP header
 
 
 ## Author

diff --git a/python-client/deutschland/Bewerberboerse/__init__.py b/python-client/deutschland/Bewerberboerse/__init__.py
@@ -3,7 +3,7 @@
 """
     Arbeitsagentur Bewerberbörse API
 
-     Eine der größten Datenbanken für Bewerbende in Deutschland durchsuchen.   Die Authentifizierung funktioniert per OAuth 2 Client Credentials mit JWTs. Folgende Client-Credentials können dafür verwendet werden:  **ClientID:** 919b0af7-6e5f-4542-a7f5-04268b8bae2e  **ClientSecret:** 93fce94c-5be2-4dc8-b040-c62818a4b003  **Achtung**: der generierte Token muss bei folgenden GET-requests an https://rest.arbeitsagentur.de/jobboerse/bewerbersuche-service/pc/v1/bewerber im header als 'OAuthAccessToken' inkludiert werden.   # noqa: E501
+     Eine der größten Datenbanken für Bewerbende in Deutschland durchsuchen.   Die Authentifizierung funktioniert per OAuth 2 Client Credentials mit JWTs. Folgende Client-Credentials können dafür verwendet werden:  **ClientID:** 919b0af7-6e5f-4542-a7f5-04268b8bae2e  **ClientSecret:** 93fce94c-5be2-4dc8-b040-c62818a4b003  **Achtung**: der generierte Token muss bei folgenden GET-requests im header als *'OAuthAccessToken'* inkludiert werden. Alternativ kann man bei folgenden GET-requests auch direkt die *client_id* als Header-Parameter *'X-API-Key'* übergeben - *'OAuthAccessToken'* ist in diesem Fall nicht erforderlich. 🚀   # noqa: E501
 
     The version of the OpenAPI document: 1.0.0
     Contact: [email protected]

diff --git a/python-client/deutschland/Bewerberboerse/api/default_api.py b/python-client/deutschland/Bewerberboerse/api/default_api.py
@@ -1,7 +1,7 @@
 """
     Arbeitsagentur Bewerberbörse API
 
-     Eine der größten Datenbanken für Bewerbende in Deutschland durchsuchen.   Die Authentifizierung funktioniert per OAuth 2 Client Credentials mit JWTs. Folgende Client-Credentials können dafür verwendet werden:  **ClientID:** 919b0af7-6e5f-4542-a7f5-04268b8bae2e  **ClientSecret:** 93fce94c-5be2-4dc8-b040-c62818a4b003  **Achtung**: der generierte Token muss bei folgenden GET-requests an https://rest.arbeitsagentur.de/jobboerse/bewerbersuche-service/pc/v1/bewerber im header als 'OAuthAccessToken' inkludiert werden.   # noqa: E501
+     Eine der größten Datenbanken für Bewerbende in Deutschland durchsuchen.   Die Authentifizierung funktioniert per OAuth 2 Client Credentials mit JWTs. Folgende Client-Credentials können dafür verwendet werden:  **ClientID:** 919b0af7-6e5f-4542-a7f5-04268b8bae2e  **ClientSecret:** 93fce94c-5be2-4dc8-b040-c62818a4b003  **Achtung**: der generierte Token muss bei folgenden GET-requests im header als *'OAuthAccessToken'* inkludiert werden. Alternativ kann man bei folgenden GET-requests auch direkt die *client_id* als Header-Parameter *'X-API-Key'* übergeben - *'OAuthAccessToken'* ist in diesem Fall nicht erforderlich. 🚀   # noqa: E501
 
     The version of the OpenAPI document: 1.0.0
     Contact: [email protected]
@@ -53,7 +53,7 @@ def __init__(self, api_client=None):
                         )
                     },
                 ),
-                "auth": [],
+                "auth": ["APIKeyHeaders"],
                 "endpoint_path": "/pc/v1/bewerber",
                 "operation_id": "bewerberboerse",
                 "http_method": "GET",
@@ -169,7 +169,7 @@ def __init__(self, api_client=None):
                         )
                     },
                 ),
-                "auth": [],
+                "auth": ["APIKeyHeaders"],
                 "endpoint_path": "/pc/v1/bewerberdetails/{referenznummer}",
                 "operation_id": "bewerberdetails",
                 "http_method": "GET",

diff --git a/python-client/deutschland/Bewerberboerse/api_client.py b/python-client/deutschland/Bewerberboerse/api_client.py
@@ -1,7 +1,7 @@
 """
     Arbeitsagentur Bewerberbörse API
 
-     Eine der größten Datenbanken für Bewerbende in Deutschland durchsuchen.   Die Authentifizierung funktioniert per OAuth 2 Client Credentials mit JWTs. Folgende Client-Credentials können dafür verwendet werden:  **ClientID:** 919b0af7-6e5f-4542-a7f5-04268b8bae2e  **ClientSecret:** 93fce94c-5be2-4dc8-b040-c62818a4b003  **Achtung**: der generierte Token muss bei folgenden GET-requests an https://rest.arbeitsagentur.de/jobboerse/bewerbersuche-service/pc/v1/bewerber im header als 'OAuthAccessToken' inkludiert werden.   # noqa: E501
+     Eine der größten Datenbanken für Bewerbende in Deutschland durchsuchen.   Die Authentifizierung funktioniert per OAuth 2 Client Credentials mit JWTs. Folgende Client-Credentials können dafür verwendet werden:  **ClientID:** 919b0af7-6e5f-4542-a7f5-04268b8bae2e  **ClientSecret:** 93fce94c-5be2-4dc8-b040-c62818a4b003  **Achtung**: der generierte Token muss bei folgenden GET-requests im header als *'OAuthAccessToken'* inkludiert werden. Alternativ kann man bei folgenden GET-requests auch direkt die *client_id* als Header-Parameter *'X-API-Key'* übergeben - *'OAuthAccessToken'* ist in diesem Fall nicht erforderlich. 🚀   # noqa: E501
 
     The version of the OpenAPI document: 1.0.0
     Contact: [email protected]
@@ -151,7 +151,6 @@ def __call_api(
             typing.List[typing.Dict[str, typing.Any]]
         ] = None,
     ):
-
         config = self.configuration
 
         # header parameters
@@ -917,7 +916,6 @@ def __call__(self, *args, **kwargs):
         return self.callable(self, *args, **kwargs)
 
     def call_with_http_info(self, **kwargs):
-
         try:
             index = (
                 self.api_client.configuration.server_operation_index.get(

diff --git a/python-client/deutschland/Bewerberboerse/configuration.py b/python-client/deutschland/Bewerberboerse/configuration.py
@@ -1,7 +1,7 @@
 """
     Arbeitsagentur Bewerberbörse API
 
-     Eine der größten Datenbanken für Bewerbende in Deutschland durchsuchen.   Die Authentifizierung funktioniert per OAuth 2 Client Credentials mit JWTs. Folgende Client-Credentials können dafür verwendet werden:  **ClientID:** 919b0af7-6e5f-4542-a7f5-04268b8bae2e  **ClientSecret:** 93fce94c-5be2-4dc8-b040-c62818a4b003  **Achtung**: der generierte Token muss bei folgenden GET-requests an https://rest.arbeitsagentur.de/jobboerse/bewerbersuche-service/pc/v1/bewerber im header als 'OAuthAccessToken' inkludiert werden.   # noqa: E501
+     Eine der größten Datenbanken für Bewerbende in Deutschland durchsuchen.   Die Authentifizierung funktioniert per OAuth 2 Client Credentials mit JWTs. Folgende Client-Credentials können dafür verwendet werden:  **ClientID:** 919b0af7-6e5f-4542-a7f5-04268b8bae2e  **ClientSecret:** 93fce94c-5be2-4dc8-b040-c62818a4b003  **Achtung**: der generierte Token muss bei folgenden GET-requests im header als *'OAuthAccessToken'* inkludiert werden. Alternativ kann man bei folgenden GET-requests auch direkt die *client_id* als Header-Parameter *'X-API-Key'* übergeben - *'OAuthAccessToken'* ist in diesem Fall nicht erforderlich. 🚀   # noqa: E501
 
     The version of the OpenAPI document: 1.0.0
     Contact: [email protected]
@@ -35,56 +35,75 @@
 class Configuration(object):
     """NOTE: This class is auto generated by OpenAPI Generator
 
-    Ref: https://openapi-generator.tech
-    Do not edit the class manually.
-
-    :param host: Base url
-    :param api_key: Dict to store API key(s).
-      Each entry in the dict specifies an API key.
-      The dict key is the name of the security scheme in the OAS specification.
-      The dict value is the API key secret.
-    :param api_key_prefix: Dict to store API prefix (e.g. Bearer)
-      The dict key is the name of the security scheme in the OAS specification.
-      The dict value is an API key prefix when generating the auth data.
-    :param username: Username for HTTP basic authentication
-    :param password: Password for HTTP basic authentication
-    :param discard_unknown_keys: Boolean value indicating whether to discard
-      unknown properties. A server may send a response that includes additional
-      properties that are not known by the client in the following scenarios:
-      1. The OpenAPI document is incomplete, i.e. it does not match the server
-         implementation.
-      2. The client was generated using an older version of the OpenAPI document
-         and the server has been upgraded since then.
-      If a schema in the OpenAPI document defines the additionalProperties attribute,
-      then all undeclared properties received by the server are injected into the
-      additional properties map. In that case, there are undeclared properties, and
-      nothing to discard.
-    :param disabled_client_side_validations (string): Comma-separated list of
-      JSON schema validation keywords to disable JSON schema structural validation
-      rules. The following keywords may be specified: multipleOf, maximum,
-      exclusiveMaximum, minimum, exclusiveMinimum, maxLength, minLength, pattern,
-      maxItems, minItems.
-      By default, the validation is performed for data generated locally by the client
-      and data received from the server, independent of any validation performed by
-      the server side. If the input data does not satisfy the JSON schema validation
-      rules specified in the OpenAPI document, an exception is raised.
-      If disabled_client_side_validations is set, structural validation is
-      disabled. This can be useful to troubleshoot data validation problem, such as
-      when the OpenAPI document validation rules do not match the actual API data
-      received by the server.
-    :param server_index: Index to servers configuration.
-    :param server_variables: Mapping with string values to replace variables in
-      templated server configuration. The validation of enums is performed for
-      variables with defined enum values before.
-    :param server_operation_index: Mapping from operation ID to an index to server
-      configuration.
-    :param server_operation_variables: Mapping from operation ID to a mapping with
-      string values to replace variables in templated server configuration.
-      The validation of enums is performed for variables with defined enum values before.
-    :param ssl_ca_cert: str - the path to a file of concatenated CA certificates
-      in PEM format
-
-    :Example:
+        Ref: https://openapi-generator.tech
+        Do not edit the class manually.
+
+        :param host: Base url
+        :param api_key: Dict to store API key(s).
+          Each entry in the dict specifies an API key.
+          The dict key is the name of the security scheme in the OAS specification.
+          The dict value is the API key secret.
+        :param api_key_prefix: Dict to store API prefix (e.g. Bearer)
+          The dict key is the name of the security scheme in the OAS specification.
+          The dict value is an API key prefix when generating the auth data.
+        :param username: Username for HTTP basic authentication
+        :param password: Password for HTTP basic authentication
+        :param discard_unknown_keys: Boolean value indicating whether to discard
+          unknown properties. A server may send a response that includes additional
+          properties that are not known by the client in the following scenarios:
+          1. The OpenAPI document is incomplete, i.e. it does not match the server
+             implementation.
+          2. The client was generated using an older version of the OpenAPI document
+             and the server has been upgraded since then.
+          If a schema in the OpenAPI document defines the additionalProperties attribute,
+          then all undeclared properties received by the server are injected into the
+          additional properties map. In that case, there are undeclared properties, and
+          nothing to discard.
+        :param disabled_client_side_validations (string): Comma-separated list of
+          JSON schema validation keywords to disable JSON schema structural validation
+          rules. The following keywords may be specified: multipleOf, maximum,
+          exclusiveMaximum, minimum, exclusiveMinimum, maxLength, minLength, pattern,
+          maxItems, minItems.
+          By default, the validation is performed for data generated locally by the client
+          and data received from the server, independent of any validation performed by
+          the server side. If the input data does not satisfy the JSON schema validation
+          rules specified in the OpenAPI document, an exception is raised.
+          If disabled_client_side_validations is set, structural validation is
+          disabled. This can be useful to troubleshoot data validation problem, such as
+          when the OpenAPI document validation rules do not match the actual API data
+          received by the server.
+        :param server_index: Index to servers configuration.
+        :param server_variables: Mapping with string values to replace variables in
+          templated server configuration. The validation of enums is performed for
+          variables with defined enum values before.
+        :param server_operation_index: Mapping from operation ID to an index to server
+          configuration.
+        :param server_operation_variables: Mapping from operation ID to a mapping with
+          string values to replace variables in templated server configuration.
+          The validation of enums is performed for variables with defined enum values before.
+        :param ssl_ca_cert: str - the path to a file of concatenated CA certificates
+          in PEM format
+
+        :Example:
+
+        API Key Authentication Example.
+        Given the following security scheme in the OpenAPI specification:
+          components:
+            securitySchemes:
+              cookieAuth:         # name for the security scheme
+                type: apiKey
+                in: cookie
+                name: JSESSIONID  # cookie name
+
+        You can programmatically set the cookie:
+
+    conf = Bewerberboerse.Configuration(
+        api_key={'cookieAuth': 'abc123'}
+        api_key_prefix={'cookieAuth': 'JSESSIONID'}
+    )
+
+        The following cookie will be added to the HTTP request:
+           Cookie: JSESSIONID abc123
     """
 
     _default = None
@@ -388,12 +407,14 @@ def auth_settings(self):
         :return: The Auth Settings information dict.
         """
         auth = {}
-        if self.access_token is not None:
-            auth["clientCredAuth"] = {
-                "type": "oauth2",
+        if "APIKeyHeaders" in self.api_key:
+            auth["APIKeyHeaders"] = {
+                "type": "api_key",
                 "in": "header",
-                "key": "Authorization",
-                "value": "Bearer " + self.access_token,
+                "key": "X-API-Key",
+                "value": self.get_api_key_with_prefix(
+                    "APIKeyHeaders",
+                ),
             }
         return auth
 

diff --git a/python-client/deutschland/Bewerberboerse/exceptions.py b/python-client/deutschland/Bewerberboerse/exceptions.py
@@ -1,7 +1,7 @@
 """
     Arbeitsagentur Bewerberbörse API
 
-     Eine der größten Datenbanken für Bewerbende in Deutschland durchsuchen.   Die Authentifizierung funktioniert per OAuth 2 Client Credentials mit JWTs. Folgende Client-Credentials können dafür verwendet werden:  **ClientID:** 919b0af7-6e5f-4542-a7f5-04268b8bae2e  **ClientSecret:** 93fce94c-5be2-4dc8-b040-c62818a4b003  **Achtung**: der generierte Token muss bei folgenden GET-requests an https://rest.arbeitsagentur.de/jobboerse/bewerbersuche-service/pc/v1/bewerber im header als 'OAuthAccessToken' inkludiert werden.   # noqa: E501
+     Eine der größten Datenbanken für Bewerbende in Deutschland durchsuchen.   Die Authentifizierung funktioniert per OAuth 2 Client Credentials mit JWTs. Folgende Client-Credentials können dafür verwendet werden:  **ClientID:** 919b0af7-6e5f-4542-a7f5-04268b8bae2e  **ClientSecret:** 93fce94c-5be2-4dc8-b040-c62818a4b003  **Achtung**: der generierte Token muss bei folgenden GET-requests im header als *'OAuthAccessToken'* inkludiert werden. Alternativ kann man bei folgenden GET-requests auch direkt die *client_id* als Header-Parameter *'X-API-Key'* übergeben - *'OAuthAccessToken'* ist in diesem Fall nicht erforderlich. 🚀   # noqa: E501
 
     The version of the OpenAPI document: 1.0.0
     Contact: [email protected]

diff --git a/python-client/deutschland/Bewerberboerse/model_utils.py b/python-client/deutschland/Bewerberboerse/model_utils.py
@@ -1,7 +1,7 @@
 """
     Arbeitsagentur Bewerberbörse API
 
-     Eine der größten Datenbanken für Bewerbende in Deutschland durchsuchen.   Die Authentifizierung funktioniert per OAuth 2 Client Credentials mit JWTs. Folgende Client-Credentials können dafür verwendet werden:  **ClientID:** 919b0af7-6e5f-4542-a7f5-04268b8bae2e  **ClientSecret:** 93fce94c-5be2-4dc8-b040-c62818a4b003  **Achtung**: der generierte Token muss bei folgenden GET-requests an https://rest.arbeitsagentur.de/jobboerse/bewerbersuche-service/pc/v1/bewerber im header als 'OAuthAccessToken' inkludiert werden.   # noqa: E501
+     Eine der größten Datenbanken für Bewerbende in Deutschland durchsuchen.   Die Authentifizierung funktioniert per OAuth 2 Client Credentials mit JWTs. Folgende Client-Credentials können dafür verwendet werden:  **ClientID:** 919b0af7-6e5f-4542-a7f5-04268b8bae2e  **ClientSecret:** 93fce94c-5be2-4dc8-b040-c62818a4b003  **Achtung**: der generierte Token muss bei folgenden GET-requests im header als *'OAuthAccessToken'* inkludiert werden. Alternativ kann man bei folgenden GET-requests auch direkt die *client_id* als Header-Parameter *'X-API-Key'* übergeben - *'OAuthAccessToken'* ist in diesem Fall nicht erforderlich. 🚀   # noqa: E501
 
     The version of the OpenAPI document: 1.0.0
     Contact: [email protected]
@@ -1823,7 +1823,6 @@ def get_allof_instances(self, model_args, constant_args):
     """
     composed_instances = []
     for allof_class in self._composed_schemas["allOf"]:
-
         try:
             if constant_args.get("_spec_property_naming"):
                 allof_instance = allof_class._from_openapi_data(