Merge pull request #53 from devopsarr/feature/code-generation

feat(devopsarr/prowlarr-py/#39)!: update sdk generator to use pydantic 2.x
devopsarr · Feb 12, 2024 · 4d56853 · 4d56853
2 parents 700a06e + bad01c0
commit 4d56853
Show file tree

Hide file tree

Showing 412 changed files with 61,631 additions and 41,135 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 @@ Radarr 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.3.0
-
-[comment]: # (x-release-please-end)
+[comment]: # (x-release-please-start-version)$
 - API version: 3.0.0
-
+- Package version: 0.3.0
 - 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 whisparr
 ```
 
+### 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 whisparr
 from whisparr.rest import ApiException
 from pprint import pprint
@@ -473,17 +473,20 @@ Class | Method | HTTP request | Description
  - [UpdateResource](docs/UpdateResource.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/AddMovieMethod.md b/docs/AddMovieMethod.md
@@ -2,6 +2,7 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 

diff --git a/docs/AddMovieOptions.md b/docs/AddMovieOptions.md
@@ -2,6 +2,7 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **ignore_episodes_with_files** | **bool** |  | [optional] 

diff --git a/docs/AlternativeTitleApi.md b/docs/AlternativeTitleApi.md
@@ -16,13 +16,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 whisparr
+from whisparr.models.alternative_title_resource import AlternativeTitleResource
 from whisparr.rest import ApiException
 from pprint import pprint
+
 # Defining the host is optional and defaults to http://localhost:7878
 # See configuration.py for a list of all supported configuration parameters.
 configuration = whisparr.Configuration(
@@ -60,53 +61,11 @@ with whisparr.ApiClient(configuration) as api_client:
         print("Exception when calling AlternativeTitleApi->get_alttitle_by_id: %s\n" % e)
 ```
 
-* Api Key Authentication (X-Api-Key):
-```python
-from __future__ import print_function
-import time
-import os
-import whisparr
-from whisparr.rest import ApiException
-from pprint import pprint
-# Defining the host is optional and defaults to http://localhost:7878
-# See configuration.py for a list of all supported configuration parameters.
-configuration = whisparr.Configuration(
-    host = "http://localhost:7878"
-)
-
-# 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 whisparr.ApiClient(configuration) as api_client:
-    # Create an instance of the API class
-    api_instance = whisparr.AlternativeTitleApi(api_client)
-    id = 56 # int | 
-
-    try:
-        api_response = api_instance.get_alttitle_by_id(id)
-        print("The response of AlternativeTitleApi->get_alttitle_by_id:\n")
-        pprint(api_response)
-    except Exception as e:
-        print("Exception when calling AlternativeTitleApi->get_alttitle_by_id: %s\n" % e)
-```
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**|  | 
@@ -125,9 +84,10 @@ Name | Type | Description  | Notes
  - **Accept**: text/plain, application/json, text/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)
 
@@ -139,13 +99,14 @@ Name | Type | Description  | Notes
 ### Example
 
 * Api Key Authentication (apikey):
+* Api Key Authentication (X-Api-Key):
+
 ```python
-from __future__ import print_function
-import time
-import os
 import whisparr
+from whisparr.models.alternative_title_resource import AlternativeTitleResource
 from whisparr.rest import ApiException
 from pprint import pprint
+
 # Defining the host is optional and defaults to http://localhost:7878
 # See configuration.py for a list of all supported configuration parameters.
 configuration = whisparr.Configuration(
@@ -184,54 +145,11 @@ with whisparr.ApiClient(configuration) as api_client:
         print("Exception when calling AlternativeTitleApi->list_alttitle: %s\n" % e)
 ```
 
-* Api Key Authentication (X-Api-Key):
-```python
-from __future__ import print_function
-import time
-import os
-import whisparr
-from whisparr.rest import ApiException
-from pprint import pprint
-# Defining the host is optional and defaults to http://localhost:7878
-# See configuration.py for a list of all supported configuration parameters.
-configuration = whisparr.Configuration(
-    host = "http://localhost:7878"
-)
 
-# 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 whisparr.ApiClient(configuration) as api_client:
-    # Create an instance of the API class
-    api_instance = whisparr.AlternativeTitleApi(api_client)
-    movie_id = 56 # int |  (optional)
-    movie_metadata_id = 56 # int |  (optional)
-
-    try:
-        api_response = api_instance.list_alttitle(movie_id=movie_id, movie_metadata_id=movie_metadata_id)
-        print("The response of AlternativeTitleApi->list_alttitle:\n")
-        pprint(api_response)
-    except Exception as e:
-        print("Exception when calling AlternativeTitleApi->list_alttitle: %s\n" % e)
-```
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **movie_id** | **int**|  | [optional] 
@@ -251,9 +169,10 @@ Name | Type | Description  | Notes
  - **Accept**: text/plain, application/json, text/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/AlternativeTitleResource.md b/docs/AlternativeTitleResource.md
@@ -2,6 +2,7 @@
 
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **int** |  | [optional] 

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 whisparr
+from whisparr.models.api_info_resource import ApiInfoResource
 from whisparr.rest import ApiException
 from pprint import pprint
+
 # Defining the host is optional and defaults to http://localhost:7878
 # See configuration.py for a list of all supported configuration parameters.
 configuration = whisparr.Configuration(
@@ -58,51 +59,10 @@ with whisparr.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 whisparr
-from whisparr.rest import ApiException
-from pprint import pprint
-# Defining the host is optional and defaults to http://localhost:7878
-# See configuration.py for a list of all supported configuration parameters.
-configuration = whisparr.Configuration(
-    host = "http://localhost:7878"
-)
-
-# 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 whisparr.ApiClient(configuration) as api_client:
-    # Create an instance of the API class
-    api_instance = whisparr.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
 ------------ | ------------- | ------------- | -------------
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,6 +2,7 @@


		## Properties

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

Expand Down