瀏覽代碼

chore(server): remove deprecated device endpoints (#1436)

* chore: remove endpoints

* chore: generate open-api
Jason Rasmussen 2 年之前
父節點
當前提交
89aff7764d

+ 0 - 2
mobile/openapi/README.md

@@ -102,8 +102,6 @@ Class | Method | HTTP request | Description
 *AuthenticationApi* | [**login**](doc//AuthenticationApi.md#login) | **POST** /auth/login | 
 *AuthenticationApi* | [**logout**](doc//AuthenticationApi.md#logout) | **POST** /auth/logout | 
 *AuthenticationApi* | [**validateAccessToken**](doc//AuthenticationApi.md#validateaccesstoken) | **POST** /auth/validateToken | 
-*DeviceInfoApi* | [**createDeviceInfo**](doc//DeviceInfoApi.md#createdeviceinfo) | **POST** /device-info | 
-*DeviceInfoApi* | [**updateDeviceInfo**](doc//DeviceInfoApi.md#updatedeviceinfo) | **PATCH** /device-info | 
 *DeviceInfoApi* | [**upsertDeviceInfo**](doc//DeviceInfoApi.md#upsertdeviceinfo) | **PUT** /device-info | 
 *JobApi* | [**getAllJobsStatus**](doc//JobApi.md#getalljobsstatus) | **GET** /jobs | 
 *JobApi* | [**sendJobCommand**](doc//JobApi.md#sendjobcommand) | **PUT** /jobs/{jobId} | 

+ 0 - 100
mobile/openapi/doc/DeviceInfoApi.md

@@ -9,109 +9,9 @@ All URIs are relative to */api*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**createDeviceInfo**](DeviceInfoApi.md#createdeviceinfo) | **POST** /device-info | 
-[**updateDeviceInfo**](DeviceInfoApi.md#updatedeviceinfo) | **PATCH** /device-info | 
 [**upsertDeviceInfo**](DeviceInfoApi.md#upsertdeviceinfo) | **PUT** /device-info | 
 
 
-# **createDeviceInfo**
-> DeviceInfoResponseDto createDeviceInfo(upsertDeviceInfoDto)
-
-
-
-@deprecated
-
-### Example
-```dart
-import 'package:openapi/api.dart';
-// TODO Configure HTTP Bearer authorization: bearer
-// Case 1. Use String Token
-//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
-// Case 2. Use Function which generate token.
-// String yourTokenGeneratorFunction() { ... }
-//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);
-
-final api_instance = DeviceInfoApi();
-final upsertDeviceInfoDto = UpsertDeviceInfoDto(); // UpsertDeviceInfoDto | 
-
-try {
-    final result = api_instance.createDeviceInfo(upsertDeviceInfoDto);
-    print(result);
-} catch (e) {
-    print('Exception when calling DeviceInfoApi->createDeviceInfo: $e\n');
-}
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **upsertDeviceInfoDto** | [**UpsertDeviceInfoDto**](UpsertDeviceInfoDto.md)|  | 
-
-### Return type
-
-[**DeviceInfoResponseDto**](DeviceInfoResponseDto.md)
-
-### Authorization
-
-[bearer](../README.md#bearer)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-[[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)
-
-# **updateDeviceInfo**
-> DeviceInfoResponseDto updateDeviceInfo(upsertDeviceInfoDto)
-
-
-
-@deprecated
-
-### Example
-```dart
-import 'package:openapi/api.dart';
-// TODO Configure HTTP Bearer authorization: bearer
-// Case 1. Use String Token
-//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
-// Case 2. Use Function which generate token.
-// String yourTokenGeneratorFunction() { ... }
-//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);
-
-final api_instance = DeviceInfoApi();
-final upsertDeviceInfoDto = UpsertDeviceInfoDto(); // UpsertDeviceInfoDto | 
-
-try {
-    final result = api_instance.updateDeviceInfo(upsertDeviceInfoDto);
-    print(result);
-} catch (e) {
-    print('Exception when calling DeviceInfoApi->updateDeviceInfo: $e\n');
-}
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **upsertDeviceInfoDto** | [**UpsertDeviceInfoDto**](UpsertDeviceInfoDto.md)|  | 
-
-### Return type
-
-[**DeviceInfoResponseDto**](DeviceInfoResponseDto.md)
-
-### Authorization
-
-[bearer](../README.md#bearer)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-[[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)
-
 # **upsertDeviceInfo**
 > DeviceInfoResponseDto upsertDeviceInfo(upsertDeviceInfoDto)
 

+ 0 - 104
mobile/openapi/lib/api/device_info_api.dart

@@ -16,110 +16,6 @@ class DeviceInfoApi {
 
   final ApiClient apiClient;
 
-  /// @deprecated
-  ///
-  /// Note: This method returns the HTTP [Response].
-  ///
-  /// Parameters:
-  ///
-  /// * [UpsertDeviceInfoDto] upsertDeviceInfoDto (required):
-  Future<Response> createDeviceInfoWithHttpInfo(UpsertDeviceInfoDto upsertDeviceInfoDto,) async {
-    // ignore: prefer_const_declarations
-    final path = r'/device-info';
-
-    // ignore: prefer_final_locals
-    Object? postBody = upsertDeviceInfoDto;
-
-    final queryParams = <QueryParam>[];
-    final headerParams = <String, String>{};
-    final formParams = <String, String>{};
-
-    const contentTypes = <String>['application/json'];
-
-
-    return apiClient.invokeAPI(
-      path,
-      'POST',
-      queryParams,
-      postBody,
-      headerParams,
-      formParams,
-      contentTypes.isEmpty ? null : contentTypes.first,
-    );
-  }
-
-  /// @deprecated
-  ///
-  /// Parameters:
-  ///
-  /// * [UpsertDeviceInfoDto] upsertDeviceInfoDto (required):
-  Future<DeviceInfoResponseDto?> createDeviceInfo(UpsertDeviceInfoDto upsertDeviceInfoDto,) async {
-    final response = await createDeviceInfoWithHttpInfo(upsertDeviceInfoDto,);
-    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), 'DeviceInfoResponseDto',) as DeviceInfoResponseDto;
-    
-    }
-    return null;
-  }
-
-  /// @deprecated
-  ///
-  /// Note: This method returns the HTTP [Response].
-  ///
-  /// Parameters:
-  ///
-  /// * [UpsertDeviceInfoDto] upsertDeviceInfoDto (required):
-  Future<Response> updateDeviceInfoWithHttpInfo(UpsertDeviceInfoDto upsertDeviceInfoDto,) async {
-    // ignore: prefer_const_declarations
-    final path = r'/device-info';
-
-    // ignore: prefer_final_locals
-    Object? postBody = upsertDeviceInfoDto;
-
-    final queryParams = <QueryParam>[];
-    final headerParams = <String, String>{};
-    final formParams = <String, String>{};
-
-    const contentTypes = <String>['application/json'];
-
-
-    return apiClient.invokeAPI(
-      path,
-      'PATCH',
-      queryParams,
-      postBody,
-      headerParams,
-      formParams,
-      contentTypes.isEmpty ? null : contentTypes.first,
-    );
-  }
-
-  /// @deprecated
-  ///
-  /// Parameters:
-  ///
-  /// * [UpsertDeviceInfoDto] upsertDeviceInfoDto (required):
-  Future<DeviceInfoResponseDto?> updateDeviceInfo(UpsertDeviceInfoDto upsertDeviceInfoDto,) async {
-    final response = await updateDeviceInfoWithHttpInfo(upsertDeviceInfoDto,);
-    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), 'DeviceInfoResponseDto',) as DeviceInfoResponseDto;
-    
-    }
-    return null;
-  }
-
   /// 
   ///
   /// Note: This method returns the HTTP [Response].

+ 0 - 14
mobile/openapi/test/device_info_api_test.dart

@@ -17,20 +17,6 @@ void main() {
   // final instance = DeviceInfoApi();
 
   group('tests for DeviceInfoApi', () {
-    // @deprecated
-    //
-    //Future<DeviceInfoResponseDto> createDeviceInfo(UpsertDeviceInfoDto upsertDeviceInfoDto) async
-    test('test createDeviceInfo', () async {
-      // TODO
-    });
-
-    // @deprecated
-    //
-    //Future<DeviceInfoResponseDto> updateDeviceInfo(UpsertDeviceInfoDto upsertDeviceInfoDto) async
-    test('test updateDeviceInfo', () async {
-      // TODO
-    });
-
     // 
     //
     //Future<DeviceInfoResponseDto> upsertDeviceInfo(UpsertDeviceInfoDto upsertDeviceInfoDto) async

+ 1 - 19
server/apps/immich/src/api-v1/device-info/device-info.controller.ts

@@ -1,4 +1,4 @@
-import { Body, Controller, Patch, Post, Put, ValidationPipe } from '@nestjs/common';
+import { Body, Controller, Put, ValidationPipe } from '@nestjs/common';
 import { ApiBearerAuth, ApiTags } from '@nestjs/swagger';
 import { AuthUserDto, GetAuthUser } from '../../decorators/auth-user.decorator';
 import { Authenticated } from '../../decorators/authenticated.decorator';
@@ -13,24 +13,6 @@ import { DeviceInfoResponseDto, mapDeviceInfoResponse } from './response-dto/dev
 export class DeviceInfoController {
   constructor(private readonly deviceInfoService: DeviceInfoService) {}
 
-  /** @deprecated */
-  @Post()
-  public async createDeviceInfo(
-    @GetAuthUser() user: AuthUserDto,
-    @Body(ValidationPipe) dto: UpsertDeviceInfoDto,
-  ): Promise<DeviceInfoResponseDto> {
-    return this.upsertDeviceInfo(user, dto);
-  }
-
-  /** @deprecated */
-  @Patch()
-  public async updateDeviceInfo(
-    @GetAuthUser() user: AuthUserDto,
-    @Body(ValidationPipe) dto: UpsertDeviceInfoDto,
-  ): Promise<DeviceInfoResponseDto> {
-    return this.upsertDeviceInfo(user, dto);
-  }
-
   @Put()
   public async upsertDeviceInfo(
     @GetAuthUser() user: AuthUserDto,

+ 0 - 72
server/immich-openapi-specs.json

@@ -2506,78 +2506,6 @@
       }
     },
     "/device-info": {
-      "post": {
-        "operationId": "createDeviceInfo",
-        "description": "@deprecated",
-        "deprecated": true,
-        "parameters": [],
-        "requestBody": {
-          "required": true,
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/UpsertDeviceInfoDto"
-              }
-            }
-          }
-        },
-        "responses": {
-          "201": {
-            "description": "",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/DeviceInfoResponseDto"
-                }
-              }
-            }
-          }
-        },
-        "tags": [
-          "Device Info"
-        ],
-        "security": [
-          {
-            "bearer": []
-          }
-        ]
-      },
-      "patch": {
-        "operationId": "updateDeviceInfo",
-        "description": "@deprecated",
-        "deprecated": true,
-        "parameters": [],
-        "requestBody": {
-          "required": true,
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/UpsertDeviceInfoDto"
-              }
-            }
-          }
-        },
-        "responses": {
-          "200": {
-            "description": "",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/DeviceInfoResponseDto"
-                }
-              }
-            }
-          }
-        },
-        "tags": [
-          "Device Info"
-        ],
-        "security": [
-          {
-            "bearer": []
-          }
-        ]
-      },
       "put": {
         "operationId": "upsertDeviceInfo",
         "description": "",

+ 0 - 146
web/src/api/open-api/api.ts

@@ -5487,86 +5487,6 @@ export class AuthenticationApi extends BaseAPI {
  */
 export const DeviceInfoApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
-        /**
-         * @deprecated
-         * @param {UpsertDeviceInfoDto} upsertDeviceInfoDto 
-         * @param {*} [options] Override http request option.
-         * @deprecated
-         * @throws {RequiredError}
-         */
-        createDeviceInfo: async (upsertDeviceInfoDto: UpsertDeviceInfoDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
-            // verify required parameter 'upsertDeviceInfoDto' is not null or undefined
-            assertParamExists('createDeviceInfo', 'upsertDeviceInfoDto', upsertDeviceInfoDto)
-            const localVarPath = `/device-info`;
-            // use dummy base URL string because the URL constructor only accepts absolute URLs.
-            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
-            let baseOptions;
-            if (configuration) {
-                baseOptions = configuration.baseOptions;
-            }
-
-            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
-            const localVarHeaderParameter = {} as any;
-            const localVarQueryParameter = {} as any;
-
-            // authentication bearer required
-            // http bearer authentication required
-            await setBearerAuthToObject(localVarHeaderParameter, configuration)
-
-
-    
-            localVarHeaderParameter['Content-Type'] = 'application/json';
-
-            setSearchParams(localVarUrlObj, localVarQueryParameter);
-            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
-            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
-            localVarRequestOptions.data = serializeDataIfNeeded(upsertDeviceInfoDto, localVarRequestOptions, configuration)
-
-            return {
-                url: toPathString(localVarUrlObj),
-                options: localVarRequestOptions,
-            };
-        },
-        /**
-         * @deprecated
-         * @param {UpsertDeviceInfoDto} upsertDeviceInfoDto 
-         * @param {*} [options] Override http request option.
-         * @deprecated
-         * @throws {RequiredError}
-         */
-        updateDeviceInfo: async (upsertDeviceInfoDto: UpsertDeviceInfoDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
-            // verify required parameter 'upsertDeviceInfoDto' is not null or undefined
-            assertParamExists('updateDeviceInfo', 'upsertDeviceInfoDto', upsertDeviceInfoDto)
-            const localVarPath = `/device-info`;
-            // use dummy base URL string because the URL constructor only accepts absolute URLs.
-            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
-            let baseOptions;
-            if (configuration) {
-                baseOptions = configuration.baseOptions;
-            }
-
-            const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
-            const localVarHeaderParameter = {} as any;
-            const localVarQueryParameter = {} as any;
-
-            // authentication bearer required
-            // http bearer authentication required
-            await setBearerAuthToObject(localVarHeaderParameter, configuration)
-
-
-    
-            localVarHeaderParameter['Content-Type'] = 'application/json';
-
-            setSearchParams(localVarUrlObj, localVarQueryParameter);
-            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
-            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
-            localVarRequestOptions.data = serializeDataIfNeeded(upsertDeviceInfoDto, localVarRequestOptions, configuration)
-
-            return {
-                url: toPathString(localVarUrlObj),
-                options: localVarRequestOptions,
-            };
-        },
         /**
          * 
          * @param {UpsertDeviceInfoDto} upsertDeviceInfoDto 
@@ -5616,28 +5536,6 @@ export const DeviceInfoApiAxiosParamCreator = function (configuration?: Configur
 export const DeviceInfoApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = DeviceInfoApiAxiosParamCreator(configuration)
     return {
-        /**
-         * @deprecated
-         * @param {UpsertDeviceInfoDto} upsertDeviceInfoDto 
-         * @param {*} [options] Override http request option.
-         * @deprecated
-         * @throws {RequiredError}
-         */
-        async createDeviceInfo(upsertDeviceInfoDto: UpsertDeviceInfoDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceInfoResponseDto>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.createDeviceInfo(upsertDeviceInfoDto, options);
-            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
-        },
-        /**
-         * @deprecated
-         * @param {UpsertDeviceInfoDto} upsertDeviceInfoDto 
-         * @param {*} [options] Override http request option.
-         * @deprecated
-         * @throws {RequiredError}
-         */
-        async updateDeviceInfo(upsertDeviceInfoDto: UpsertDeviceInfoDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceInfoResponseDto>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.updateDeviceInfo(upsertDeviceInfoDto, options);
-            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
-        },
         /**
          * 
          * @param {UpsertDeviceInfoDto} upsertDeviceInfoDto 
@@ -5658,26 +5556,6 @@ export const DeviceInfoApiFp = function(configuration?: Configuration) {
 export const DeviceInfoApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     const localVarFp = DeviceInfoApiFp(configuration)
     return {
-        /**
-         * @deprecated
-         * @param {UpsertDeviceInfoDto} upsertDeviceInfoDto 
-         * @param {*} [options] Override http request option.
-         * @deprecated
-         * @throws {RequiredError}
-         */
-        createDeviceInfo(upsertDeviceInfoDto: UpsertDeviceInfoDto, options?: any): AxiosPromise<DeviceInfoResponseDto> {
-            return localVarFp.createDeviceInfo(upsertDeviceInfoDto, options).then((request) => request(axios, basePath));
-        },
-        /**
-         * @deprecated
-         * @param {UpsertDeviceInfoDto} upsertDeviceInfoDto 
-         * @param {*} [options] Override http request option.
-         * @deprecated
-         * @throws {RequiredError}
-         */
-        updateDeviceInfo(upsertDeviceInfoDto: UpsertDeviceInfoDto, options?: any): AxiosPromise<DeviceInfoResponseDto> {
-            return localVarFp.updateDeviceInfo(upsertDeviceInfoDto, options).then((request) => request(axios, basePath));
-        },
         /**
          * 
          * @param {UpsertDeviceInfoDto} upsertDeviceInfoDto 
@@ -5697,30 +5575,6 @@ export const DeviceInfoApiFactory = function (configuration?: Configuration, bas
  * @extends {BaseAPI}
  */
 export class DeviceInfoApi extends BaseAPI {
-    /**
-     * @deprecated
-     * @param {UpsertDeviceInfoDto} upsertDeviceInfoDto 
-     * @param {*} [options] Override http request option.
-     * @deprecated
-     * @throws {RequiredError}
-     * @memberof DeviceInfoApi
-     */
-    public createDeviceInfo(upsertDeviceInfoDto: UpsertDeviceInfoDto, options?: AxiosRequestConfig) {
-        return DeviceInfoApiFp(this.configuration).createDeviceInfo(upsertDeviceInfoDto, options).then((request) => request(this.axios, this.basePath));
-    }
-
-    /**
-     * @deprecated
-     * @param {UpsertDeviceInfoDto} upsertDeviceInfoDto 
-     * @param {*} [options] Override http request option.
-     * @deprecated
-     * @throws {RequiredError}
-     * @memberof DeviceInfoApi
-     */
-    public updateDeviceInfo(upsertDeviceInfoDto: UpsertDeviceInfoDto, options?: AxiosRequestConfig) {
-        return DeviceInfoApiFp(this.configuration).updateDeviceInfo(upsertDeviceInfoDto, options).then((request) => request(this.axios, this.basePath));
-    }
-
     /**
      * 
      * @param {UpsertDeviceInfoDto} upsertDeviceInfoDto