Skip to content

Commit

Permalink
feat: update readarr swagger location
Browse files Browse the repository at this point in the history
  • Loading branch information
devopsarr[bot] committed Jul 17, 2023
1 parent 4c0c570 commit c65593f
Show file tree
Hide file tree
Showing 109 changed files with 2,534 additions and 1,892 deletions.
6 changes: 6 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ docs/DevelopmentConfigResource.md
docs/DiskSpaceApi.md
docs/DiskSpaceResource.md
docs/DownloadClientApi.md
docs/DownloadClientBulkResource.md
docs/DownloadClientConfigApi.md
docs/DownloadClientConfigResource.md
docs/DownloadClientResource.md
Expand All @@ -95,12 +96,14 @@ docs/HostConfigApi.md
docs/HostConfigResource.md
docs/ICustomFormatSpecification.md
docs/ImportListApi.md
docs/ImportListBulkResource.md
docs/ImportListExclusionApi.md
docs/ImportListExclusionResource.md
docs/ImportListMonitorType.md
docs/ImportListResource.md
docs/ImportListType.md
docs/IndexerApi.md
docs/IndexerBulkResource.md
docs/IndexerConfigApi.md
docs/IndexerConfigResource.md
docs/IndexerResource.md
Expand Down Expand Up @@ -356,6 +359,7 @@ readarr/models/database_type.py
readarr/models/delay_profile_resource.py
readarr/models/development_config_resource.py
readarr/models/disk_space_resource.py
readarr/models/download_client_bulk_resource.py
readarr/models/download_client_config_resource.py
readarr/models/download_client_resource.py
readarr/models/download_protocol.py
Expand All @@ -372,10 +376,12 @@ readarr/models/history_resource.py
readarr/models/history_resource_paging_resource.py
readarr/models/host_config_resource.py
readarr/models/i_custom_format_specification.py
readarr/models/import_list_bulk_resource.py
readarr/models/import_list_exclusion_resource.py
readarr/models/import_list_monitor_type.py
readarr/models/import_list_resource.py
readarr/models/import_list_type.py
readarr/models/indexer_bulk_resource.py
readarr/models/indexer_config_resource.py
readarr/models/indexer_resource.py
readarr/models/iso_country.py
Expand Down
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,9 +168,11 @@ Class | Method | HTTP request | Description
*DownloadClientApi* | [**create_download_client**](docs/DownloadClientApi.md#create_download_client) | **POST** /api/v1/downloadclient |
*DownloadClientApi* | [**create_download_client_action_by_name**](docs/DownloadClientApi.md#create_download_client_action_by_name) | **POST** /api/v1/downloadclient/action/{name} |
*DownloadClientApi* | [**delete_download_client**](docs/DownloadClientApi.md#delete_download_client) | **DELETE** /api/v1/downloadclient/{id} |
*DownloadClientApi* | [**delete_download_client_bulk**](docs/DownloadClientApi.md#delete_download_client_bulk) | **DELETE** /api/v1/downloadclient/bulk |
*DownloadClientApi* | [**get_download_client_by_id**](docs/DownloadClientApi.md#get_download_client_by_id) | **GET** /api/v1/downloadclient/{id} |
*DownloadClientApi* | [**list_download_client**](docs/DownloadClientApi.md#list_download_client) | **GET** /api/v1/downloadclient |
*DownloadClientApi* | [**list_download_client_schema**](docs/DownloadClientApi.md#list_download_client_schema) | **GET** /api/v1/downloadclient/schema |
*DownloadClientApi* | [**put_download_client_bulk**](docs/DownloadClientApi.md#put_download_client_bulk) | **PUT** /api/v1/downloadclient/bulk |
*DownloadClientApi* | [**test_download_client**](docs/DownloadClientApi.md#test_download_client) | **POST** /api/v1/downloadclient/test |
*DownloadClientApi* | [**testall_download_client**](docs/DownloadClientApi.md#testall_download_client) | **POST** /api/v1/downloadclient/testall |
*DownloadClientApi* | [**update_download_client**](docs/DownloadClientApi.md#update_download_client) | **PUT** /api/v1/downloadclient/{id} |
Expand All @@ -181,7 +183,6 @@ Class | Method | HTTP request | Description
*FileSystemApi* | [**get_file_system**](docs/FileSystemApi.md#get_file_system) | **GET** /api/v1/filesystem |
*FileSystemApi* | [**get_file_system_mediafiles**](docs/FileSystemApi.md#get_file_system_mediafiles) | **GET** /api/v1/filesystem/mediafiles |
*FileSystemApi* | [**get_file_system_type**](docs/FileSystemApi.md#get_file_system_type) | **GET** /api/v1/filesystem/type |
*HealthApi* | [**get_health_by_id**](docs/HealthApi.md#get_health_by_id) | **GET** /api/v1/health/{id} |
*HealthApi* | [**list_health**](docs/HealthApi.md#list_health) | **GET** /api/v1/health |
*HistoryApi* | [**create_history_failed_by_id**](docs/HistoryApi.md#create_history_failed_by_id) | **POST** /api/v1/history/failed/{id} |
*HistoryApi* | [**get_history**](docs/HistoryApi.md#get_history) | **GET** /api/v1/history |
Expand All @@ -193,9 +194,11 @@ Class | Method | HTTP request | Description
*ImportListApi* | [**create_import_list**](docs/ImportListApi.md#create_import_list) | **POST** /api/v1/importlist |
*ImportListApi* | [**create_import_list_action_by_name**](docs/ImportListApi.md#create_import_list_action_by_name) | **POST** /api/v1/importlist/action/{name} |
*ImportListApi* | [**delete_import_list**](docs/ImportListApi.md#delete_import_list) | **DELETE** /api/v1/importlist/{id} |
*ImportListApi* | [**delete_import_list_bulk**](docs/ImportListApi.md#delete_import_list_bulk) | **DELETE** /api/v1/importlist/bulk |
*ImportListApi* | [**get_import_list_by_id**](docs/ImportListApi.md#get_import_list_by_id) | **GET** /api/v1/importlist/{id} |
*ImportListApi* | [**list_import_list**](docs/ImportListApi.md#list_import_list) | **GET** /api/v1/importlist |
*ImportListApi* | [**list_import_list_schema**](docs/ImportListApi.md#list_import_list_schema) | **GET** /api/v1/importlist/schema |
*ImportListApi* | [**put_import_list_bulk**](docs/ImportListApi.md#put_import_list_bulk) | **PUT** /api/v1/importlist/bulk |
*ImportListApi* | [**test_import_list**](docs/ImportListApi.md#test_import_list) | **POST** /api/v1/importlist/test |
*ImportListApi* | [**testall_import_list**](docs/ImportListApi.md#testall_import_list) | **POST** /api/v1/importlist/testall |
*ImportListApi* | [**update_import_list**](docs/ImportListApi.md#update_import_list) | **PUT** /api/v1/importlist/{id} |
Expand All @@ -207,9 +210,11 @@ Class | Method | HTTP request | Description
*IndexerApi* | [**create_indexer**](docs/IndexerApi.md#create_indexer) | **POST** /api/v1/indexer |
*IndexerApi* | [**create_indexer_action_by_name**](docs/IndexerApi.md#create_indexer_action_by_name) | **POST** /api/v1/indexer/action/{name} |
*IndexerApi* | [**delete_indexer**](docs/IndexerApi.md#delete_indexer) | **DELETE** /api/v1/indexer/{id} |
*IndexerApi* | [**delete_indexer_bulk**](docs/IndexerApi.md#delete_indexer_bulk) | **DELETE** /api/v1/indexer/bulk |
*IndexerApi* | [**get_indexer_by_id**](docs/IndexerApi.md#get_indexer_by_id) | **GET** /api/v1/indexer/{id} |
*IndexerApi* | [**list_indexer**](docs/IndexerApi.md#list_indexer) | **GET** /api/v1/indexer |
*IndexerApi* | [**list_indexer_schema**](docs/IndexerApi.md#list_indexer_schema) | **GET** /api/v1/indexer/schema |
*IndexerApi* | [**put_indexer_bulk**](docs/IndexerApi.md#put_indexer_bulk) | **PUT** /api/v1/indexer/bulk |
*IndexerApi* | [**test_indexer**](docs/IndexerApi.md#test_indexer) | **POST** /api/v1/indexer/test |
*IndexerApi* | [**testall_indexer**](docs/IndexerApi.md#testall_indexer) | **POST** /api/v1/indexer/testall |
*IndexerApi* | [**update_indexer**](docs/IndexerApi.md#update_indexer) | **PUT** /api/v1/indexer/{id} |
Expand Down Expand Up @@ -278,23 +283,18 @@ Class | Method | HTTP request | Description
*QueueApi* | [**delete_queue**](docs/QueueApi.md#delete_queue) | **DELETE** /api/v1/queue/{id} |
*QueueApi* | [**delete_queue_bulk**](docs/QueueApi.md#delete_queue_bulk) | **DELETE** /api/v1/queue/bulk |
*QueueApi* | [**get_queue**](docs/QueueApi.md#get_queue) | **GET** /api/v1/queue |
*QueueApi* | [**get_queue_by_id**](docs/QueueApi.md#get_queue_by_id) | **GET** /api/v1/queue/{id} |
*QueueActionApi* | [**create_queue_grab_bulk**](docs/QueueActionApi.md#create_queue_grab_bulk) | **POST** /api/v1/queue/grab/bulk |
*QueueActionApi* | [**create_queue_grab_by_id**](docs/QueueActionApi.md#create_queue_grab_by_id) | **POST** /api/v1/queue/grab/{id} |
*QueueDetailsApi* | [**get_queue_details_by_id**](docs/QueueDetailsApi.md#get_queue_details_by_id) | **GET** /api/v1/queue/details/{id} |
*QueueDetailsApi* | [**list_queue_details**](docs/QueueDetailsApi.md#list_queue_details) | **GET** /api/v1/queue/details |
*QueueStatusApi* | [**get_queue_status**](docs/QueueStatusApi.md#get_queue_status) | **GET** /api/v1/queue/status |
*QueueStatusApi* | [**get_queue_status_by_id**](docs/QueueStatusApi.md#get_queue_status_by_id) | **GET** /api/v1/queue/status/{id} |
*ReleaseApi* | [**create_release**](docs/ReleaseApi.md#create_release) | **POST** /api/v1/release |
*ReleaseApi* | [**get_release_by_id**](docs/ReleaseApi.md#get_release_by_id) | **GET** /api/v1/release/{id} |
*ReleaseApi* | [**list_release**](docs/ReleaseApi.md#list_release) | **GET** /api/v1/release |
*ReleaseProfileApi* | [**create_release_profile**](docs/ReleaseProfileApi.md#create_release_profile) | **POST** /api/v1/releaseprofile |
*ReleaseProfileApi* | [**delete_release_profile**](docs/ReleaseProfileApi.md#delete_release_profile) | **DELETE** /api/v1/releaseprofile/{id} |
*ReleaseProfileApi* | [**get_release_profile_by_id**](docs/ReleaseProfileApi.md#get_release_profile_by_id) | **GET** /api/v1/releaseprofile/{id} |
*ReleaseProfileApi* | [**list_release_profile**](docs/ReleaseProfileApi.md#list_release_profile) | **GET** /api/v1/releaseprofile |
*ReleaseProfileApi* | [**update_release_profile**](docs/ReleaseProfileApi.md#update_release_profile) | **PUT** /api/v1/releaseprofile/{id} |
*ReleasePushApi* | [**create_release_push**](docs/ReleasePushApi.md#create_release_push) | **POST** /api/v1/release/push |
*ReleasePushApi* | [**get_release_push_by_id**](docs/ReleasePushApi.md#get_release_push_by_id) | **GET** /api/v1/release/push/{id} |
*RemotePathMappingApi* | [**create_remote_path_mapping**](docs/RemotePathMappingApi.md#create_remote_path_mapping) | **POST** /api/v1/remotepathmapping |
*RemotePathMappingApi* | [**delete_remote_path_mapping**](docs/RemotePathMappingApi.md#delete_remote_path_mapping) | **DELETE** /api/v1/remotepathmapping/{id} |
*RemotePathMappingApi* | [**get_remote_path_mapping_by_id**](docs/RemotePathMappingApi.md#get_remote_path_mapping_by_id) | **GET** /api/v1/remotepathmapping/{id} |
Expand Down Expand Up @@ -386,6 +386,7 @@ Class | Method | HTTP request | Description
- [DelayProfileResource](docs/DelayProfileResource.md)
- [DevelopmentConfigResource](docs/DevelopmentConfigResource.md)
- [DiskSpaceResource](docs/DiskSpaceResource.md)
- [DownloadClientBulkResource](docs/DownloadClientBulkResource.md)
- [DownloadClientConfigResource](docs/DownloadClientConfigResource.md)
- [DownloadClientResource](docs/DownloadClientResource.md)
- [DownloadProtocol](docs/DownloadProtocol.md)
Expand All @@ -402,10 +403,12 @@ Class | Method | HTTP request | Description
- [HistoryResourcePagingResource](docs/HistoryResourcePagingResource.md)
- [HostConfigResource](docs/HostConfigResource.md)
- [ICustomFormatSpecification](docs/ICustomFormatSpecification.md)
- [ImportListBulkResource](docs/ImportListBulkResource.md)
- [ImportListExclusionResource](docs/ImportListExclusionResource.md)
- [ImportListMonitorType](docs/ImportListMonitorType.md)
- [ImportListResource](docs/ImportListResource.md)
- [ImportListType](docs/ImportListType.md)
- [IndexerBulkResource](docs/IndexerBulkResource.md)
- [IndexerConfigResource](docs/IndexerConfigResource.md)
- [IndexerResource](docs/IndexerResource.md)
- [IsoCountry](docs/IsoCountry.md)
Expand Down
23 changes: 16 additions & 7 deletions docs/AuthorApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ Name | Type | Description | Notes
[[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)

# **delete_author**
> delete_author(id)
> delete_author(id, delete_files=delete_files, add_import_list_exclusion=add_import_list_exclusion)


Expand Down Expand Up @@ -177,9 +177,11 @@ with readarr.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = readarr.AuthorApi(api_client)
id = 56 # int |
delete_files = False # bool | (optional) (default to False)
add_import_list_exclusion = False # bool | (optional) (default to False)

try:
api_instance.delete_author(id)
api_instance.delete_author(id, delete_files=delete_files, add_import_list_exclusion=add_import_list_exclusion)
except Exception as e:
print("Exception when calling AuthorApi->delete_author: %s\n" % e)
```
Expand Down Expand Up @@ -220,9 +222,11 @@ with readarr.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = readarr.AuthorApi(api_client)
id = 56 # int |
delete_files = False # bool | (optional) (default to False)
add_import_list_exclusion = False # bool | (optional) (default to False)

try:
api_instance.delete_author(id)
api_instance.delete_author(id, delete_files=delete_files, add_import_list_exclusion=add_import_list_exclusion)
except Exception as e:
print("Exception when calling AuthorApi->delete_author: %s\n" % e)
```
Expand All @@ -232,6 +236,8 @@ with readarr.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| |
**delete_files** | **bool**| | [optional] [default to False]
**add_import_list_exclusion** | **bool**| | [optional] [default to False]

### Return type

Expand Down Expand Up @@ -367,7 +373,7 @@ Name | Type | Description | Notes
### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain, application/json, text/json
- **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
Expand Down Expand Up @@ -495,7 +501,7 @@ This endpoint does not need any parameter.
[[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)

# **update_author**
> AuthorResource update_author(id, author_resource=author_resource)
> AuthorResource update_author(id, move_files=move_files, author_resource=author_resource)


Expand Down Expand Up @@ -537,10 +543,11 @@ with readarr.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = readarr.AuthorApi(api_client)
id = 'id_example' # str |
move_files = False # bool | (optional) (default to False)
author_resource = readarr.AuthorResource() # AuthorResource | (optional)

try:
api_response = api_instance.update_author(id, author_resource=author_resource)
api_response = api_instance.update_author(id, move_files=move_files, author_resource=author_resource)
print("The response of AuthorApi->update_author:\n")
pprint(api_response)
except Exception as e:
Expand Down Expand Up @@ -583,10 +590,11 @@ with readarr.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = readarr.AuthorApi(api_client)
id = 'id_example' # str |
move_files = False # bool | (optional) (default to False)
author_resource = readarr.AuthorResource() # AuthorResource | (optional)

try:
api_response = api_instance.update_author(id, author_resource=author_resource)
api_response = api_instance.update_author(id, move_files=move_files, author_resource=author_resource)
print("The response of AuthorApi->update_author:\n")
pprint(api_response)
except Exception as e:
Expand All @@ -598,6 +606,7 @@ with readarr.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| |
**move_files** | **bool**| | [optional] [default to False]
**author_resource** | [**AuthorResource**](AuthorResource.md)| | [optional]

### Return type
Expand Down
14 changes: 10 additions & 4 deletions docs/BookApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ Name | Type | Description | Notes
[[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)

# **delete_book**
> delete_book(id)
> delete_book(id, delete_files=delete_files, add_import_list_exclusion=add_import_list_exclusion)


Expand Down Expand Up @@ -179,9 +179,11 @@ with readarr.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = readarr.BookApi(api_client)
id = 56 # int |
delete_files = False # bool | (optional) (default to False)
add_import_list_exclusion = False # bool | (optional) (default to False)

try:
api_instance.delete_book(id)
api_instance.delete_book(id, delete_files=delete_files, add_import_list_exclusion=add_import_list_exclusion)
except Exception as e:
print("Exception when calling BookApi->delete_book: %s\n" % e)
```
Expand Down Expand Up @@ -222,9 +224,11 @@ with readarr.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = readarr.BookApi(api_client)
id = 56 # int |
delete_files = False # bool | (optional) (default to False)
add_import_list_exclusion = False # bool | (optional) (default to False)

try:
api_instance.delete_book(id)
api_instance.delete_book(id, delete_files=delete_files, add_import_list_exclusion=add_import_list_exclusion)
except Exception as e:
print("Exception when calling BookApi->delete_book: %s\n" % e)
```
Expand All @@ -234,6 +238,8 @@ with readarr.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| |
**delete_files** | **bool**| | [optional] [default to False]
**add_import_list_exclusion** | **bool**| | [optional] [default to False]

### Return type

Expand Down Expand Up @@ -369,7 +375,7 @@ Name | Type | Description | Notes
### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain, application/json, text/json
- **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
Expand Down
2 changes: 1 addition & 1 deletion docs/BookFileApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ Name | Type | Description | Notes
### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain, application/json, text/json
- **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
Expand Down
2 changes: 1 addition & 1 deletion docs/CalendarApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ Name | Type | Description | Notes
### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain, application/json, text/json
- **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
Expand Down
2 changes: 1 addition & 1 deletion docs/CommandApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -366,7 +366,7 @@ Name | Type | Description | Notes
### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain, application/json, text/json
- **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
Expand Down
2 changes: 1 addition & 1 deletion docs/CustomFilterApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,7 @@ Name | Type | Description | Notes
### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain, application/json, text/json
- **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
Expand Down
2 changes: 1 addition & 1 deletion docs/CustomFormatApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ Name | Type | Description | Notes
### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain, application/json, text/json
- **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
Expand Down
2 changes: 1 addition & 1 deletion docs/CutoffApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ Name | Type | Description | Notes
### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain, application/json, text/json
- **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
Expand Down
2 changes: 1 addition & 1 deletion docs/DelayProfileApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ Name | Type | Description | Notes
### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain, application/json, text/json
- **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
Expand Down
2 changes: 1 addition & 1 deletion docs/DevelopmentConfigApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ Name | Type | Description | Notes
### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain, application/json, text/json
- **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
Expand Down
Loading

0 comments on commit c65593f

Please sign in to comment.