feat(devopsarr/prowlarr-py#39)!: update sdk generator to use pydantic…

… 2.x
devopsarr · Feb 12, 2024 · c843093 · c843093
1 parent 6a1468e
commit c843093
Show file tree

Hide file tree

Showing 470 changed files with 62,950 additions and 42,098 deletions.
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION
diff --git a/README.md b/README.md
@@ -3,14 +3,12 @@ Readarr API docs
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-[comment]: # (x-release-please-start-version)
-- Package version: 0.4.1
-
-[comment]: # (x-release-please-end)
+[comment]: # (x-release-please-start-version)$
 - API version: 1.0.0
-
+- Package version: 0.4.1
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 
+[comment]: # (x-release-please-end)$
 ## Requirements.
 
 Python 3.7+
@@ -44,14 +42,16 @@ Then import the package:
 import readarr
 ```
 
+### Tests
+
+Execute `pytest` to run the tests.
+
 ## Getting Started
 
 Please follow the [installation procedure](#installation--usage) and then run the following:
 
 ```python
-from __future__ import print_function
 
-import time
 import readarr
 from readarr.rest import ApiException
 from pprint import pprint
@@ -493,17 +493,20 @@ Class | Method | HTTP request | Description
  - [WriteBookTagsType](docs/WriteBookTagsType.md)
 
 
+<a id="documentation-for-authorization"></a>
 ## Documentation For Authorization
 
 
-## X-Api-Key
+Authentication schemes defined for the API:
+<a id="X-Api-Key"></a>
+### X-Api-Key
 
 - **Type**: API key
 - **API key parameter name**: X-Api-Key
 - **Location**: HTTP header
 
-
-## apikey
+<a id="apikey"></a>
+### apikey
 
 - **Type**: API key
 - **API key parameter name**: apikey

diff --git a/docs/AddAuthorOptions.md b/docs/AddAuthorOptions.md
@@ -2,6 +2,7 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **monitor** | [**MonitorTypes**](MonitorTypes.md) |  | [optional] 

diff --git a/docs/AddBookOptions.md b/docs/AddBookOptions.md
@@ -2,6 +2,7 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **add_type** | [**BookAddType**](BookAddType.md) |  | [optional] 

diff --git a/docs/AllowFingerprinting.md b/docs/AllowFingerprinting.md
@@ -2,6 +2,7 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 

diff --git a/docs/ApiInfoApi.md b/docs/ApiInfoApi.md
@@ -15,13 +15,14 @@ Method | HTTP request | Description
 ### Example
 
 * Api Key Authentication (apikey):
+* Api Key Authentication (X-Api-Key):
+
 ```python
-from __future__ import print_function
-import time
-import os
 import readarr
+from readarr.models.api_info_resource import ApiInfoResource
 from readarr.rest import ApiException
 from pprint import pprint
+
 # Defining the host is optional and defaults to http://localhost:8787
 # See configuration.py for a list of all supported configuration parameters.
 configuration = readarr.Configuration(
@@ -58,51 +59,10 @@ with readarr.ApiClient(configuration) as api_client:
         print("Exception when calling ApiInfoApi->get_api: %s\n" % e)
 ```
 
-* Api Key Authentication (X-Api-Key):
-```python
-from __future__ import print_function
-import time
-import os
-import readarr
-from readarr.rest import ApiException
-from pprint import pprint
-# Defining the host is optional and defaults to http://localhost:8787
-# See configuration.py for a list of all supported configuration parameters.
-configuration = readarr.Configuration(
-    host = "http://localhost:8787"
-)
-
-# 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: apikey
-configuration.api_key['apikey'] = os.environ["API_KEY"]
-
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['apikey'] = 'Bearer'
-
-# Configure API key authorization: X-Api-Key
-configuration.api_key['X-Api-Key'] = os.environ["API_KEY"]
-
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
-
-# Enter a context with an instance of the API client
-with readarr.ApiClient(configuration) as api_client:
-    # Create an instance of the API class
-    api_instance = readarr.ApiInfoApi(api_client)
 
-    try:
-        api_response = api_instance.get_api()
-        print("The response of ApiInfoApi->get_api:\n")
-        pprint(api_response)
-    except Exception as e:
-        print("Exception when calling ApiInfoApi->get_api: %s\n" % e)
-```
 
 ### Parameters
+
 This endpoint does not need any parameter.
 
 ### Return type
@@ -119,9 +79,10 @@ This endpoint does not need any parameter.
  - **Accept**: application/json
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-**200** | Success |  -  |
+**2XX** | Success |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
diff --git a/docs/ApiInfoResource.md b/docs/ApiInfoResource.md
@@ -2,6 +2,7 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **current** | **str** |  | [optional] 

diff --git a/docs/ApplyTags.md b/docs/ApplyTags.md
@@ -2,6 +2,7 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 

diff --git a/docs/AuthenticationApi.md b/docs/AuthenticationApi.md
@@ -16,13 +16,13 @@ Method | HTTP request | Description
 ### Example
 
 * Api Key Authentication (apikey):
+* Api Key Authentication (X-Api-Key):
+
 ```python
-from __future__ import print_function
-import time
-import os
 import readarr
 from readarr.rest import ApiException
 from pprint import pprint
+
 # Defining the host is optional and defaults to http://localhost:8787
 # See configuration.py for a list of all supported configuration parameters.
 configuration = readarr.Configuration(
@@ -61,54 +61,11 @@ with readarr.ApiClient(configuration) as api_client:
         print("Exception when calling AuthenticationApi->create_login: %s\n" % e)
 ```
 
-* Api Key Authentication (X-Api-Key):
-```python
-from __future__ import print_function
-import time
-import os
-import readarr
-from readarr.rest import ApiException
-from pprint import pprint
-# Defining the host is optional and defaults to http://localhost:8787
-# See configuration.py for a list of all supported configuration parameters.
-configuration = readarr.Configuration(
-    host = "http://localhost:8787"
-)
-
-# 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: apikey
-configuration.api_key['apikey'] = os.environ["API_KEY"]
-
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['apikey'] = 'Bearer'
-
-# Configure API key authorization: X-Api-Key
-configuration.api_key['X-Api-Key'] = os.environ["API_KEY"]
-
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
-
-# Enter a context with an instance of the API client
-with readarr.ApiClient(configuration) as api_client:
-    # Create an instance of the API class
-    api_instance = readarr.AuthenticationApi(api_client)
-    return_url = 'return_url_example' # str |  (optional)
-    username = 'username_example' # str |  (optional)
-    password = 'password_example' # str |  (optional)
-    remember_me = 'remember_me_example' # str |  (optional)
 
-    try:
-        api_instance.create_login(return_url=return_url, username=username, password=password, remember_me=remember_me)
-    except Exception as e:
-        print("Exception when calling AuthenticationApi->create_login: %s\n" % e)
-```
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **return_url** | **str**|  | [optional] 
@@ -130,9 +87,10 @@ void (empty response body)
  - **Accept**: Not defined
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-**200** | Success |  -  |
+**2XX** | Success |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
@@ -144,13 +102,13 @@ void (empty response body)
 ### Example
 
 * Api Key Authentication (apikey):
+* Api Key Authentication (X-Api-Key):
+
 ```python
-from __future__ import print_function
-import time
-import os
 import readarr
 from readarr.rest import ApiException
 from pprint import pprint
+
 # Defining the host is optional and defaults to http://localhost:8787
 # See configuration.py for a list of all supported configuration parameters.
 configuration = readarr.Configuration(
@@ -185,49 +143,10 @@ with readarr.ApiClient(configuration) as api_client:
         print("Exception when calling AuthenticationApi->get_logout: %s\n" % e)
 ```
 
-* Api Key Authentication (X-Api-Key):
-```python
-from __future__ import print_function
-import time
-import os
-import readarr
-from readarr.rest import ApiException
-from pprint import pprint
-# Defining the host is optional and defaults to http://localhost:8787
-# See configuration.py for a list of all supported configuration parameters.
-configuration = readarr.Configuration(
-    host = "http://localhost:8787"
-)
-
-# 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: apikey
-configuration.api_key['apikey'] = os.environ["API_KEY"]
-
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['apikey'] = 'Bearer'
-
-# Configure API key authorization: X-Api-Key
-configuration.api_key['X-Api-Key'] = os.environ["API_KEY"]
-
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
-
-# Enter a context with an instance of the API client
-with readarr.ApiClient(configuration) as api_client:
-    # Create an instance of the API class
-    api_instance = readarr.AuthenticationApi(api_client)
 
-    try:
-        api_instance.get_logout()
-    except Exception as e:
-        print("Exception when calling AuthenticationApi->get_logout: %s\n" % e)
-```
 
 ### Parameters
+
 This endpoint does not need any parameter.
 
 ### Return type
@@ -244,9 +163,10 @@ void (empty response body)
  - **Accept**: Not defined
 
 ### HTTP response details
+
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-**200** | Success |  -  |
+**2XX** | Success |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
diff --git a/docs/AuthenticationType.md b/docs/AuthenticationType.md
@@ -2,6 +2,7 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 

diff --git a/docs/Author.md b/docs/Author.md
@@ -2,6 +2,7 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **int** |  | [optional]
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,6 +2,7 @@


		## Properties

		Name \| Type \| Description \| Notes
		------------ \| ------------- \| ------------- \| -------------

Expand Down