2022-07-13 12:23:48 +00:00
|
|
|
# openapi
|
|
|
|
|
Immich API
|
|
|
|
|
|
|
|
|
|
This Dart package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
|
|
|
|
2023-10-03 20:48:23 +00:00
|
|
|
- API version: 1.81.0
|
2022-07-13 12:23:48 +00:00
|
|
|
- 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](#installation--usage) and then run the following:
|
|
|
|
|
|
|
|
|
|
```dart
|
|
|
|
|
import 'package:openapi/api.dart';
|
|
|
|
|
|
2023-04-09 02:26:09 +00:00
|
|
|
// TODO Configure API key authorization: cookie
|
|
|
|
|
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
|
|
|
|
|
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
|
|
|
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
|
2023-05-04 16:41:29 +00:00
|
|
|
// TODO Configure API key authorization: api_key
|
|
|
|
|
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
|
|
|
|
|
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
|
|
|
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
|
2023-02-24 16:01:10 +00:00
|
|
|
// 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);
|
2022-07-13 12:23:48 +00:00
|
|
|
|
2023-01-02 20:22:33 +00:00
|
|
|
final api_instance = APIKeyApi();
|
|
|
|
|
final aPIKeyCreateDto = APIKeyCreateDto(); // APIKeyCreateDto |
|
2022-07-13 12:23:48 +00:00
|
|
|
|
|
|
|
|
try {
|
2023-01-02 20:22:33 +00:00
|
|
|
final result = api_instance.createKey(aPIKeyCreateDto);
|
2022-07-13 12:23:48 +00:00
|
|
|
print(result);
|
|
|
|
|
} catch (e) {
|
2023-01-02 20:22:33 +00:00
|
|
|
print('Exception when calling APIKeyApi->createKey: $e\n');
|
2022-07-13 12:23:48 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Documentation for API Endpoints
|
|
|
|
|
|
|
|
|
|
All URIs are relative to */api*
|
|
|
|
|
|
|
|
|
|
Class | Method | HTTP request | Description
|
|
|
|
|
------------ | ------------- | ------------- | -------------
|
2023-01-02 20:22:33 +00:00
|
|
|
*APIKeyApi* | [**createKey**](doc//APIKeyApi.md#createkey) | **POST** /api-key |
|
|
|
|
|
*APIKeyApi* | [**deleteKey**](doc//APIKeyApi.md#deletekey) | **DELETE** /api-key/{id} |
|
|
|
|
|
*APIKeyApi* | [**getKey**](doc//APIKeyApi.md#getkey) | **GET** /api-key/{id} |
|
|
|
|
|
*APIKeyApi* | [**getKeys**](doc//APIKeyApi.md#getkeys) | **GET** /api-key |
|
|
|
|
|
*APIKeyApi* | [**updateKey**](doc//APIKeyApi.md#updatekey) | **PUT** /api-key/{id} |
|
2023-05-24 14:30:13 +00:00
|
|
|
*AlbumApi* | [**addAssetsToAlbum**](doc//AlbumApi.md#addassetstoalbum) | **PUT** /album/{id}/assets |
|
|
|
|
|
*AlbumApi* | [**addUsersToAlbum**](doc//AlbumApi.md#adduserstoalbum) | **PUT** /album/{id}/users |
|
2022-07-13 12:23:48 +00:00
|
|
|
*AlbumApi* | [**createAlbum**](doc//AlbumApi.md#createalbum) | **POST** /album |
|
2023-05-24 14:30:13 +00:00
|
|
|
*AlbumApi* | [**deleteAlbum**](doc//AlbumApi.md#deletealbum) | **DELETE** /album/{id} |
|
2023-06-16 15:48:48 +00:00
|
|
|
*AlbumApi* | [**getAlbumCount**](doc//AlbumApi.md#getalbumcount) | **GET** /album/count |
|
2023-05-24 14:30:13 +00:00
|
|
|
*AlbumApi* | [**getAlbumInfo**](doc//AlbumApi.md#getalbuminfo) | **GET** /album/{id} |
|
2022-07-13 12:23:48 +00:00
|
|
|
*AlbumApi* | [**getAllAlbums**](doc//AlbumApi.md#getallalbums) | **GET** /album |
|
2023-05-24 14:30:13 +00:00
|
|
|
*AlbumApi* | [**removeAssetFromAlbum**](doc//AlbumApi.md#removeassetfromalbum) | **DELETE** /album/{id}/assets |
|
|
|
|
|
*AlbumApi* | [**removeUserFromAlbum**](doc//AlbumApi.md#removeuserfromalbum) | **DELETE** /album/{id}/user/{userId} |
|
|
|
|
|
*AlbumApi* | [**updateAlbumInfo**](doc//AlbumApi.md#updatealbuminfo) | **PATCH** /album/{id} |
|
2023-05-24 21:08:21 +00:00
|
|
|
*AssetApi* | [**bulkUploadCheck**](doc//AssetApi.md#bulkuploadcheck) | **POST** /asset/bulk-upload-check |
|
2022-07-13 12:23:48 +00:00
|
|
|
*AssetApi* | [**checkDuplicateAsset**](doc//AssetApi.md#checkduplicateasset) | **POST** /asset/check |
|
2022-10-25 14:51:03 +00:00
|
|
|
*AssetApi* | [**checkExistingAssets**](doc//AssetApi.md#checkexistingassets) | **POST** /asset/exist |
|
2022-07-13 12:23:48 +00:00
|
|
|
*AssetApi* | [**deleteAsset**](doc//AssetApi.md#deleteasset) | **DELETE** /asset |
|
2023-08-15 15:49:32 +00:00
|
|
|
*AssetApi* | [**downloadArchive**](doc//AssetApi.md#downloadarchive) | **POST** /asset/download/archive |
|
2023-06-30 16:24:28 +00:00
|
|
|
*AssetApi* | [**downloadFile**](doc//AssetApi.md#downloadfile) | **POST** /asset/download/{id} |
|
2022-07-13 12:23:48 +00:00
|
|
|
*AssetApi* | [**getAllAssets**](doc//AssetApi.md#getallassets) | **GET** /asset |
|
2023-06-02 02:19:25 +00:00
|
|
|
*AssetApi* | [**getAssetById**](doc//AssetApi.md#getassetbyid) | **GET** /asset/assetById/{id} |
|
2022-08-27 05:53:37 +00:00
|
|
|
*AssetApi* | [**getAssetSearchTerms**](doc//AssetApi.md#getassetsearchterms) | **GET** /asset/search-terms |
|
2023-07-14 13:30:17 +00:00
|
|
|
*AssetApi* | [**getAssetStats**](doc//AssetApi.md#getassetstats) | **GET** /asset/statistics |
|
2023-06-02 02:19:25 +00:00
|
|
|
*AssetApi* | [**getAssetThumbnail**](doc//AssetApi.md#getassetthumbnail) | **GET** /asset/thumbnail/{id} |
|
2023-08-04 21:07:15 +00:00
|
|
|
*AssetApi* | [**getByTimeBucket**](doc//AssetApi.md#getbytimebucket) | **GET** /asset/time-bucket |
|
2022-08-27 05:53:37 +00:00
|
|
|
*AssetApi* | [**getCuratedLocations**](doc//AssetApi.md#getcuratedlocations) | **GET** /asset/curated-locations |
|
|
|
|
|
*AssetApi* | [**getCuratedObjects**](doc//AssetApi.md#getcuratedobjects) | **GET** /asset/curated-objects |
|
2023-08-15 15:49:32 +00:00
|
|
|
*AssetApi* | [**getDownloadInfo**](doc//AssetApi.md#getdownloadinfo) | **POST** /asset/download/info |
|
2023-05-06 01:33:30 +00:00
|
|
|
*AssetApi* | [**getMapMarkers**](doc//AssetApi.md#getmapmarkers) | **GET** /asset/map-marker |
|
2023-06-15 01:47:18 +00:00
|
|
|
*AssetApi* | [**getMemoryLane**](doc//AssetApi.md#getmemorylane) | **GET** /asset/memory-lane |
|
2023-09-23 15:28:55 +00:00
|
|
|
*AssetApi* | [**getRandom**](doc//AssetApi.md#getrandom) | **GET** /asset/random |
|
2023-08-04 21:07:15 +00:00
|
|
|
*AssetApi* | [**getTimeBuckets**](doc//AssetApi.md#gettimebuckets) | **GET** /asset/time-buckets |
|
2022-07-13 12:23:48 +00:00
|
|
|
*AssetApi* | [**getUserAssetsByDeviceId**](doc//AssetApi.md#getuserassetsbydeviceid) | **GET** /asset/{deviceId} |
|
feat(server): support for read-only assets and importing existing items in the filesystem (#2715)
* Added read-only flag for assets, endpoint to trigger file import vs upload
* updated fixtures with new property
* if upload is 'read-only', ensure there is no existing asset at the designated originalPath
* added test for file import as well as detecting existing image at read-only destination location
* Added storage service test for a case where it should not move read-only assets
* upload doesn't need the read-only flag available, just importing
* default isReadOnly on import endpoint to true
* formatting fixes
* create-asset dto needs isReadOnly, so set it to false by default on create, updated api generation
* updated code to reflect changes in MR
* fixed read stream promise return type
* new index for originalPath, check for existing path on import, reglardless of user, to prevent duplicates
* refactor: import asset
* chore: open api
* chore: tests
* Added externalPath support for individual users, updated UI to allow this to be set by admin
* added missing var for externalPath in ui
* chore: open api
* fix: compilation issues
* fix: server test
* built api, fixed user-response dto to include externalPath
* reverted accidental commit
* bad commit of duplicate externalPath in user response dto
* fixed tests to include externalPath on expected result
* fix: unit tests
* centralized supported filetypes, perform file type checking of asset and sidecar during file import process
* centralized supported filetype check method to keep regex DRY
* fixed typo
* combined migrations into one
* update api
* Removed externalPath from shared-link code, added column to admin user page whether external paths / import is enabled or not
* update mimetype
* Fixed detect correct mimetype
* revert asset-upload config
* reverted domain.constant
* refactor
* fix mime-type issue
* fix format
---------
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2023-06-22 02:33:20 +00:00
|
|
|
*AssetApi* | [**importFile**](doc//AssetApi.md#importfile) | **POST** /asset/import |
|
2023-08-18 14:31:48 +00:00
|
|
|
*AssetApi* | [**runAssetJobs**](doc//AssetApi.md#runassetjobs) | **POST** /asset/jobs |
|
2022-07-13 12:23:48 +00:00
|
|
|
*AssetApi* | [**searchAsset**](doc//AssetApi.md#searchasset) | **POST** /asset/search |
|
2023-06-02 02:19:25 +00:00
|
|
|
*AssetApi* | [**serveFile**](doc//AssetApi.md#servefile) | **GET** /asset/file/{id} |
|
|
|
|
|
*AssetApi* | [**updateAsset**](doc//AssetApi.md#updateasset) | **PUT** /asset/{id} |
|
2023-08-16 20:04:55 +00:00
|
|
|
*AssetApi* | [**updateAssets**](doc//AssetApi.md#updateassets) | **PUT** /asset |
|
2022-07-13 12:23:48 +00:00
|
|
|
*AssetApi* | [**uploadFile**](doc//AssetApi.md#uploadfile) | **POST** /asset/upload |
|
2023-08-24 19:28:50 +00:00
|
|
|
*AuditApi* | [**getAuditDeletes**](doc//AuditApi.md#getauditdeletes) | **GET** /audit/deletes |
|
2022-07-13 12:23:48 +00:00
|
|
|
*AuthenticationApi* | [**adminSignUp**](doc//AuthenticationApi.md#adminsignup) | **POST** /auth/admin-sign-up |
|
2022-12-21 14:43:35 +00:00
|
|
|
*AuthenticationApi* | [**changePassword**](doc//AuthenticationApi.md#changepassword) | **POST** /auth/change-password |
|
2023-04-26 02:19:23 +00:00
|
|
|
*AuthenticationApi* | [**getAuthDevices**](doc//AuthenticationApi.md#getauthdevices) | **GET** /auth/devices |
|
2022-07-13 12:23:48 +00:00
|
|
|
*AuthenticationApi* | [**login**](doc//AuthenticationApi.md#login) | **POST** /auth/login |
|
2022-07-19 18:49:58 +00:00
|
|
|
*AuthenticationApi* | [**logout**](doc//AuthenticationApi.md#logout) | **POST** /auth/logout |
|
2023-04-26 02:19:23 +00:00
|
|
|
*AuthenticationApi* | [**logoutAuthDevice**](doc//AuthenticationApi.md#logoutauthdevice) | **DELETE** /auth/devices/{id} |
|
2023-05-09 19:34:17 +00:00
|
|
|
*AuthenticationApi* | [**logoutAuthDevices**](doc//AuthenticationApi.md#logoutauthdevices) | **DELETE** /auth/devices |
|
2022-07-13 12:23:48 +00:00
|
|
|
*AuthenticationApi* | [**validateAccessToken**](doc//AuthenticationApi.md#validateaccesstoken) | **POST** /auth/validateToken |
|
2022-10-06 16:25:54 +00:00
|
|
|
*JobApi* | [**getAllJobsStatus**](doc//JobApi.md#getalljobsstatus) | **GET** /jobs |
|
2023-06-16 19:36:07 +00:00
|
|
|
*JobApi* | [**sendJobCommand**](doc//JobApi.md#sendjobcommand) | **PUT** /jobs/{id} |
|
2023-09-20 11:16:33 +00:00
|
|
|
*LibraryApi* | [**createLibrary**](doc//LibraryApi.md#createlibrary) | **POST** /library |
|
|
|
|
|
*LibraryApi* | [**deleteLibrary**](doc//LibraryApi.md#deletelibrary) | **DELETE** /library/{id} |
|
|
|
|
|
*LibraryApi* | [**getAllForUser**](doc//LibraryApi.md#getallforuser) | **GET** /library |
|
|
|
|
|
*LibraryApi* | [**getLibraryInfo**](doc//LibraryApi.md#getlibraryinfo) | **GET** /library/{id} |
|
|
|
|
|
*LibraryApi* | [**getLibraryStatistics**](doc//LibraryApi.md#getlibrarystatistics) | **GET** /library/{id}/statistics |
|
|
|
|
|
*LibraryApi* | [**removeOfflineFiles**](doc//LibraryApi.md#removeofflinefiles) | **POST** /library/{id}/removeOffline |
|
|
|
|
|
*LibraryApi* | [**scanLibrary**](doc//LibraryApi.md#scanlibrary) | **POST** /library/{id}/scan |
|
|
|
|
|
*LibraryApi* | [**updateLibrary**](doc//LibraryApi.md#updatelibrary) | **PUT** /library/{id} |
|
2023-09-01 11:08:42 +00:00
|
|
|
*OAuthApi* | [**authorizeOAuth**](doc//OAuthApi.md#authorizeoauth) | **POST** /oauth/authorize |
|
2022-11-15 02:24:25 +00:00
|
|
|
*OAuthApi* | [**callback**](doc//OAuthApi.md#callback) | **POST** /oauth/callback |
|
|
|
|
|
*OAuthApi* | [**generateConfig**](doc//OAuthApi.md#generateconfig) | **POST** /oauth/config |
|
2022-12-26 15:35:52 +00:00
|
|
|
*OAuthApi* | [**link**](doc//OAuthApi.md#link) | **POST** /oauth/link |
|
2022-12-29 20:47:30 +00:00
|
|
|
*OAuthApi* | [**mobileRedirect**](doc//OAuthApi.md#mobileredirect) | **GET** /oauth/mobile-redirect |
|
2022-12-26 15:35:52 +00:00
|
|
|
*OAuthApi* | [**unlink**](doc//OAuthApi.md#unlink) | **POST** /oauth/unlink |
|
2023-05-15 17:30:53 +00:00
|
|
|
*PartnerApi* | [**createPartner**](doc//PartnerApi.md#createpartner) | **POST** /partner/{id} |
|
|
|
|
|
*PartnerApi* | [**getPartners**](doc//PartnerApi.md#getpartners) | **GET** /partner |
|
|
|
|
|
*PartnerApi* | [**removePartner**](doc//PartnerApi.md#removepartner) | **DELETE** /partner/{id} |
|
2023-05-17 17:07:17 +00:00
|
|
|
*PersonApi* | [**getAllPeople**](doc//PersonApi.md#getallpeople) | **GET** /person |
|
|
|
|
|
*PersonApi* | [**getPerson**](doc//PersonApi.md#getperson) | **GET** /person/{id} |
|
|
|
|
|
*PersonApi* | [**getPersonAssets**](doc//PersonApi.md#getpersonassets) | **GET** /person/{id}/assets |
|
|
|
|
|
*PersonApi* | [**getPersonThumbnail**](doc//PersonApi.md#getpersonthumbnail) | **GET** /person/{id}/thumbnail |
|
2023-07-11 21:52:41 +00:00
|
|
|
*PersonApi* | [**mergePerson**](doc//PersonApi.md#mergeperson) | **POST** /person/{id}/merge |
|
2023-07-23 03:00:43 +00:00
|
|
|
*PersonApi* | [**updatePeople**](doc//PersonApi.md#updatepeople) | **PUT** /person |
|
2023-05-17 17:07:17 +00:00
|
|
|
*PersonApi* | [**updatePerson**](doc//PersonApi.md#updateperson) | **PUT** /person/{id} |
|
2023-03-05 20:44:31 +00:00
|
|
|
*SearchApi* | [**getExploreData**](doc//SearchApi.md#getexploredata) | **GET** /search/explore |
|
2023-03-03 02:47:08 +00:00
|
|
|
*SearchApi* | [**search**](doc//SearchApi.md#search) | **GET** /search |
|
2023-09-09 02:51:46 +00:00
|
|
|
*ServerInfoApi* | [**getServerConfig**](doc//ServerInfoApi.md#getserverconfig) | **GET** /server-info/config |
|
2023-08-18 04:55:26 +00:00
|
|
|
*ServerInfoApi* | [**getServerFeatures**](doc//ServerInfoApi.md#getserverfeatures) | **GET** /server-info/features |
|
2022-07-13 12:23:48 +00:00
|
|
|
*ServerInfoApi* | [**getServerInfo**](doc//ServerInfoApi.md#getserverinfo) | **GET** /server-info |
|
|
|
|
|
*ServerInfoApi* | [**getServerVersion**](doc//ServerInfoApi.md#getserverversion) | **GET** /server-info/version |
|
2022-10-23 21:54:54 +00:00
|
|
|
*ServerInfoApi* | [**getStats**](doc//ServerInfoApi.md#getstats) | **GET** /server-info/stats |
|
2023-07-16 01:24:46 +00:00
|
|
|
*ServerInfoApi* | [**getSupportedMediaTypes**](doc//ServerInfoApi.md#getsupportedmediatypes) | **GET** /server-info/media-types |
|
2022-07-13 12:23:48 +00:00
|
|
|
*ServerInfoApi* | [**pingServer**](doc//ServerInfoApi.md#pingserver) | **GET** /server-info/ping |
|
2023-06-21 01:08:43 +00:00
|
|
|
*SharedLinkApi* | [**addSharedLinkAssets**](doc//SharedLinkApi.md#addsharedlinkassets) | **PUT** /shared-link/{id}/assets |
|
|
|
|
|
*SharedLinkApi* | [**createSharedLink**](doc//SharedLinkApi.md#createsharedlink) | **POST** /shared-link |
|
|
|
|
|
*SharedLinkApi* | [**getAllSharedLinks**](doc//SharedLinkApi.md#getallsharedlinks) | **GET** /shared-link |
|
|
|
|
|
*SharedLinkApi* | [**getMySharedLink**](doc//SharedLinkApi.md#getmysharedlink) | **GET** /shared-link/me |
|
|
|
|
|
*SharedLinkApi* | [**getSharedLinkById**](doc//SharedLinkApi.md#getsharedlinkbyid) | **GET** /shared-link/{id} |
|
|
|
|
|
*SharedLinkApi* | [**removeSharedLink**](doc//SharedLinkApi.md#removesharedlink) | **DELETE** /shared-link/{id} |
|
|
|
|
|
*SharedLinkApi* | [**removeSharedLinkAssets**](doc//SharedLinkApi.md#removesharedlinkassets) | **DELETE** /shared-link/{id}/assets |
|
|
|
|
|
*SharedLinkApi* | [**updateSharedLink**](doc//SharedLinkApi.md#updatesharedlink) | **PATCH** /shared-link/{id} |
|
2022-11-15 04:39:32 +00:00
|
|
|
*SystemConfigApi* | [**getConfig**](doc//SystemConfigApi.md#getconfig) | **GET** /system-config |
|
2022-12-09 20:51:42 +00:00
|
|
|
*SystemConfigApi* | [**getDefaults**](doc//SystemConfigApi.md#getdefaults) | **GET** /system-config/defaults |
|
2022-12-16 20:26:12 +00:00
|
|
|
*SystemConfigApi* | [**getStorageTemplateOptions**](doc//SystemConfigApi.md#getstoragetemplateoptions) | **GET** /system-config/storage-template-options |
|
2022-11-15 04:39:32 +00:00
|
|
|
*SystemConfigApi* | [**updateConfig**](doc//SystemConfigApi.md#updateconfig) | **PUT** /system-config |
|
2023-06-01 01:51:28 +00:00
|
|
|
*TagApi* | [**createTag**](doc//TagApi.md#createtag) | **POST** /tag |
|
|
|
|
|
*TagApi* | [**deleteTag**](doc//TagApi.md#deletetag) | **DELETE** /tag/{id} |
|
|
|
|
|
*TagApi* | [**getAllTags**](doc//TagApi.md#getalltags) | **GET** /tag |
|
|
|
|
|
*TagApi* | [**getTagAssets**](doc//TagApi.md#gettagassets) | **GET** /tag/{id}/assets |
|
|
|
|
|
*TagApi* | [**getTagById**](doc//TagApi.md#gettagbyid) | **GET** /tag/{id} |
|
|
|
|
|
*TagApi* | [**tagAssets**](doc//TagApi.md#tagassets) | **PUT** /tag/{id}/assets |
|
|
|
|
|
*TagApi* | [**untagAssets**](doc//TagApi.md#untagassets) | **DELETE** /tag/{id}/assets |
|
|
|
|
|
*TagApi* | [**updateTag**](doc//TagApi.md#updatetag) | **PATCH** /tag/{id} |
|
2022-07-13 12:23:48 +00:00
|
|
|
*UserApi* | [**createProfileImage**](doc//UserApi.md#createprofileimage) | **POST** /user/profile-image |
|
|
|
|
|
*UserApi* | [**createUser**](doc//UserApi.md#createuser) | **POST** /user |
|
2023-08-03 18:17:38 +00:00
|
|
|
*UserApi* | [**deleteUser**](doc//UserApi.md#deleteuser) | **DELETE** /user/{id} |
|
2022-07-13 12:23:48 +00:00
|
|
|
*UserApi* | [**getAllUsers**](doc//UserApi.md#getallusers) | **GET** /user |
|
|
|
|
|
*UserApi* | [**getMyUserInfo**](doc//UserApi.md#getmyuserinfo) | **GET** /user/me |
|
2023-08-03 18:17:38 +00:00
|
|
|
*UserApi* | [**getProfileImage**](doc//UserApi.md#getprofileimage) | **GET** /user/profile-image/{id} |
|
|
|
|
|
*UserApi* | [**getUserById**](doc//UserApi.md#getuserbyid) | **GET** /user/info/{id} |
|
2022-07-13 12:23:48 +00:00
|
|
|
*UserApi* | [**getUserCount**](doc//UserApi.md#getusercount) | **GET** /user/count |
|
2023-08-03 18:17:38 +00:00
|
|
|
*UserApi* | [**restoreUser**](doc//UserApi.md#restoreuser) | **POST** /user/{id}/restore |
|
2022-07-13 12:23:48 +00:00
|
|
|
*UserApi* | [**updateUser**](doc//UserApi.md#updateuser) | **PUT** /user |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Documentation For Models
|
|
|
|
|
|
2023-01-02 20:22:33 +00:00
|
|
|
- [APIKeyCreateDto](doc//APIKeyCreateDto.md)
|
|
|
|
|
- [APIKeyCreateResponseDto](doc//APIKeyCreateResponseDto.md)
|
|
|
|
|
- [APIKeyResponseDto](doc//APIKeyResponseDto.md)
|
|
|
|
|
- [APIKeyUpdateDto](doc//APIKeyUpdateDto.md)
|
2022-07-13 12:23:48 +00:00
|
|
|
- [AddUsersDto](doc//AddUsersDto.md)
|
|
|
|
|
- [AdminSignupResponseDto](doc//AdminSignupResponseDto.md)
|
2022-09-07 20:16:18 +00:00
|
|
|
- [AlbumCountResponseDto](doc//AlbumCountResponseDto.md)
|
2022-07-13 12:23:48 +00:00
|
|
|
- [AlbumResponseDto](doc//AlbumResponseDto.md)
|
2022-10-06 16:25:54 +00:00
|
|
|
- [AllJobStatusResponseDto](doc//AllJobStatusResponseDto.md)
|
2023-08-16 20:04:55 +00:00
|
|
|
- [AssetBulkUpdateDto](doc//AssetBulkUpdateDto.md)
|
2023-05-24 21:08:21 +00:00
|
|
|
- [AssetBulkUploadCheckDto](doc//AssetBulkUploadCheckDto.md)
|
|
|
|
|
- [AssetBulkUploadCheckItem](doc//AssetBulkUploadCheckItem.md)
|
|
|
|
|
- [AssetBulkUploadCheckResponseDto](doc//AssetBulkUploadCheckResponseDto.md)
|
|
|
|
|
- [AssetBulkUploadCheckResult](doc//AssetBulkUploadCheckResult.md)
|
2022-07-13 12:23:48 +00:00
|
|
|
- [AssetFileUploadResponseDto](doc//AssetFileUploadResponseDto.md)
|
2023-06-01 01:51:28 +00:00
|
|
|
- [AssetIdsDto](doc//AssetIdsDto.md)
|
|
|
|
|
- [AssetIdsResponseDto](doc//AssetIdsResponseDto.md)
|
2023-08-18 14:31:48 +00:00
|
|
|
- [AssetJobName](doc//AssetJobName.md)
|
|
|
|
|
- [AssetJobsDto](doc//AssetJobsDto.md)
|
2022-07-13 12:23:48 +00:00
|
|
|
- [AssetResponseDto](doc//AssetResponseDto.md)
|
2023-07-14 13:30:17 +00:00
|
|
|
- [AssetStatsResponseDto](doc//AssetStatsResponseDto.md)
|
2022-07-13 12:23:48 +00:00
|
|
|
- [AssetTypeEnum](doc//AssetTypeEnum.md)
|
2023-07-09 02:43:11 +00:00
|
|
|
- [AudioCodec](doc//AudioCodec.md)
|
2023-08-24 19:28:50 +00:00
|
|
|
- [AuditDeletesResponseDto](doc//AuditDeletesResponseDto.md)
|
2023-04-26 02:19:23 +00:00
|
|
|
- [AuthDeviceResponseDto](doc//AuthDeviceResponseDto.md)
|
2023-07-11 21:52:41 +00:00
|
|
|
- [BulkIdResponseDto](doc//BulkIdResponseDto.md)
|
2023-08-02 01:29:14 +00:00
|
|
|
- [BulkIdsDto](doc//BulkIdsDto.md)
|
2023-08-29 13:58:00 +00:00
|
|
|
- [CLIPConfig](doc//CLIPConfig.md)
|
|
|
|
|
- [CLIPMode](doc//CLIPMode.md)
|
2023-09-03 01:22:42 +00:00
|
|
|
- [CQMode](doc//CQMode.md)
|
2022-12-21 14:43:35 +00:00
|
|
|
- [ChangePasswordDto](doc//ChangePasswordDto.md)
|
2022-07-13 12:23:48 +00:00
|
|
|
- [CheckDuplicateAssetDto](doc//CheckDuplicateAssetDto.md)
|
|
|
|
|
- [CheckDuplicateAssetResponseDto](doc//CheckDuplicateAssetResponseDto.md)
|
2022-10-25 14:51:03 +00:00
|
|
|
- [CheckExistingAssetsDto](doc//CheckExistingAssetsDto.md)
|
|
|
|
|
- [CheckExistingAssetsResponseDto](doc//CheckExistingAssetsResponseDto.md)
|
2023-09-26 07:03:57 +00:00
|
|
|
- [CitiesFile](doc//CitiesFile.md)
|
2023-08-29 13:58:00 +00:00
|
|
|
- [ClassificationConfig](doc//ClassificationConfig.md)
|
2023-09-03 06:21:51 +00:00
|
|
|
- [Colorspace](doc//Colorspace.md)
|
2022-07-13 12:23:48 +00:00
|
|
|
- [CreateAlbumDto](doc//CreateAlbumDto.md)
|
2023-09-20 11:16:33 +00:00
|
|
|
- [CreateLibraryDto](doc//CreateLibraryDto.md)
|
2022-07-13 12:23:48 +00:00
|
|
|
- [CreateProfileImageResponseDto](doc//CreateProfileImageResponseDto.md)
|
2022-12-05 17:56:44 +00:00
|
|
|
- [CreateTagDto](doc//CreateTagDto.md)
|
2022-07-13 12:23:48 +00:00
|
|
|
- [CreateUserDto](doc//CreateUserDto.md)
|
|
|
|
|
- [CuratedLocationsResponseDto](doc//CuratedLocationsResponseDto.md)
|
|
|
|
|
- [CuratedObjectsResponseDto](doc//CuratedObjectsResponseDto.md)
|
|
|
|
|
- [DeleteAssetDto](doc//DeleteAssetDto.md)
|
|
|
|
|
- [DeleteAssetResponseDto](doc//DeleteAssetResponseDto.md)
|
|
|
|
|
- [DeleteAssetStatus](doc//DeleteAssetStatus.md)
|
2023-06-30 16:24:28 +00:00
|
|
|
- [DownloadArchiveInfo](doc//DownloadArchiveInfo.md)
|
2023-08-15 15:49:32 +00:00
|
|
|
- [DownloadInfoDto](doc//DownloadInfoDto.md)
|
2023-06-30 16:24:28 +00:00
|
|
|
- [DownloadResponseDto](doc//DownloadResponseDto.md)
|
2023-08-24 19:28:50 +00:00
|
|
|
- [EntityType](doc//EntityType.md)
|
2022-07-13 12:23:48 +00:00
|
|
|
- [ExifResponseDto](doc//ExifResponseDto.md)
|
feat(server): support for read-only assets and importing existing items in the filesystem (#2715)
* Added read-only flag for assets, endpoint to trigger file import vs upload
* updated fixtures with new property
* if upload is 'read-only', ensure there is no existing asset at the designated originalPath
* added test for file import as well as detecting existing image at read-only destination location
* Added storage service test for a case where it should not move read-only assets
* upload doesn't need the read-only flag available, just importing
* default isReadOnly on import endpoint to true
* formatting fixes
* create-asset dto needs isReadOnly, so set it to false by default on create, updated api generation
* updated code to reflect changes in MR
* fixed read stream promise return type
* new index for originalPath, check for existing path on import, reglardless of user, to prevent duplicates
* refactor: import asset
* chore: open api
* chore: tests
* Added externalPath support for individual users, updated UI to allow this to be set by admin
* added missing var for externalPath in ui
* chore: open api
* fix: compilation issues
* fix: server test
* built api, fixed user-response dto to include externalPath
* reverted accidental commit
* bad commit of duplicate externalPath in user response dto
* fixed tests to include externalPath on expected result
* fix: unit tests
* centralized supported filetypes, perform file type checking of asset and sidecar during file import process
* centralized supported filetype check method to keep regex DRY
* fixed typo
* combined migrations into one
* update api
* Removed externalPath from shared-link code, added column to admin user page whether external paths / import is enabled or not
* update mimetype
* Fixed detect correct mimetype
* revert asset-upload config
* reverted domain.constant
* refactor
* fix mime-type issue
* fix format
---------
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2023-06-22 02:33:20 +00:00
|
|
|
- [ImportAssetDto](doc//ImportAssetDto.md)
|
2022-10-06 16:25:54 +00:00
|
|
|
- [JobCommand](doc//JobCommand.md)
|
|
|
|
|
- [JobCommandDto](doc//JobCommandDto.md)
|
2023-03-20 15:55:28 +00:00
|
|
|
- [JobCountsDto](doc//JobCountsDto.md)
|
|
|
|
|
- [JobName](doc//JobName.md)
|
2023-06-01 10:32:51 +00:00
|
|
|
- [JobSettingsDto](doc//JobSettingsDto.md)
|
2023-04-01 20:46:07 +00:00
|
|
|
- [JobStatusDto](doc//JobStatusDto.md)
|
2023-09-20 11:16:33 +00:00
|
|
|
- [LibraryResponseDto](doc//LibraryResponseDto.md)
|
|
|
|
|
- [LibraryStatsResponseDto](doc//LibraryStatsResponseDto.md)
|
|
|
|
|
- [LibraryType](doc//LibraryType.md)
|
2022-07-13 12:23:48 +00:00
|
|
|
- [LoginCredentialDto](doc//LoginCredentialDto.md)
|
|
|
|
|
- [LoginResponseDto](doc//LoginResponseDto.md)
|
2022-07-19 18:49:58 +00:00
|
|
|
- [LogoutResponseDto](doc//LogoutResponseDto.md)
|
2023-05-06 01:33:30 +00:00
|
|
|
- [MapMarkerResponseDto](doc//MapMarkerResponseDto.md)
|
2023-06-15 01:47:18 +00:00
|
|
|
- [MemoryLaneResponseDto](doc//MemoryLaneResponseDto.md)
|
2023-07-11 21:52:41 +00:00
|
|
|
- [MergePersonDto](doc//MergePersonDto.md)
|
2023-08-29 13:58:00 +00:00
|
|
|
- [ModelType](doc//ModelType.md)
|
2023-09-01 11:08:42 +00:00
|
|
|
- [OAuthAuthorizeResponseDto](doc//OAuthAuthorizeResponseDto.md)
|
2022-11-15 02:24:25 +00:00
|
|
|
- [OAuthCallbackDto](doc//OAuthCallbackDto.md)
|
|
|
|
|
- [OAuthConfigDto](doc//OAuthConfigDto.md)
|
|
|
|
|
- [OAuthConfigResponseDto](doc//OAuthConfigResponseDto.md)
|
2023-07-18 18:09:43 +00:00
|
|
|
- [PeopleResponseDto](doc//PeopleResponseDto.md)
|
2023-07-23 03:00:43 +00:00
|
|
|
- [PeopleUpdateDto](doc//PeopleUpdateDto.md)
|
|
|
|
|
- [PeopleUpdateItem](doc//PeopleUpdateItem.md)
|
2023-05-17 17:07:17 +00:00
|
|
|
- [PersonResponseDto](doc//PersonResponseDto.md)
|
|
|
|
|
- [PersonUpdateDto](doc//PersonUpdateDto.md)
|
2023-04-01 20:46:07 +00:00
|
|
|
- [QueueStatusDto](doc//QueueStatusDto.md)
|
2023-08-29 13:58:00 +00:00
|
|
|
- [RecognitionConfig](doc//RecognitionConfig.md)
|
2023-09-20 11:16:33 +00:00
|
|
|
- [ScanLibraryDto](doc//ScanLibraryDto.md)
|
2023-03-03 02:47:08 +00:00
|
|
|
- [SearchAlbumResponseDto](doc//SearchAlbumResponseDto.md)
|
2022-07-13 12:23:48 +00:00
|
|
|
- [SearchAssetDto](doc//SearchAssetDto.md)
|
2023-03-03 02:47:08 +00:00
|
|
|
- [SearchAssetResponseDto](doc//SearchAssetResponseDto.md)
|
2023-03-05 20:44:31 +00:00
|
|
|
- [SearchExploreItem](doc//SearchExploreItem.md)
|
|
|
|
|
- [SearchExploreResponseDto](doc//SearchExploreResponseDto.md)
|
2023-03-03 02:47:08 +00:00
|
|
|
- [SearchFacetCountResponseDto](doc//SearchFacetCountResponseDto.md)
|
|
|
|
|
- [SearchFacetResponseDto](doc//SearchFacetResponseDto.md)
|
|
|
|
|
- [SearchResponseDto](doc//SearchResponseDto.md)
|
2023-09-09 02:51:46 +00:00
|
|
|
- [ServerConfigDto](doc//ServerConfigDto.md)
|
2023-08-18 04:55:26 +00:00
|
|
|
- [ServerFeaturesDto](doc//ServerFeaturesDto.md)
|
2022-07-13 12:23:48 +00:00
|
|
|
- [ServerInfoResponseDto](doc//ServerInfoResponseDto.md)
|
2023-07-16 01:24:46 +00:00
|
|
|
- [ServerMediaTypesResponseDto](doc//ServerMediaTypesResponseDto.md)
|
2022-07-13 12:23:48 +00:00
|
|
|
- [ServerPingResponse](doc//ServerPingResponse.md)
|
2022-10-23 21:54:54 +00:00
|
|
|
- [ServerStatsResponseDto](doc//ServerStatsResponseDto.md)
|
2023-08-18 04:55:26 +00:00
|
|
|
- [ServerVersionResponseDto](doc//ServerVersionResponseDto.md)
|
2023-06-21 01:08:43 +00:00
|
|
|
- [SharedLinkCreateDto](doc//SharedLinkCreateDto.md)
|
|
|
|
|
- [SharedLinkEditDto](doc//SharedLinkEditDto.md)
|
2023-01-09 20:16:08 +00:00
|
|
|
- [SharedLinkResponseDto](doc//SharedLinkResponseDto.md)
|
|
|
|
|
- [SharedLinkType](doc//SharedLinkType.md)
|
2022-07-13 12:23:48 +00:00
|
|
|
- [SignUpDto](doc//SignUpDto.md)
|
|
|
|
|
- [SmartInfoResponseDto](doc//SmartInfoResponseDto.md)
|
2022-12-09 20:51:42 +00:00
|
|
|
- [SystemConfigDto](doc//SystemConfigDto.md)
|
|
|
|
|
- [SystemConfigFFmpegDto](doc//SystemConfigFFmpegDto.md)
|
2023-06-01 10:32:51 +00:00
|
|
|
- [SystemConfigJobDto](doc//SystemConfigJobDto.md)
|
2023-08-25 04:15:03 +00:00
|
|
|
- [SystemConfigMachineLearningDto](doc//SystemConfigMachineLearningDto.md)
|
2023-09-09 02:51:46 +00:00
|
|
|
- [SystemConfigMapDto](doc//SystemConfigMapDto.md)
|
2022-12-09 20:51:42 +00:00
|
|
|
- [SystemConfigOAuthDto](doc//SystemConfigOAuthDto.md)
|
2023-01-09 21:32:58 +00:00
|
|
|
- [SystemConfigPasswordLoginDto](doc//SystemConfigPasswordLoginDto.md)
|
2023-09-26 07:03:57 +00:00
|
|
|
- [SystemConfigReverseGeocodingDto](doc//SystemConfigReverseGeocodingDto.md)
|
2022-12-16 20:26:12 +00:00
|
|
|
- [SystemConfigStorageTemplateDto](doc//SystemConfigStorageTemplateDto.md)
|
|
|
|
|
- [SystemConfigTemplateStorageOptionDto](doc//SystemConfigTemplateStorageOptionDto.md)
|
2023-08-08 14:39:51 +00:00
|
|
|
- [SystemConfigThumbnailDto](doc//SystemConfigThumbnailDto.md)
|
2022-12-05 17:56:44 +00:00
|
|
|
- [TagResponseDto](doc//TagResponseDto.md)
|
|
|
|
|
- [TagTypeEnum](doc//TagTypeEnum.md)
|
2022-07-16 04:18:17 +00:00
|
|
|
- [ThumbnailFormat](doc//ThumbnailFormat.md)
|
2023-08-04 21:07:15 +00:00
|
|
|
- [TimeBucketResponseDto](doc//TimeBucketResponseDto.md)
|
|
|
|
|
- [TimeBucketSize](doc//TimeBucketSize.md)
|
2023-08-07 20:35:25 +00:00
|
|
|
- [ToneMapping](doc//ToneMapping.md)
|
2023-08-02 01:56:10 +00:00
|
|
|
- [TranscodeHWAccel](doc//TranscodeHWAccel.md)
|
2023-07-09 02:43:11 +00:00
|
|
|
- [TranscodePolicy](doc//TranscodePolicy.md)
|
2022-07-13 12:23:48 +00:00
|
|
|
- [UpdateAlbumDto](doc//UpdateAlbumDto.md)
|
2022-11-08 16:20:36 +00:00
|
|
|
- [UpdateAssetDto](doc//UpdateAssetDto.md)
|
2023-09-20 11:16:33 +00:00
|
|
|
- [UpdateLibraryDto](doc//UpdateLibraryDto.md)
|
2022-12-05 17:56:44 +00:00
|
|
|
- [UpdateTagDto](doc//UpdateTagDto.md)
|
2022-07-13 12:23:48 +00:00
|
|
|
- [UpdateUserDto](doc//UpdateUserDto.md)
|
2022-10-23 21:54:54 +00:00
|
|
|
- [UsageByUserDto](doc//UsageByUserDto.md)
|
2022-07-13 12:23:48 +00:00
|
|
|
- [UserCountResponseDto](doc//UserCountResponseDto.md)
|
|
|
|
|
- [UserResponseDto](doc//UserResponseDto.md)
|
|
|
|
|
- [ValidateAccessTokenResponseDto](doc//ValidateAccessTokenResponseDto.md)
|
2023-07-09 02:43:11 +00:00
|
|
|
- [VideoCodec](doc//VideoCodec.md)
|
2022-07-13 12:23:48 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Documentation For Authorization
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## bearer
|
|
|
|
|
|
|
|
|
|
- **Type**: HTTP Bearer authentication
|
|
|
|
|
|
2023-02-24 16:01:10 +00:00
|
|
|
## cookie
|
|
|
|
|
|
|
|
|
|
- **Type**: API key
|
|
|
|
|
- **API key parameter name**: immich_access_token
|
|
|
|
|
- **Location**:
|
|
|
|
|
|
2023-05-04 16:41:29 +00:00
|
|
|
## api_key
|
|
|
|
|
|
|
|
|
|
- **Type**: API key
|
|
|
|
|
- **API key parameter name**: x-api-key
|
|
|
|
|
- **Location**: HTTP header
|
|
|
|
|
|
2022-07-13 12:23:48 +00:00
|
|
|
|
|
|
|
|
## Author
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
