c-l/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2024-12-29 15:11:58 +00:00
Code Releases Activity

refactor(server): rename api tags to follow plural nomenclature of endpoints (#9872)

Browse source 
* rename api tags to follow plural nomenclature of endpoints

* chore: open api

* fix mobile
This commit is contained in:
Daniel Dietzler 2024-05-30 00:26:57 +02:00 committed by GitHub
parent 77d1b9ace6
commit 4376104e3a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
54 changed files with 187 additions and 187 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
mobile/lib/providers/authentication.provider.dart
View file

@ -138,7 +138,7 @@ class AuthenticationNotifier extends StateNotifier<AuthenticationState> {
Future<bool> changePassword(String newPassword) async {
try {
await _apiService.userApi.updateMyUser(
await _apiService.usersApi.updateMyUser(
UserUpdateMeDto(
password: newPassword,
),
@ -179,8 +179,8 @@ class AuthenticationNotifier extends StateNotifier<AuthenticationState> {
UserAdminResponseDto? userResponseDto;
UserPreferencesResponseDto? userPreferences;
try {
userResponseDto = await _apiService.userApi.getMyUser();
userPreferences = await _apiService.userApi.getMyPreferences();
userResponseDto = await _apiService.usersApi.getMyUser();
userPreferences = await _apiService.usersApi.getMyPreferences();
} on ApiException catch (error, stackTrace) {
_log.severe(
"Error getting user information from the server [API EXCEPTION]",

4
mobile/lib/providers/user.provider.dart
View file

@ -20,8 +20,8 @@ class CurrentUserProvider extends StateNotifier<User?> {
refresh() async {
try {
final user = await _apiService.userApi.getMyUser();
final userPreferences = await _apiService.userApi.getMyPreferences();
final user = await _apiService.usersApi.getMyUser();
final userPreferences = await _apiService.usersApi.getMyPreferences();
if (user != null) {
Store.put(
StoreKey.currentUser,

4
mobile/lib/routing/tab_navigation_observer.dart
View file

@ -57,9 +57,9 @@ class TabNavigationObserver extends AutoRouterObserver {
// Update user info
try {
final userResponseDto =
await ref.read(apiServiceProvider).userApi.getMyUser();
await ref.read(apiServiceProvider).usersApi.getMyUser();
final userPreferences =
await ref.read(apiServiceProvider).userApi.getMyPreferences();
await ref.read(apiServiceProvider).usersApi.getMyPreferences();
if (userResponseDto == null) {
return;

8
mobile/lib/services/activity.service.dart
View file

@ -19,7 +19,7 @@ class ActivityService with ErrorLoggerMixin {
}) async {
return logError(
() async {
final list = await _apiService.activityApi
final list = await _apiService.activitiesApi
.getActivities(albumId, assetId: assetId);
return list != null ? list.map(Activity.fromDto).toList() : [];
},
@ -31,7 +31,7 @@ class ActivityService with ErrorLoggerMixin {
Future<int> getStatistics(String albumId, {String? assetId}) async {
return logError(
() async {
final dto = await _apiService.activityApi
final dto = await _apiService.activitiesApi
.getActivityStatistics(albumId, assetId: assetId);
return dto?.comments ?? 0;
},
@ -43,7 +43,7 @@ class ActivityService with ErrorLoggerMixin {
Future<bool> removeActivity(String id) async {
return logError(
() async {
await _apiService.activityApi.deleteActivity(id);
await _apiService.activitiesApi.deleteActivity(id);
return true;
},
defaultValue: false,
@ -59,7 +59,7 @@ class ActivityService with ErrorLoggerMixin {
}) async {
return guardError(
() async {
final dto = await _apiService.activityApi.createActivity(
final dto = await _apiService.activitiesApi.createActivity(
ActivityCreateDto(
albumId: albumId,
type: type == ActivityType.comment

22
mobile/lib/services/album.service.dart
View file

@ -151,7 +151,7 @@ class AlbumService {
bool changes = false;
try {
await _userService.refreshUsers();
final List<AlbumResponseDto>? serverAlbums = await _apiService.albumApi
final List<AlbumResponseDto>? serverAlbums = await _apiService.albumsApi
.getAllAlbums(shared: isShared ? true : null);
if (serverAlbums == null) {
return false;
@ -161,7 +161,7 @@ class AlbumService {
isShared: isShared,
loadDetails: (dto) async => dto.assetCount == dto.assets.length
? dto
: (await _apiService.albumApi.getAlbumInfo(dto.id)) ?? dto,
: (await _apiService.albumsApi.getAlbumInfo(dto.id)) ?? dto,
);
} finally {
_remoteCompleter.complete(changes);
@ -176,7 +176,7 @@ class AlbumService {
Iterable<User> sharedUsers = const [],
]) async {
try {
AlbumResponseDto? remote = await _apiService.albumApi.createAlbum(
AlbumResponseDto? remote = await _apiService.albumsApi.createAlbum(
CreateAlbumDto(
albumName: albumName,
assetIds: assets.map((asset) => asset.remoteId!).toList(),
@ -231,7 +231,7 @@ class AlbumService {
Album album,
) async {
try {
var response = await _apiService.albumApi.addAssetsToAlbum(
var response = await _apiService.albumsApi.addAssetsToAlbum(
album.remoteId!,
BulkIdsDto(ids: assets.map((asset) => asset.remoteId!).toList()),
);
@ -290,7 +290,7 @@ class AlbumService {
.map((userId) => AlbumUserAddDto(userId: userId))
.toList();
final result = await _apiService.albumApi.addUsersToAlbum(
final result = await _apiService.albumsApi.addUsersToAlbum(
album.remoteId!,
AddUsersDto(albumUsers: albumUsers),
);
@ -312,7 +312,7 @@ class AlbumService {
Future<bool> setActivityEnabled(Album album, bool enabled) async {
try {
final result = await _apiService.albumApi.updateAlbumInfo(
final result = await _apiService.albumsApi.updateAlbumInfo(
album.remoteId!,
UpdateAlbumDto(isActivityEnabled: enabled),
);
@ -331,7 +331,7 @@ class AlbumService {
try {
final userId = Store.get(StoreKey.currentUser).isarId;
if (album.owner.value?.isarId == userId) {
await _apiService.albumApi.deleteAlbum(album.remoteId!);
await _apiService.albumsApi.deleteAlbum(album.remoteId!);
}
if (album.shared) {
final foreignAssets =
@ -362,7 +362,7 @@ class AlbumService {
Future<bool> leaveAlbum(Album album) async {
try {
await _apiService.albumApi.removeUserFromAlbum(album.remoteId!, "me");
await _apiService.albumsApi.removeUserFromAlbum(album.remoteId!, "me");
return true;
} catch (e) {
debugPrint("Error leaveAlbum ${e.toString()}");
@ -375,7 +375,7 @@ class AlbumService {
Iterable<Asset> assets,
) async {
try {
final response = await _apiService.albumApi.removeAssetFromAlbum(
final response = await _apiService.albumsApi.removeAssetFromAlbum(
album.remoteId!,
BulkIdsDto(
ids: assets.map((asset) => asset.remoteId!).toList(),
@ -401,7 +401,7 @@ class AlbumService {
User user,
) async {
try {
await _apiService.albumApi.removeUserFromAlbum(
await _apiService.albumsApi.removeUserFromAlbum(
album.remoteId!,
user.id,
);
@ -426,7 +426,7 @@ class AlbumService {
String newAlbumTitle,
) async {
try {
await _apiService.albumApi.updateAlbumInfo(
await _apiService.albumsApi.updateAlbumInfo(
album.remoteId!,
UpdateAlbumDto(
albumName: newAlbumTitle,

28
mobile/lib/services/api.service.dart
View file

@ -12,21 +12,21 @@ import 'package:http/http.dart';
class ApiService {
late ApiClient _apiClient;
late UserApi userApi;
late UsersApi usersApi;
late AuthenticationApi authenticationApi;
late OAuthApi oAuthApi;
late AlbumApi albumApi;
late AssetApi assetApi;
late AlbumsApi albumsApi;
late AssetsApi assetsApi;
late SearchApi searchApi;
late ServerInfoApi serverInfoApi;
late MapApi mapApi;
late PartnerApi partnerApi;
late PersonApi personApi;
late PartnersApi partnersApi;
late PeopleApi peopleApi;
late AuditApi auditApi;
late SharedLinkApi sharedLinkApi;
late SharedLinksApi sharedLinksApi;
late SyncApi syncApi;
late SystemConfigApi systemConfigApi;
late ActivityApi activityApi;
late ActivitiesApi activitiesApi;
late DownloadApi downloadApi;
late TrashApi trashApi;
@ -44,21 +44,21 @@ class ApiService {
if (_accessToken != null) {
setAccessToken(_accessToken!);
}
userApi = UserApi(_apiClient);
usersApi = UsersApi(_apiClient);
authenticationApi = AuthenticationApi(_apiClient);
oAuthApi = OAuthApi(_apiClient);
albumApi = AlbumApi(_apiClient);
assetApi = AssetApi(_apiClient);
albumsApi = AlbumsApi(_apiClient);
assetsApi = AssetsApi(_apiClient);
serverInfoApi = ServerInfoApi(_apiClient);
searchApi = SearchApi(_apiClient);
mapApi = MapApi(_apiClient);
partnerApi = PartnerApi(_apiClient);
personApi = PersonApi(_apiClient);
partnersApi = PartnersApi(_apiClient);
peopleApi = PeopleApi(_apiClient);
auditApi = AuditApi(_apiClient);
sharedLinkApi = SharedLinkApi(_apiClient);
sharedLinksApi = SharedLinksApi(_apiClient);
syncApi = SyncApi(_apiClient);
systemConfigApi = SystemConfigApi(_apiClient);
activityApi = ActivityApi(_apiClient);
activitiesApi = ActivitiesApi(_apiClient);
downloadApi = DownloadApi(_apiClient);
trashApi = TrashApi(_apiClient);
}

8
mobile/lib/services/asset.service.dart
View file

@ -82,7 +82,7 @@ class AssetService {
) async {
try {
final AssetResponseDto? dto =
await _apiService.assetApi.getAssetInfo(remoteId);
await _apiService.assetsApi.getAssetInfo(remoteId);
return dto?.people;
} catch (error, stack) {
@ -138,7 +138,7 @@ class AssetService {
payload.add(asset.remoteId!);
}
await _apiService.assetApi.deleteAssets(
await _apiService.assetsApi.deleteAssets(
AssetBulkDeleteDto(
ids: payload,
force: force,
@ -158,7 +158,7 @@ class AssetService {
// fileSize is always filled on the server but not set on client
if (a.exifInfo?.fileSize == null) {
if (a.isRemote) {
final dto = await _apiService.assetApi.getAssetInfo(a.remoteId!);
final dto = await _apiService.assetsApi.getAssetInfo(a.remoteId!);
if (dto != null && dto.exifInfo != null) {
final newExif = Asset.remote(dto).exifInfo!.copyWith(id: a.id);
if (newExif != a.exifInfo) {
@ -180,7 +180,7 @@ class AssetService {
List<Asset> assets,
UpdateAssetDto updateAssetDto,
) async {
return await _apiService.assetApi.updateAssets(
return await _apiService.assetsApi.updateAssets(
AssetBulkUpdateDto(
ids: assets.map((e) => e.remoteId!).toList(),
dateTimeOriginal: updateAssetDto.dateTimeOriginal,

4
mobile/lib/services/asset_description.service.dart
View file

@ -17,7 +17,7 @@ class AssetDescriptionService {
String remoteAssetId,
int localExifId,
) async {
final result = await _api.assetApi.updateAsset(
final result = await _api.assetsApi.updateAsset(
remoteAssetId,
UpdateAssetDto(description: description),
);
@ -36,7 +36,7 @@ class AssetDescriptionService {
Future<String> readLatest(String assetRemoteId, int localExifId) async {
final latestAssetFromServer =
await _api.assetApi.getAssetInfo(assetRemoteId);
await _api.assetsApi.getAssetInfo(assetRemoteId);
final localExifInfo = await _db.exifInfos.get(localExifId);
if (latestAssetFromServer != null && localExifInfo != null) {

6
mobile/lib/services/asset_stack.service.dart
View file

@ -27,7 +27,7 @@ class AssetStackService {
.map((e) => e.remoteId!)
.toList();
await _api.assetApi.updateAssets(
await _api.assetsApi.updateAssets(
AssetBulkUpdateDto(ids: toAdd, stackParentId: parentAsset.remoteId),
);
}
@ -37,7 +37,7 @@ class AssetStackService {
.where((e) => e.isRemote)
.map((e) => e.remoteId!)
.toList();
await _api.assetApi.updateAssets(
await _api.assetsApi.updateAssets(
AssetBulkUpdateDto(ids: toRemove, removeParent: true),
);
}
@ -53,7 +53,7 @@ class AssetStackService {
}
try {
await _api.assetApi.updateStackParent(
await _api.assetsApi.updateStackParent(
UpdateStackParentDto(
oldParentId: oldParent.remoteId!,
newParentId: newParent.remoteId!,

4
mobile/lib/services/backup.service.dart
View file

@ -44,7 +44,7 @@ class BackupService {
final String deviceId = Store.get(StoreKey.deviceId);
try {
return await _apiService.assetApi.getAllUserAssetsByDeviceId(deviceId);
return await _apiService.assetsApi.getAllUserAssetsByDeviceId(deviceId);
} catch (e) {
debugPrint('Error [getDeviceBackupAsset] ${e.toString()}');
return null;
@ -178,7 +178,7 @@ class BackupService {
try {
final String deviceId = Store.get(StoreKey.deviceId);
final CheckExistingAssetsResponseDto? duplicates =
await _apiService.assetApi.checkExistingAssets(
await _apiService.assetsApi.checkExistingAssets(
CheckExistingAssetsDto(
deviceAssetIds: candidates.map((e) => e.id).toList(),
deviceId: deviceId,

2
mobile/lib/services/backup_verification.service.dart
View file

@ -136,7 +136,7 @@ class BackupVerificationService {
ExifInfo? exif = remote.exifInfo;
if (exif != null && exif.lat != null) return false;
if (exif == null || exif.fileSize == null) {
final dto = await apiService.assetApi.getAssetInfo(remote.remoteId!);
final dto = await apiService.assetsApi.getAssetInfo(remote.remoteId!);
if (dto != null && dto.exifInfo != null) {
exif = ExifInfo.fromDto(dto.exifInfo!);
}

2
mobile/lib/services/memory.service.dart
View file

@ -28,7 +28,7 @@ class MemoryService {
Future<List<Memory>?> getMemoryLane() async {
try {
final now = DateTime.now();
final data = await _apiService.assetApi.getMemoryLane(
final data = await _apiService.assetsApi.getMemoryLane(
now.day,
now.month,
);

8
mobile/lib/services/partner.service.dart
View file

@ -35,7 +35,7 @@ class PartnerService {
Future<List<User>?> getPartners(PartnerDirection direction) async {
try {
final userDtos =
await _apiService.partnerApi.getPartners(direction._value);
await _apiService.partnersApi.getPartners(direction._value);
if (userDtos != null) {
return userDtos.map((u) => User.fromPartnerDto(u)).toList();
}
@ -47,7 +47,7 @@ class PartnerService {
Future<bool> removePartner(User partner) async {
try {
await _apiService.partnerApi.removePartner(partner.id);
await _apiService.partnersApi.removePartner(partner.id);
partner.isPartnerSharedBy = false;
await _db.writeTxn(() => _db.users.put(partner));
} catch (e) {
@ -59,7 +59,7 @@ class PartnerService {
Future<bool> addPartner(User partner) async {
try {
final dto = await _apiService.partnerApi.createPartner(partner.id);
final dto = await _apiService.partnersApi.createPartner(partner.id);
if (dto != null) {
partner.isPartnerSharedBy = true;
await _db.writeTxn(() => _db.users.put(partner));
@ -73,7 +73,7 @@ class PartnerService {
Future<bool> updatePartner(User partner, {required bool inTimeline}) async {
try {
final dto = await _apiService.partnerApi
final dto = await _apiService.partnersApi
.updatePartner(partner.id, UpdatePartnerDto(inTimeline: inTimeline));
if (dto != null) {
partner.inTimeline = dto.inTimeline ?? partner.inTimeline;

6
mobile/lib/services/person.service.dart
View file

@ -22,7 +22,7 @@ class PersonService {
Future<List<PersonResponseDto>> getAllPeople() async {
try {
final peopleResponseDto = await _apiService.personApi.getAllPeople();
final peopleResponseDto = await _apiService.peopleApi.getAllPeople();
return peopleResponseDto?.people ?? [];
} catch (error, stack) {
_log.severe("Error while fetching curated people", error, stack);
@ -32,7 +32,7 @@ class PersonService {
Future<List<Asset>?> getPersonAssets(String id) async {
try {
final assets = await _apiService.personApi.getPersonAssets(id);
final assets = await _apiService.peopleApi.getPersonAssets(id);
if (assets == null) return null;
return await _db.assets.getAllByRemoteId(assets.map((e) => e.id));
} catch (error, stack) {
@ -43,7 +43,7 @@ class PersonService {
Future<PersonResponseDto?> updateName(String id, String name) async {
try {
return await _apiService.personApi.updatePerson(
return await _apiService.peopleApi.updatePerson(
id,
PersonUpdateDto(
name: name,

8
mobile/lib/services/shared_link.service.dart
View file

@ -17,7 +17,7 @@ class SharedLinkService {
Future<AsyncValue<List<SharedLink>>> getAllSharedLinks() async {
try {
final list = await _apiService.sharedLinkApi.getAllSharedLinks();
final list = await _apiService.sharedLinksApi.getAllSharedLinks();
return list != null
? AsyncData(list.map(SharedLink.fromDto).toList())
: const AsyncData([]);
@ -29,7 +29,7 @@ class SharedLinkService {
Future<void> deleteSharedLink(String id) async {
try {
return await _apiService.sharedLinkApi.removeSharedLink(id);
return await _apiService.sharedLinksApi.removeSharedLink(id);
} catch (e) {
_log.severe("Failed to delete shared link id - $id", e);
}
@ -75,7 +75,7 @@ class SharedLinkService {
if (dto != null) {
final responseDto =
await _apiService.sharedLinkApi.createSharedLink(dto);
await _apiService.sharedLinksApi.createSharedLink(dto);
if (responseDto != null) {
return SharedLink.fromDto(responseDto);
}
@ -97,7 +97,7 @@ class SharedLinkService {
DateTime? expiresAt,
}) async {
try {
final responseDto = await _apiService.sharedLinkApi.updateSharedLink(
final responseDto = await _apiService.sharedLinksApi.updateSharedLink(
id,
SharedLinkEditDto(
showMetadata: showMeta,

4
mobile/lib/services/user.service.dart
View file

@ -39,7 +39,7 @@ class UserService {
Future<List<User>?> _getAllUsers() async {
try {
final dto = await _apiService.userApi.searchUsers();
final dto = await _apiService.usersApi.searchUsers();
return dto?.map(User.fromSimpleUserDto).toList();
} catch (e) {
_log.warning("Failed get all users", e);
@ -57,7 +57,7 @@ class UserService {
Future<CreateProfileImageResponseDto?> uploadProfileImage(XFile image) async {
try {
return await _apiService.userApi.createProfileImage(
return await _apiService.usersApi.createProfileImage(
MultipartFile.fromBytes(
'file',
await image.readAsBytes(),

BIN
mobile/openapi/README.md generated
View file

Binary file not shown.

BIN
mobile/openapi/lib/api.dart generated
View file

Binary file not shown.

BIN
mobile/openapi/lib/api/activity_api.dart → mobile/openapi/lib/api/activities_api.dart generated
View file

Binary file not shown.

BIN
mobile/openapi/lib/api/album_api.dart → mobile/openapi/lib/api/albums_api.dart generated
View file

Binary file not shown.

BIN
mobile/openapi/lib/api/api_key_api.dart → mobile/openapi/lib/api/api_keys_api.dart generated
View file

Binary file not shown.

BIN
mobile/openapi/lib/api/asset_api.dart → mobile/openapi/lib/api/assets_api.dart generated
View file

Binary file not shown.

BIN
mobile/openapi/lib/api/duplicate_api.dart → mobile/openapi/lib/api/duplicates_api.dart generated
View file

Binary file not shown.

BIN
mobile/openapi/lib/api/face_api.dart → mobile/openapi/lib/api/faces_api.dart generated
View file

Binary file not shown.

BIN
mobile/openapi/lib/api/file_report_api.dart → mobile/openapi/lib/api/file_reports_api.dart generated
View file

Binary file not shown.

BIN
mobile/openapi/lib/api/job_api.dart → mobile/openapi/lib/api/jobs_api.dart generated
View file

Binary file not shown.

BIN
mobile/openapi/lib/api/library_api.dart → mobile/openapi/lib/api/libraries_api.dart generated
View file

Binary file not shown.

BIN
mobile/openapi/lib/api/memory_api.dart → mobile/openapi/lib/api/memories_api.dart generated
View file

Binary file not shown.

BIN
mobile/openapi/lib/api/partner_api.dart → mobile/openapi/lib/api/partners_api.dart generated
View file

Binary file not shown.

BIN
mobile/openapi/lib/api/person_api.dart → mobile/openapi/lib/api/people_api.dart generated
View file

Binary file not shown.

BIN
mobile/openapi/lib/api/shared_link_api.dart → mobile/openapi/lib/api/shared_links_api.dart generated
View file

Binary file not shown.

BIN
mobile/openapi/lib/api/tag_api.dart → mobile/openapi/lib/api/tags_api.dart generated
View file

Binary file not shown.

BIN
mobile/openapi/lib/api/user_api.dart generated
View file

Binary file not shown.

BIN
mobile/openapi/lib/api/users_admin_api.dart generated Normal file
View file

Binary file not shown.

BIN
mobile/openapi/lib/api/users_api.dart generated Normal file
View file

Binary file not shown.

214
open-api/immich-openapi-specs.json
View file

@ -76,7 +76,7 @@
}
],
"tags": [
"Activity"
"Activities"
]
},
"post": {
@ -116,7 +116,7 @@
}
],
"tags": [
"Activity"
"Activities"
]
}
},
@ -167,7 +167,7 @@
}
],
"tags": [
"Activity"
"Activities"
]
}
},
@ -202,7 +202,7 @@
}
],
"tags": [
"Activity"
"Activities"
]
}
},
@ -246,7 +246,7 @@
}
],
"tags": [
"User"
"Users (admin)"
]
},
"post": {
@ -286,7 +286,7 @@
}
],
"tags": [
"User"
"Users (admin)"
]
}
},
@ -338,7 +338,7 @@
}
],
"tags": [
"User"
"Users (admin)"
]
},
"get": {
@ -378,7 +378,7 @@
}
],
"tags": [
"User"
"Users (admin)"
]
},
"put": {
@ -428,7 +428,7 @@
}
],
"tags": [
"User"
"Users (admin)"
]
}
},
@ -470,7 +470,7 @@
}
],
"tags": [
"User"
"Users (admin)"
]
},
"put": {
@ -520,7 +520,7 @@
}
],
"tags": [
"User"
"Users (admin)"
]
}
},
@ -562,7 +562,7 @@
}
],
"tags": [
"User"
"Users (admin)"
]
}
},
@ -616,7 +616,7 @@
}
],
"tags": [
"Album"
"Albums"
]
},
"post": {
@ -656,7 +656,7 @@
}
],
"tags": [
"Album"
"Albums"
]
}
},
@ -688,7 +688,7 @@
}
],
"tags": [
"Album"
"Albums"
]
}
},
@ -723,7 +723,7 @@
}
],
"tags": [
"Album"
"Albums"
]
},
"get": {
@ -779,7 +779,7 @@
}
],
"tags": [
"Album"
"Albums"
]
},
"patch": {
@ -829,7 +829,7 @@
}
],
"tags": [
"Album"
"Albums"
]
}
},
@ -884,7 +884,7 @@
}
],
"tags": [
"Album"
"Albums"
]
},
"put": {
@ -945,7 +945,7 @@
}
],
"tags": [
"Album"
"Albums"
]
}
},
@ -988,7 +988,7 @@
}
],
"tags": [
"Album"
"Albums"
]
},
"put": {
@ -1039,7 +1039,7 @@
}
],
"tags": [
"Album"
"Albums"
]
}
},
@ -1091,7 +1091,7 @@
}
],
"tags": [
"Album"
"Albums"
]
}
},
@ -1126,7 +1126,7 @@
}
],
"tags": [
"API Key"
"API Keys"
]
},
"post": {
@ -1166,7 +1166,7 @@
}
],
"tags": [
"API Key"
"API Keys"
]
}
},
@ -1201,7 +1201,7 @@
}
],
"tags": [
"API Key"
"API Keys"
]
},
"get": {
@ -1241,7 +1241,7 @@
}
],
"tags": [
"API Key"
"API Keys"
]
},
"put": {
@ -1291,7 +1291,7 @@
}
],
"tags": [
"API Key"
"API Keys"
]
}
},
@ -1326,7 +1326,7 @@
}
],
"tags": [
"Asset"
"Assets"
]
},
"put": {
@ -1359,7 +1359,7 @@
}
],
"tags": [
"Asset"
"Assets"
]
}
},
@ -1402,7 +1402,7 @@
}
],
"tags": [
"Asset"
"Assets"
]
}
},
@ -1447,7 +1447,7 @@
}
],
"tags": [
"Asset"
"Assets"
]
}
},
@ -1490,7 +1490,7 @@
}
],
"tags": [
"Asset"
"Assets"
]
}
},
@ -1559,7 +1559,7 @@
}
],
"tags": [
"Asset"
"Assets"
]
}
},
@ -1594,7 +1594,7 @@
}
],
"tags": [
"Asset"
"Assets"
]
}
},
@ -1650,7 +1650,7 @@
}
],
"tags": [
"Asset"
"Assets"
]
}
},
@ -1695,7 +1695,7 @@
}
],
"tags": [
"Asset"
"Assets"
]
}
},
@ -1730,7 +1730,7 @@
}
],
"tags": [
"Asset"
"Assets"
]
}
},
@ -1787,7 +1787,7 @@
}
],
"tags": [
"Asset"
"Assets"
]
}
},
@ -1846,7 +1846,7 @@
}
],
"tags": [
"Asset"
"Assets"
]
}
},
@ -1907,7 +1907,7 @@
}
],
"tags": [
"Asset"
"Assets"
]
}
},
@ -1957,7 +1957,7 @@
}
],
"tags": [
"Asset"
"Assets"
]
},
"put": {
@ -2007,7 +2007,7 @@
}
],
"tags": [
"Asset"
"Assets"
]
}
},
@ -2068,7 +2068,7 @@
}
],
"tags": [
"Asset"
"Assets"
],
"x-immich-lifecycle": {
"addedAt": "v1.106.0"
@ -2487,7 +2487,7 @@
}
],
"tags": [
"Duplicate"
"Duplicates"
]
}
},
@ -2532,7 +2532,7 @@
}
],
"tags": [
"Face"
"Faces"
]
}
},
@ -2584,7 +2584,7 @@
}
],
"tags": [
"Face"
"Faces"
]
}
},
@ -2616,7 +2616,7 @@
}
],
"tags": [
"Job"
"Jobs"
]
}
},
@ -2667,7 +2667,7 @@
}
],
"tags": [
"Job"
"Jobs"
]
}
},
@ -2702,7 +2702,7 @@
}
],
"tags": [
"Library"
"Libraries"
]
},
"post": {
@ -2742,7 +2742,7 @@
}
],
"tags": [
"Library"
"Libraries"
]
}
},
@ -2777,7 +2777,7 @@
}
],
"tags": [
"Library"
"Libraries"
]
},
"get": {
@ -2817,7 +2817,7 @@
}
],
"tags": [
"Library"
"Libraries"
]
},
"put": {
@ -2867,7 +2867,7 @@
}
],
"tags": [
"Library"
"Libraries"
]
}
},
@ -2902,7 +2902,7 @@
}
],
"tags": [
"Library"
"Libraries"
]
}
},
@ -2947,7 +2947,7 @@
}
],
"tags": [
"Library"
"Libraries"
]
}
},
@ -2989,7 +2989,7 @@
}
],
"tags": [
"Library"
"Libraries"
]
}
},
@ -3041,7 +3041,7 @@
}
],
"tags": [
"Library"
"Libraries"
]
}
},
@ -3211,7 +3211,7 @@
}
],
"tags": [
"Memory"
"Memories"
]
},
"post": {
@ -3251,7 +3251,7 @@
}
],
"tags": [
"Memory"
"Memories"
]
}
},
@ -3286,7 +3286,7 @@
}
],
"tags": [
"Memory"
"Memories"
]
},
"get": {
@ -3326,7 +3326,7 @@
}
],
"tags": [
"Memory"
"Memories"
]
},
"put": {
@ -3376,7 +3376,7 @@
}
],
"tags": [
"Memory"
"Memories"
]
}
},
@ -3431,7 +3431,7 @@
}
],
"tags": [
"Memory"
"Memories"
]
},
"put": {
@ -3484,7 +3484,7 @@
}
],
"tags": [
"Memory"
"Memories"
]
}
},
@ -3682,7 +3682,7 @@
}
],
"tags": [
"Partner"
"Partners"
]
}
},
@ -3717,7 +3717,7 @@
}
],
"tags": [
"Partner"
"Partners"
]
},
"post": {
@ -3757,7 +3757,7 @@
}
],
"tags": [
"Partner"
"Partners"
]
},
"put": {
@ -3807,7 +3807,7 @@
}
],
"tags": [
"Partner"
"Partners"
]
}
},
@ -3848,7 +3848,7 @@
}
],
"tags": [
"Person"
"People"
]
},
"post": {
@ -3888,7 +3888,7 @@
}
],
"tags": [
"Person"
"People"
]
},
"put": {
@ -3931,7 +3931,7 @@
}
],
"tags": [
"Person"
"People"
]
}
},
@ -3973,7 +3973,7 @@
}
],
"tags": [
"Person"
"People"
]
},
"put": {
@ -4023,7 +4023,7 @@
}
],
"tags": [
"Person"
"People"
]
}
},
@ -4068,7 +4068,7 @@
}
],
"tags": [
"Person"
"People"
]
}
},
@ -4123,7 +4123,7 @@
}
],
"tags": [
"Person"
"People"
]
}
},
@ -4178,7 +4178,7 @@
}
],
"tags": [
"Person"
"People"
]
}
},
@ -4220,7 +4220,7 @@
}
],
"tags": [
"Person"
"People"
]
}
},
@ -4263,7 +4263,7 @@
}
],
"tags": [
"Person"
"People"
]
}
},
@ -4295,7 +4295,7 @@
}
],
"tags": [
"File Report"
"File Reports"
]
}
},
@ -4340,7 +4340,7 @@
}
],
"tags": [
"File Report"
"File Reports"
]
}
},
@ -4375,7 +4375,7 @@
}
],
"tags": [
"File Report"
"File Reports"
]
}
},
@ -5019,7 +5019,7 @@
}
],
"tags": [
"Shared Link"
"Shared Links"
]
},
"post": {
@ -5059,7 +5059,7 @@
}
],
"tags": [
"Shared Link"
"Shared Links"
]
}
},
@ -5117,7 +5117,7 @@
}
],
"tags": [
"Shared Link"
"Shared Links"
]
}
},
@ -5152,7 +5152,7 @@
}
],
"tags": [
"Shared Link"
"Shared Links"
]
},
"get": {
@ -5192,7 +5192,7 @@
}
],
"tags": [
"Shared Link"
"Shared Links"
]
},
"patch": {
@ -5242,7 +5242,7 @@
}
],
"tags": [
"Shared Link"
"Shared Links"
]
}
},
@ -5305,7 +5305,7 @@
}
],
"tags": [
"Shared Link"
"Shared Links"
]
},
"put": {
@ -5366,7 +5366,7 @@
}
],
"tags": [
"Shared Link"
"Shared Links"
]
}
},
@ -5721,7 +5721,7 @@
}
],
"tags": [
"Tag"
"Tags"
]
},
"post": {
@ -5761,7 +5761,7 @@
}
],
"tags": [
"Tag"
"Tags"
]
}
},
@ -5796,7 +5796,7 @@
}
],
"tags": [
"Tag"
"Tags"
]
},
"get": {
@ -5836,7 +5836,7 @@
}
],
"tags": [
"Tag"
"Tags"
]
},
"patch": {
@ -5886,7 +5886,7 @@
}
],
"tags": [
"Tag"
"Tags"
]
}
},
@ -5941,7 +5941,7 @@
}
],
"tags": [
"Tag"
"Tags"
]
},
"get": {
@ -5984,7 +5984,7 @@
}
],
"tags": [
"Tag"
"Tags"
]
},
"put": {
@ -6037,7 +6037,7 @@
}
],
"tags": [
"Tag"
"Tags"
]
}
},
@ -6419,7 +6419,7 @@
}
],
"tags": [
"User"
"Users"
]
}
},
@ -6451,7 +6451,7 @@
}
],
"tags": [
"User"
"Users"
]
},
"put": {
@ -6491,7 +6491,7 @@
}
],
"tags": [
"User"
"Users"
]
}
},
@ -6523,7 +6523,7 @@
}
],
"tags": [
"User"
"Users"
]
},
"put": {
@ -6563,7 +6563,7 @@
}
],
"tags": [
"User"
"Users"
]
}
},
@ -6588,7 +6588,7 @@
}
],
"tags": [
"User"
"Users"
]
},
"post": {
@ -6629,7 +6629,7 @@
}
],
"tags": [
"User"
"Users"
]
}
},
@ -6671,7 +6671,7 @@
}
],
"tags": [
"User"
"Users"
]
}
},
@ -6714,7 +6714,7 @@
}
],
"tags": [
"User"
"Users"
]
}
}

2
server/src/controllers/activity.controller.ts
View file

@ -13,7 +13,7 @@ import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { ActivityService } from 'src/services/activity.service';
import { UUIDParamDto } from 'src/validation';
@ApiTags('Activity')
@ApiTags('Activities')
@Controller('activities')
export class ActivityController {
constructor(private service: ActivityService) {}

2
server/src/controllers/album.controller.ts
View file

@ -16,7 +16,7 @@ import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { AlbumService } from 'src/services/album.service';
import { ParseMeUUIDPipe, UUIDParamDto } from 'src/validation';
@ApiTags('Album')
@ApiTags('Albums')
@Controller('albums')
export class AlbumController {
constructor(private service: AlbumService) {}

2
server/src/controllers/api-key.controller.ts
View file

@ -6,7 +6,7 @@ import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { APIKeyService } from 'src/services/api-key.service';
import { UUIDParamDto } from 'src/validation';
@ApiTags('API Key')
@ApiTags('API Keys')
@Controller('api-keys')
export class APIKeyController {
constructor(private service: APIKeyService) {}

2
server/src/controllers/asset-media.controller.ts
View file

@ -34,7 +34,7 @@ import { FileUploadInterceptor, Route, UploadFiles, getFiles } from 'src/middlew
import { AssetMediaService } from 'src/services/asset-media.service';
import { FileNotEmptyValidator, UUIDParamDto } from 'src/validation';
@ApiTags('Asset')
@ApiTags('Assets')
@Controller(Route.ASSET)
export class AssetMediaController {
constructor(

2
server/src/controllers/asset-v1.controller.ts
View file

@ -26,7 +26,7 @@ import { AssetServiceV1 } from 'src/services/asset-v1.service';
import { sendFile } from 'src/utils/file';
import { FileNotEmptyValidator, UUIDParamDto } from 'src/validation';
@ApiTags('Asset')
@ApiTags('Assets')
@Controller(Route.ASSET)
export class AssetControllerV1 {
constructor(

2
server/src/controllers/asset.controller.ts
View file

@ -19,7 +19,7 @@ import { Route } from 'src/middleware/file-upload.interceptor';
import { AssetService } from 'src/services/asset.service';
import { UUIDParamDto } from 'src/validation';
@ApiTags('Asset')
@ApiTags('Assets')
@Controller(Route.ASSET)
export class AssetController {
constructor(private service: AssetService) {}

2
server/src/controllers/duplicate.controller.ts
View file

@ -5,7 +5,7 @@ import { DuplicateResponseDto } from 'src/dtos/duplicate.dto';
import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { DuplicateService } from 'src/services/duplicate.service';
@ApiTags('Duplicate')
@ApiTags('Duplicates')
@Controller('duplicates')
export class DuplicateController {
constructor(private service: DuplicateService) {}

2
server/src/controllers/face.controller.ts
View file

@ -6,7 +6,7 @@ import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { PersonService } from 'src/services/person.service';
import { UUIDParamDto } from 'src/validation';
@ApiTags('Face')
@ApiTags('Faces')
@Controller('faces')
export class FaceController {
constructor(private service: PersonService) {}

2
server/src/controllers/file-report.controller.ts
View file

@ -4,7 +4,7 @@ import { FileChecksumDto, FileChecksumResponseDto, FileReportDto, FileReportFixD
import { Authenticated } from 'src/middleware/auth.guard';
import { AuditService } from 'src/services/audit.service';
@ApiTags('File Report')
@ApiTags('File Reports')
@Controller('reports')
export class ReportController {
constructor(private service: AuditService) {}

2
server/src/controllers/job.controller.ts
View file

@ -4,7 +4,7 @@ import { AllJobStatusResponseDto, JobCommandDto, JobIdParamDto, JobStatusDto } f
import { Authenticated } from 'src/middleware/auth.guard';
import { JobService } from 'src/services/job.service';
@ApiTags('Job')
@ApiTags('Jobs')
@Controller('jobs')
export class JobController {
constructor(private service: JobService) {}

2
server/src/controllers/library.controller.ts
View file

@ -13,7 +13,7 @@ import { Authenticated } from 'src/middleware/auth.guard';
import { LibraryService } from 'src/services/library.service';
import { UUIDParamDto } from 'src/validation';
@ApiTags('Library')
@ApiTags('Libraries')
@Controller('libraries')
export class LibraryController {
constructor(private service: LibraryService) {}

2
server/src/controllers/memory.controller.ts
View file

@ -7,7 +7,7 @@ import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { MemoryService } from 'src/services/memory.service';
import { UUIDParamDto } from 'src/validation';
@ApiTags('Memory')
@ApiTags('Memories')
@Controller('memories')
export class MemoryController {
constructor(private service: MemoryService) {}

2
server/src/controllers/partner.controller.ts
View file

@ -7,7 +7,7 @@ import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { PartnerService } from 'src/services/partner.service';
import { UUIDParamDto } from 'src/validation';
@ApiTags('Partner')
@ApiTags('Partners')
@Controller('partners')
export class PartnerController {
constructor(private service: PartnerService) {}

2
server/src/controllers/person.controller.ts
View file

@ -21,7 +21,7 @@ import { PersonService } from 'src/services/person.service';
import { sendFile } from 'src/utils/file';
import { UUIDParamDto } from 'src/validation';
@ApiTags('Person')
@ApiTags('People')
@Controller('people')
export class PersonController {
constructor(

2
server/src/controllers/shared-link.controller.ts
View file

@ -16,7 +16,7 @@ import { SharedLinkService } from 'src/services/shared-link.service';
import { respondWithCookie } from 'src/utils/response';
import { UUIDParamDto } from 'src/validation';
@ApiTags('Shared Link')
@ApiTags('Shared Links')
@Controller('shared-links')
export class SharedLinkController {
constructor(private service: SharedLinkService) {}

2
server/src/controllers/tag.controller.ts
View file

@ -9,7 +9,7 @@ import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { TagService } from 'src/services/tag.service';
import { UUIDParamDto } from 'src/validation';
@ApiTags('Tag')
@ApiTags('Tags')
@Controller('tags')
export class TagController {
constructor(private service: TagService) {}

2
server/src/controllers/user-admin.controller.ts
View file

@ -13,7 +13,7 @@ import { Auth, Authenticated } from 'src/middleware/auth.guard';
import { UserAdminService } from 'src/services/user-admin.service';
import { UUIDParamDto } from 'src/validation';
@ApiTags('User')
@ApiTags('Users (admin)')
@Controller('admin/users')
export class UserAdminController {
constructor(private service: UserAdminService) {}

2
server/src/controllers/user.controller.ts
View file

@ -27,7 +27,7 @@ import { UserService } from 'src/services/user.service';
import { sendFile } from 'src/utils/file';
import { UUIDParamDto } from 'src/validation';
@ApiTags('User')
@ApiTags('Users')
@Controller(Route.USER)
export class UserController {
constructor(