1
0
mirror of https://github.com/immich-app/immich.git synced 2024-12-24 10:37:28 +02:00
immich/mobile/openapi/README.md
Alex b660240059
fix(web/server) uploaded asset in shared link not loaded (#1766)
* fix(web/server): Uploaded asset to shared link does not get added to the shared link/album

* remove unused code

* Add endpoints for each remove and add assets to shared link

* Update api

* Added deletion logic

* Convert callback to async/await

* Fix linter

* Fix test

* Fix server test

* added test

* Test coverage

* modify DTO

* Add notification

* fix test
2023-02-15 15:21:22 -06:00

13 KiB
Generated

openapi

Immich API

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: 1.47.2
  • Build package: org.openapitools.codegen.languages.DartClientCodegen

Requirements

Dart 2.12 or later

Installation & Usage

Github

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  openapi:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git

Local

To use the package in your local drive, add the following dependency to your pubspec.yaml

dependencies:
  openapi:
    path: /path/to/openapi

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:openapi/api.dart';


final api_instance = APIKeyApi();
final aPIKeyCreateDto = APIKeyCreateDto(); // APIKeyCreateDto | 

try {
    final result = api_instance.createKey(aPIKeyCreateDto);
    print(result);
} catch (e) {
    print('Exception when calling APIKeyApi->createKey: $e\n');
}

Documentation for API Endpoints

All URIs are relative to /api

Class Method HTTP request Description
APIKeyApi createKey POST /api-key
APIKeyApi deleteKey DELETE /api-key/{id}
APIKeyApi getKey GET /api-key/{id}
APIKeyApi getKeys GET /api-key
APIKeyApi updateKey PUT /api-key/{id}
AlbumApi addAssetsToAlbum PUT /album/{albumId}/assets
AlbumApi addUsersToAlbum PUT /album/{albumId}/users
AlbumApi createAlbum POST /album
AlbumApi createAlbumSharedLink POST /album/create-shared-link
AlbumApi deleteAlbum DELETE /album/{albumId}
AlbumApi downloadArchive GET /album/{albumId}/download
AlbumApi getAlbumCountByUserId GET /album/count-by-user-id
AlbumApi getAlbumInfo GET /album/{albumId}
AlbumApi getAllAlbums GET /album
AlbumApi removeAssetFromAlbum DELETE /album/{albumId}/assets
AlbumApi removeUserFromAlbum DELETE /album/{albumId}/user/{userId}
AlbumApi updateAlbumInfo PATCH /album/{albumId}
AssetApi addAssetsToSharedLink PATCH /asset/shared-link/add
AssetApi checkDuplicateAsset POST /asset/check
AssetApi checkExistingAssets POST /asset/exist
AssetApi createAssetsSharedLink POST /asset/shared-link
AssetApi deleteAsset DELETE /asset
AssetApi downloadFile GET /asset/download/{assetId}
AssetApi downloadFiles POST /asset/download-files
AssetApi downloadLibrary GET /asset/download-library
AssetApi getAllAssets GET /asset
AssetApi getAssetById GET /asset/assetById/{assetId}
AssetApi getAssetByTimeBucket POST /asset/time-bucket
AssetApi getAssetCountByTimeBucket POST /asset/count-by-time-bucket
AssetApi getAssetCountByUserId GET /asset/count-by-user-id
AssetApi getAssetSearchTerms GET /asset/search-terms
AssetApi getAssetThumbnail GET /asset/thumbnail/{assetId}
AssetApi getCuratedLocations GET /asset/curated-locations
AssetApi getCuratedObjects GET /asset/curated-objects
AssetApi getUserAssetsByDeviceId GET /asset/{deviceId}
AssetApi removeAssetsFromSharedLink PATCH /asset/shared-link/remove
AssetApi searchAsset POST /asset/search
AssetApi serveFile GET /asset/file/{assetId}
AssetApi updateAsset PUT /asset/{assetId}
AssetApi uploadFile POST /asset/upload
AuthenticationApi adminSignUp POST /auth/admin-sign-up
AuthenticationApi changePassword POST /auth/change-password
AuthenticationApi login POST /auth/login
AuthenticationApi logout POST /auth/logout
AuthenticationApi validateAccessToken POST /auth/validateToken
DeviceInfoApi upsertDeviceInfo PUT /device-info
JobApi getAllJobsStatus GET /jobs
JobApi sendJobCommand PUT /jobs/{jobId}
OAuthApi callback POST /oauth/callback
OAuthApi generateConfig POST /oauth/config
OAuthApi link POST /oauth/link
OAuthApi mobileRedirect GET /oauth/mobile-redirect
OAuthApi unlink POST /oauth/unlink
ServerInfoApi getServerInfo GET /server-info
ServerInfoApi getServerVersion GET /server-info/version
ServerInfoApi getStats GET /server-info/stats
ServerInfoApi pingServer GET /server-info/ping
ShareApi editSharedLink PATCH /share/{id}
ShareApi getAllSharedLinks GET /share
ShareApi getMySharedLink GET /share/me
ShareApi getSharedLinkById GET /share/{id}
ShareApi removeSharedLink DELETE /share/{id}
SystemConfigApi getConfig GET /system-config
SystemConfigApi getDefaults GET /system-config/defaults
SystemConfigApi getStorageTemplateOptions GET /system-config/storage-template-options
SystemConfigApi updateConfig PUT /system-config
TagApi create POST /tag
TagApi delete DELETE /tag/{id}
TagApi findAll GET /tag
TagApi findOne GET /tag/{id}
TagApi update PATCH /tag/{id}
UserApi createProfileImage POST /user/profile-image
UserApi createUser POST /user
UserApi deleteUser DELETE /user/{userId}
UserApi getAllUsers GET /user
UserApi getMyUserInfo GET /user/me
UserApi getProfileImage GET /user/profile-image/{userId}
UserApi getUserById GET /user/info/{userId}
UserApi getUserCount GET /user/count
UserApi restoreUser POST /user/{userId}/restore
UserApi updateUser PUT /user

Documentation For Models

Documentation For Authorization

bearer

  • Type: HTTP Bearer authentication

Author