KevinMidboe/immich
1
0
Fork 0
mirror of https://github.com/KevinMidboe/immich.git synced 2025-10-29 17:40:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(server): update openapi

Browse Source
This commit is contained in:
Alex Tran
2023-07-06 16:56:02 -05:00
parent 3cc77d945b
commit 852ef3cd1b
13 changed files with 43 additions and 94 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
cli/src/api/open-api/api.ts
View File

@@ -4,7 +4,7 @@
* Immich
* Immich API
*
* The version of the OpenAPI document: 1.65.0
* The version of the OpenAPI document: 1.66.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1772,11 +1772,17 @@ export interface PersonResponseDto {
*/
export interface PersonUpdateDto {
/**
*
* Person name.
* @type {string}
* @memberof PersonUpdateDto
*/
'name': string;
'name'?: string;
/**
* Asset is used to get the feature face thumbnail.
* @type {string}
* @memberof PersonUpdateDto
*/
'featureFaceAssetId'?: string;
}
/**
*
@@ -5889,7 +5895,7 @@ export const AssetApiFp = function(configuration?: Configuration) {
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getAssetThumbnail(id: string, format?: ThumbnailFormat, key?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
async getAssetThumbnail(id: string, format?: ThumbnailFormat, key?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getAssetThumbnail(id, format, key, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
@@ -5986,7 +5992,7 @@ export const AssetApiFp = function(configuration?: Configuration) {
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async serveFile(id: string, isThumb?: boolean, isWeb?: boolean, key?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
async serveFile(id: string, isThumb?: boolean, isWeb?: boolean, key?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.serveFile(id, isThumb, isWeb, key, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
@@ -6155,7 +6161,7 @@ export const AssetApiFactory = function (configuration?: Configuration, basePath
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAssetThumbnail(requestParameters: AssetApiGetAssetThumbnailRequest, options?: AxiosRequestConfig): AxiosPromise<File> {
getAssetThumbnail(requestParameters: AssetApiGetAssetThumbnailRequest, options?: AxiosRequestConfig): AxiosPromise<void> {
return localVarFp.getAssetThumbnail(requestParameters.id, requestParameters.format, requestParameters.key, options).then((request) => request(axios, basePath));
},
/**
@@ -6234,7 +6240,7 @@ export const AssetApiFactory = function (configuration?: Configuration, basePath
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
serveFile(requestParameters: AssetApiServeFileRequest, options?: AxiosRequestConfig): AxiosPromise<File> {
serveFile(requestParameters: AssetApiServeFileRequest, options?: AxiosRequestConfig): AxiosPromise<void> {
return localVarFp.serveFile(requestParameters.id, requestParameters.isThumb, requestParameters.isWeb, requestParameters.key, options).then((request) => request(axios, basePath));
},
/**
@@ -8862,7 +8868,7 @@ export const PersonApiFp = function(configuration?: Configuration) {
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getPersonThumbnail(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
async getPersonThumbnail(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getPersonThumbnail(id, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
@@ -8919,7 +8925,7 @@ export const PersonApiFactory = function (configuration?: Configuration, basePat
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPersonThumbnail(requestParameters: PersonApiGetPersonThumbnailRequest, options?: AxiosRequestConfig): AxiosPromise<File> {
getPersonThumbnail(requestParameters: PersonApiGetPersonThumbnailRequest, options?: AxiosRequestConfig): AxiosPromise<void> {
return localVarFp.getPersonThumbnail(requestParameters.id, options).then((request) => request(axios, basePath));
},
/**

2
cli/src/api/open-api/base.ts
View File

@@ -4,7 +4,7 @@
* Immich
* Immich API
*
* The version of the OpenAPI document: 1.65.0
* The version of the OpenAPI document: 1.66.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

2
cli/src/api/open-api/common.ts
View File

@@ -4,7 +4,7 @@
* Immich
* Immich API
*
* The version of the OpenAPI document: 1.65.0
* The version of the OpenAPI document: 1.66.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

2
cli/src/api/open-api/configuration.ts
View File

@@ -4,7 +4,7 @@
* Immich
* Immich API
*
* The version of the OpenAPI document: 1.65.0
* The version of the OpenAPI document: 1.66.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

2
cli/src/api/open-api/index.ts
View File

@@ -4,7 +4,7 @@
* Immich
* Immich API
*
* The version of the OpenAPI document: 1.65.0
* The version of the OpenAPI document: 1.66.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

18
mobile/openapi/doc/AssetApi.md generated
View File

@@ -768,7 +768,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)
# **getAssetThumbnail**
> MultipartFile getAssetThumbnail(id, format, key)
> getAssetThumbnail(id, format, key)
@@ -796,8 +796,7 @@ final format = ; // ThumbnailFormat |
final key = key_example; // String |
try {
final result = api_instance.getAssetThumbnail(id, format, key);
print(result);
api_instance.getAssetThumbnail(id, format, key);
} catch (e) {
print('Exception when calling AssetApi->getAssetThumbnail: $e\n');
}
@@ -813,7 +812,7 @@ Name | Type | Description | Notes
### Return type
[**MultipartFile**](MultipartFile.md)
void (empty response body)
### Authorization
@@ -822,7 +821,7 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: image/jpeg, image/webp
- **Accept**: Not defined
[[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)
@@ -1273,7 +1272,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)
# **serveFile**
> MultipartFile serveFile(id, isThumb, isWeb, key)
> serveFile(id, isThumb, isWeb, key)
@@ -1302,8 +1301,7 @@ final isWeb = true; // bool |
final key = key_example; // String |
try {
final result = api_instance.serveFile(id, isThumb, isWeb, key);
print(result);
api_instance.serveFile(id, isThumb, isWeb, key);
} catch (e) {
print('Exception when calling AssetApi->serveFile: $e\n');
}
@@ -1320,7 +1318,7 @@ Name | Type | Description | Notes
### Return type
[**MultipartFile**](MultipartFile.md)
void (empty response body)
### Authorization
@@ -1329,7 +1327,7 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/octet-stream
- **Accept**: Not defined
[[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)

9
mobile/openapi/doc/PersonApi.md generated
View File

@@ -178,7 +178,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)
# **getPersonThumbnail**
> MultipartFile getPersonThumbnail(id)
> getPersonThumbnail(id)
@@ -204,8 +204,7 @@ final api_instance = PersonApi();
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
try {
final result = api_instance.getPersonThumbnail(id);
print(result);
api_instance.getPersonThumbnail(id);
} catch (e) {
print('Exception when calling PersonApi->getPersonThumbnail: $e\n');
}
@@ -219,7 +218,7 @@ Name | Type | Description | Notes
### Return type
[**MultipartFile**](MultipartFile.md)
void (empty response body)
### Authorization
@@ -228,7 +227,7 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: image/jpeg
- **Accept**: Not defined
[[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)

20
mobile/openapi/lib/api/asset_api.dart generated
View File

@@ -772,19 +772,11 @@ class AssetApi {
/// * [ThumbnailFormat] format:
///
/// * [String] key:
Future<MultipartFile?> getAssetThumbnail(String id, { ThumbnailFormat? format, String? key, }) async {
Future<void> getAssetThumbnail(String id, { ThumbnailFormat? format, String? key, }) async {
final response = await getAssetThumbnailWithHttpInfo(id, format: format, key: key, );
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'MultipartFile',) as MultipartFile;
}
return null;
}
/// Performs an HTTP 'GET /asset/curated-locations' operation and returns the [Response].
@@ -1284,19 +1276,11 @@ class AssetApi {
/// * [bool] isWeb:
///
/// * [String] key:
Future<MultipartFile?> serveFile(String id, { bool? isThumb, bool? isWeb, String? key, }) async {
Future<void> serveFile(String id, { bool? isThumb, bool? isWeb, String? key, }) async {
final response = await serveFileWithHttpInfo(id, isThumb: isThumb, isWeb: isWeb, key: key, );
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'MultipartFile',) as MultipartFile;
}
return null;
}
/// Update an asset

10
mobile/openapi/lib/api/person_api.dart generated
View File

@@ -192,19 +192,11 @@ class PersonApi {
/// Parameters:
///
/// * [String] id (required):
Future<MultipartFile?> getPersonThumbnail(String id,) async {
Future<void> getPersonThumbnail(String id,) async {
final response = await getPersonThumbnailWithHttpInfo(id,);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'MultipartFile',) as MultipartFile;
}
return null;
}
/// Performs an HTTP 'PUT /person/{id}' operation and returns the [Response].

4
mobile/openapi/test/asset_api_test.dart generated
View File

@@ -92,7 +92,7 @@ void main() {
// TODO
});
//Future<MultipartFile> getAssetThumbnail(String id, { ThumbnailFormat format, String key }) async
//Future getAssetThumbnail(String id, { ThumbnailFormat format, String key }) async
test('test getAssetThumbnail', () async {
// TODO
});
@@ -139,7 +139,7 @@ void main() {
// TODO
});
//Future<MultipartFile> serveFile(String id, { bool isThumb, bool isWeb, String key }) async
//Future serveFile(String id, { bool isThumb, bool isWeb, String key }) async
test('test serveFile', () async {
// TODO
});

2
mobile/openapi/test/person_api_test.dart generated
View File

@@ -32,7 +32,7 @@ void main() {
// TODO
});
//Future<MultipartFile> getPersonThumbnail(String id) async
//Future getPersonThumbnail(String id) async
test('test getPersonThumbnail', () async {
// TODO
});

30
server/immich-openapi-specs.json
View File

@@ -1351,14 +1351,6 @@
],
"responses": {
"200": {
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
},
"description": ""
}
},
@@ -1672,20 +1664,6 @@
],
"responses": {
"200": {
"content": {
"image/jpeg": {
"schema": {
"type": "string",
"format": "binary"
}
},
"image/webp": {
"schema": {
"type": "string",
"format": "binary"
}
}
},
"description": ""
}
},
@@ -2709,14 +2687,6 @@
],
"responses": {
"200": {
"content": {
"image/jpeg": {
"schema": {
"type": "string",
"format": "binary"
}
}
},
"description": ""
}
},

12
web/src/api/open-api/api.ts generated
View File

@@ -5904,7 +5904,7 @@ export const AssetApiFp = function(configuration?: Configuration) {
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getAssetThumbnail(id: string, format?: ThumbnailFormat, key?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
async getAssetThumbnail(id: string, format?: ThumbnailFormat, key?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getAssetThumbnail(id, format, key, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
@@ -6001,7 +6001,7 @@ export const AssetApiFp = function(configuration?: Configuration) {
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async serveFile(id: string, isThumb?: boolean, isWeb?: boolean, key?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
async serveFile(id: string, isThumb?: boolean, isWeb?: boolean, key?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.serveFile(id, isThumb, isWeb, key, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
@@ -6181,7 +6181,7 @@ export const AssetApiFactory = function (configuration?: Configuration, basePath
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAssetThumbnail(id: string, format?: ThumbnailFormat, key?: string, options?: any): AxiosPromise<File> {
getAssetThumbnail(id: string, format?: ThumbnailFormat, key?: string, options?: any): AxiosPromise<void> {
return localVarFp.getAssetThumbnail(id, format, key, options).then((request) => request(axios, basePath));
},
/**
@@ -6269,7 +6269,7 @@ export const AssetApiFactory = function (configuration?: Configuration, basePath
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
serveFile(id: string, isThumb?: boolean, isWeb?: boolean, key?: string, options?: any): AxiosPromise<File> {
serveFile(id: string, isThumb?: boolean, isWeb?: boolean, key?: string, options?: any): AxiosPromise<void> {
return localVarFp.serveFile(id, isThumb, isWeb, key, options).then((request) => request(axios, basePath));
},
/**
@@ -8913,7 +8913,7 @@ export const PersonApiFp = function(configuration?: Configuration) {
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getPersonThumbnail(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
async getPersonThumbnail(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getPersonThumbnail(id, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
@@ -8970,7 +8970,7 @@ export const PersonApiFactory = function (configuration?: Configuration, basePat
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPersonThumbnail(id: string, options?: any): AxiosPromise<File> {
getPersonThumbnail(id: string, options?: any): AxiosPromise<void> {
return localVarFp.getPersonThumbnail(id, options).then((request) => request(axios, basePath));
},
/**