2022-12-05 19:56:44 +02:00
{
"openapi" : "3.0.0" ,
"paths" : {
2024-05-22 19:24:57 +02:00
"/activities" : {
2023-11-01 05:13:34 +02:00
"get" : {
"operationId" : "getActivities" ,
"parameters" : [
{
"name" : "albumId" ,
"required" : true ,
"in" : "query" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
{
"name" : "assetId" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
{
2024-01-22 18:49:51 +02:00
"name" : "level" ,
2023-11-01 05:13:34 +02:00
"required" : false ,
"in" : "query" ,
"schema" : {
2024-01-22 18:49:51 +02:00
"$ref" : "#/components/schemas/ReactionLevel"
2023-11-01 05:13:34 +02:00
}
2023-11-01 17:49:12 +02:00
} ,
2023-11-10 04:32:31 +02:00
{
2024-01-22 18:49:51 +02:00
"name" : "type" ,
2023-11-10 04:32:31 +02:00
"required" : false ,
"in" : "query" ,
"schema" : {
2024-01-22 18:49:51 +02:00
"$ref" : "#/components/schemas/ReactionType"
2023-11-10 04:32:31 +02:00
}
} ,
2023-11-01 17:49:12 +02:00
{
"name" : "userId" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
2023-11-01 05:13:34 +02:00
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/ActivityResponseDto"
} ,
"type" : "array"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Activities"
2023-11-01 05:13:34 +02:00
]
} ,
"post" : {
"operationId" : "createActivity" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ActivityCreateDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ActivityResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Activities"
2023-11-01 05:13:34 +02:00
]
}
} ,
2024-05-22 19:24:57 +02:00
"/activities/statistics" : {
2023-11-01 05:13:34 +02:00
"get" : {
"operationId" : "getActivityStatistics" ,
"parameters" : [
{
"name" : "albumId" ,
"required" : true ,
"in" : "query" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
{
"name" : "assetId" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ActivityStatisticsResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Activities"
2023-11-01 05:13:34 +02:00
]
}
} ,
2024-05-22 19:24:57 +02:00
"/activities/{id}" : {
2023-11-01 05:13:34 +02:00
"delete" : {
"operationId" : "deleteActivity" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"responses" : {
"204" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Activities"
2023-11-01 05:13:34 +02:00
]
}
} ,
2024-05-27 00:15:52 +02:00
"/admin/users" : {
"get" : {
"operationId" : "searchUsersAdmin" ,
"parameters" : [
{
"name" : "withDeleted" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/UserAdminResponseDto"
} ,
"type" : "array"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Users (admin)"
2024-05-27 00:15:52 +02:00
]
} ,
"post" : {
"operationId" : "createUserAdmin" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UserAdminCreateDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UserAdminResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Users (admin)"
2024-05-27 00:15:52 +02:00
]
}
} ,
"/admin/users/{id}" : {
"delete" : {
"operationId" : "deleteUserAdmin" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UserAdminDeleteDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UserAdminResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Users (admin)"
2024-05-27 00:15:52 +02:00
]
} ,
"get" : {
"operationId" : "getUserAdmin" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UserAdminResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Users (admin)"
2024-05-27 00:15:52 +02:00
]
} ,
"put" : {
"operationId" : "updateUserAdmin" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UserAdminUpdateDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UserAdminResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Users (admin)"
2024-05-27 00:15:52 +02:00
]
}
} ,
2024-05-28 04:16:53 +02:00
"/admin/users/{id}/preferences" : {
"get" : {
"operationId" : "getUserPreferencesAdmin" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UserPreferencesResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Users (admin)"
2024-05-28 04:16:53 +02:00
]
} ,
"put" : {
"operationId" : "updateUserPreferencesAdmin" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UserPreferencesUpdateDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UserPreferencesResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Users (admin)"
2024-05-28 04:16:53 +02:00
]
}
} ,
2024-05-27 00:15:52 +02:00
"/admin/users/{id}/restore" : {
"post" : {
"operationId" : "restoreUserAdmin" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UserAdminResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Users (admin)"
2024-05-27 00:15:52 +02:00
]
}
} ,
2024-05-22 19:24:57 +02:00
"/albums" : {
2023-03-26 04:46:48 +02:00
"get" : {
"operationId" : "getAllAlbums" ,
"parameters" : [
{
2024-01-22 18:49:51 +02:00
"name" : "assetId" ,
2023-03-26 04:46:48 +02:00
"required" : false ,
"in" : "query" ,
2024-01-22 18:49:51 +02:00
"description" : "Only returns albums that contain the asset\nIgnores the shared parameter\nundefined: get all albums" ,
2023-03-26 04:46:48 +02:00
"schema" : {
2024-01-22 18:49:51 +02:00
"format" : "uuid" ,
"type" : "string"
2023-03-26 04:46:48 +02:00
}
} ,
{
2024-01-22 18:49:51 +02:00
"name" : "shared" ,
2023-03-26 04:46:48 +02:00
"required" : false ,
"in" : "query" ,
"schema" : {
2024-01-22 18:49:51 +02:00
"type" : "boolean"
2023-03-26 04:46:48 +02:00
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/AlbumResponseDto"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-03-26 04:46:48 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-03-26 04:46:48 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2023-03-26 04:46:48 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Albums"
2023-03-26 04:46:48 +02:00
]
} ,
"post" : {
"operationId" : "createAlbum" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateAlbumDto"
}
}
2023-08-01 18:49:18 +02:00
} ,
"required" : true
2023-03-26 04:46:48 +02:00
} ,
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AlbumResponseDto"
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-03-26 04:46:48 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2023-03-26 04:46:48 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Albums"
2023-03-26 04:46:48 +02:00
]
}
} ,
2024-05-22 19:24:57 +02:00
"/albums/count" : {
2023-06-10 06:14:18 +02:00
"get" : {
2023-06-16 17:48:48 +02:00
"operationId" : "getAlbumCount" ,
2023-06-10 06:14:18 +02:00
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AlbumCountResponseDto"
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-06-10 06:14:18 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Albums"
2023-06-10 06:14:18 +02:00
]
}
} ,
2024-05-22 19:24:57 +02:00
"/albums/{id}" : {
2023-08-01 18:49:18 +02:00
"delete" : {
"operationId" : "deleteAlbum" ,
2023-05-25 21:37:19 +02:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
2023-08-01 18:49:18 +02:00
"description" : ""
2023-05-25 21:37:19 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Albums"
2023-05-25 21:37:19 +02:00
]
} ,
2023-08-01 18:49:18 +02:00
"get" : {
"operationId" : "getAlbumInfo" ,
2023-05-25 21:37:19 +02:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
2023-08-01 18:49:18 +02:00
} ,
2023-08-11 18:00:51 +02:00
{
2024-01-22 18:49:51 +02:00
"name" : "key" ,
2023-08-11 18:00:51 +02:00
"required" : false ,
"in" : "query" ,
"schema" : {
2024-01-22 18:49:51 +02:00
"type" : "string"
2023-08-11 18:00:51 +02:00
}
} ,
2023-08-01 18:49:18 +02:00
{
2024-01-22 18:49:51 +02:00
"name" : "withoutAssets" ,
2023-08-01 18:49:18 +02:00
"required" : false ,
"in" : "query" ,
"schema" : {
2024-01-22 18:49:51 +02:00
"type" : "boolean"
2023-08-01 18:49:18 +02:00
}
2023-05-25 21:37:19 +02:00
}
] ,
"responses" : {
"200" : {
2023-08-01 18:49:18 +02:00
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AlbumResponseDto"
}
}
} ,
2023-05-26 15:04:09 +02:00
"description" : ""
2023-05-25 21:37:19 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Albums"
2023-05-25 21:37:19 +02:00
]
} ,
2023-08-01 18:49:18 +02:00
"patch" : {
"operationId" : "updateAlbumInfo" ,
2023-05-25 21:37:19 +02:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
2023-08-01 18:49:18 +02:00
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateAlbumDto"
}
}
} ,
"required" : true
} ,
2023-05-25 21:37:19 +02:00
"responses" : {
"200" : {
2023-05-26 15:04:09 +02:00
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AlbumResponseDto"
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-05-25 21:37:19 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Albums"
2023-05-25 21:37:19 +02:00
]
}
} ,
2024-05-22 19:24:57 +02:00
"/albums/{id}/assets" : {
2023-08-01 18:49:18 +02:00
"delete" : {
"operationId" : "removeAssetFromAlbum" ,
2023-06-07 16:37:25 +02:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
2023-08-02 03:29:14 +02:00
"$ref" : "#/components/schemas/BulkIdsDto"
2023-06-07 16:37:25 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"required" : true
2023-06-07 16:37:25 +02:00
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-08-02 03:29:14 +02:00
"items" : {
"$ref" : "#/components/schemas/BulkIdResponseDto"
} ,
"type" : "array"
2023-06-07 16:37:25 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-06-07 16:37:25 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Albums"
2023-06-07 16:37:25 +02:00
]
2023-06-10 06:14:18 +02:00
} ,
2023-08-01 18:49:18 +02:00
"put" : {
"operationId" : "addAssetsToAlbum" ,
2023-06-07 16:37:25 +02:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
2023-08-01 18:49:18 +02:00
} ,
{
"name" : "key" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
2023-06-07 16:37:25 +02:00
}
] ,
2023-01-18 16:40:15 +02:00
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
2023-08-02 03:29:14 +02:00
"$ref" : "#/components/schemas/BulkIdsDto"
2023-01-18 16:40:15 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"required" : true
2023-01-18 16:40:15 +02:00
} ,
"responses" : {
2023-06-10 06:14:18 +02:00
"200" : {
2023-01-18 16:40:15 +02:00
"content" : {
"application/json" : {
"schema" : {
2023-08-02 03:29:14 +02:00
"items" : {
"$ref" : "#/components/schemas/BulkIdResponseDto"
} ,
"type" : "array"
2023-01-18 16:40:15 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-01-18 16:40:15 +02:00
}
} ,
2023-02-24 18:01:10 +02:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2023-02-24 18:01:10 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Albums"
2023-01-18 16:40:15 +02:00
]
2023-06-10 06:14:18 +02:00
}
} ,
2024-05-22 19:24:57 +02:00
"/albums/{id}/user/{userId}" : {
2023-06-10 06:14:18 +02:00
"delete" : {
"operationId" : "removeUserFromAlbum" ,
2023-01-18 16:40:15 +02:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
2023-04-05 00:24:08 +02:00
"format" : "uuid" ,
2023-02-18 22:58:55 +02:00
"type" : "string"
2023-01-18 16:40:15 +02:00
}
2023-06-10 06:14:18 +02:00
} ,
{
"name" : "userId" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"type" : "string"
}
2023-01-18 16:40:15 +02:00
}
] ,
"responses" : {
"200" : {
2023-06-10 06:14:18 +02:00
"description" : ""
2023-01-18 16:40:15 +02:00
}
} ,
2023-02-24 18:01:10 +02:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2023-02-24 18:01:10 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Albums"
2023-01-18 16:40:15 +02:00
]
2024-04-25 06:19:49 +02:00
} ,
"put" : {
"operationId" : "updateAlbumUser" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
{
"name" : "userId" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"type" : "string"
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateAlbumUserDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"200" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Albums"
2024-04-25 06:19:49 +02:00
]
2023-06-10 06:14:18 +02:00
}
} ,
2024-05-22 19:24:57 +02:00
"/albums/{id}/users" : {
2023-01-18 16:40:15 +02:00
"put" : {
2023-06-10 06:14:18 +02:00
"operationId" : "addUsersToAlbum" ,
2023-01-18 16:40:15 +02:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
2023-04-05 00:24:08 +02:00
"format" : "uuid" ,
2023-02-18 22:58:55 +02:00
"type" : "string"
2023-01-18 16:40:15 +02:00
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/AddUsersDto"
2023-01-18 16:40:15 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"required" : true
2023-01-18 16:40:15 +02:00
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/AlbumResponseDto"
2023-01-18 16:40:15 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-01-18 16:40:15 +02:00
}
} ,
2023-02-24 18:01:10 +02:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2023-02-24 18:01:10 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Albums"
2023-01-18 16:40:15 +02:00
]
2023-06-10 06:14:18 +02:00
}
} ,
2024-05-22 19:24:57 +02:00
"/api-keys" : {
2023-08-01 18:49:18 +02:00
"get" : {
2023-11-04 03:33:15 +02:00
"operationId" : "getApiKeys" ,
2023-06-10 06:14:18 +02:00
"parameters" : [ ] ,
2023-01-18 16:40:15 +02:00
"responses" : {
2023-08-01 18:49:18 +02:00
"200" : {
2023-06-10 06:14:18 +02:00
"content" : {
"application/json" : {
"schema" : {
2023-08-01 18:49:18 +02:00
"items" : {
"$ref" : "#/components/schemas/APIKeyResponseDto"
} ,
"type" : "array"
2023-06-10 06:14:18 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-01-18 16:40:15 +02:00
}
} ,
2023-02-24 18:01:10 +02:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2023-02-24 18:01:10 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"API Keys"
2023-01-18 16:40:15 +02:00
]
2023-06-10 06:14:18 +02:00
} ,
2023-08-01 18:49:18 +02:00
"post" : {
2023-11-04 03:33:15 +02:00
"operationId" : "createApiKey" ,
2023-06-10 06:14:18 +02:00
"parameters" : [ ] ,
2023-08-01 18:49:18 +02:00
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/APIKeyCreateDto"
}
}
} ,
"required" : true
} ,
2023-05-21 08:26:06 +02:00
"responses" : {
2023-08-01 18:49:18 +02:00
"201" : {
2023-05-21 08:26:06 +02:00
"content" : {
"application/json" : {
"schema" : {
2023-08-01 18:49:18 +02:00
"$ref" : "#/components/schemas/APIKeyCreateResponseDto"
2023-05-21 08:26:06 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-05-21 08:26:06 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"API Keys"
2023-05-21 08:26:06 +02:00
]
}
} ,
2024-05-22 19:24:57 +02:00
"/api-keys/{id}" : {
2023-08-01 18:49:18 +02:00
"delete" : {
2023-11-04 03:33:15 +02:00
"operationId" : "deleteApiKey" ,
2023-06-10 06:14:18 +02:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
2023-01-24 06:13:42 +02:00
}
}
2023-06-10 06:14:18 +02:00
] ,
2023-01-21 18:11:55 +02:00
"responses" : {
2023-06-10 06:14:18 +02:00
"200" : {
2023-08-01 18:49:18 +02:00
"description" : ""
2023-01-21 18:11:55 +02:00
}
} ,
2023-06-10 06:14:18 +02:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"API Keys"
2023-01-21 18:11:55 +02:00
]
2023-06-10 06:14:18 +02:00
} ,
2023-08-01 18:49:18 +02:00
"get" : {
2023-11-04 03:33:15 +02:00
"operationId" : "getApiKey" ,
2023-06-10 06:14:18 +02:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
2023-04-26 04:19:23 +02:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/APIKeyResponseDto"
2023-04-26 04:19:23 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-04-26 04:19:23 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2023-04-26 04:19:23 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"API Keys"
2023-04-26 04:19:23 +02:00
]
2023-05-09 21:34:17 +02:00
} ,
2023-08-01 18:49:18 +02:00
"put" : {
2023-11-04 03:33:15 +02:00
"operationId" : "updateApiKey" ,
2023-06-10 06:14:18 +02:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
2023-08-01 18:49:18 +02:00
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/APIKeyUpdateDto"
}
}
} ,
"required" : true
} ,
2023-05-09 21:34:17 +02:00
"responses" : {
"200" : {
2023-08-01 18:49:18 +02:00
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/APIKeyResponseDto"
}
}
} ,
2023-05-09 21:34:17 +02:00
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"API Keys"
2023-05-09 21:34:17 +02:00
]
2023-04-26 04:19:23 +02:00
}
} ,
2024-05-31 19:44:04 +02:00
"/assets" : {
2023-08-01 18:49:18 +02:00
"delete" : {
2023-10-06 09:01:14 +02:00
"operationId" : "deleteAssets" ,
2023-08-01 18:49:18 +02:00
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
2023-10-06 09:01:14 +02:00
"$ref" : "#/components/schemas/AssetBulkDeleteDto"
2023-08-01 18:49:18 +02:00
}
}
} ,
"required" : true
} ,
"responses" : {
2023-10-06 09:01:14 +02:00
"204" : {
2023-08-01 18:49:18 +02:00
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
2023-04-26 04:19:23 +02:00
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2023-04-26 04:19:23 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
2023-01-21 18:11:55 +02:00
"tags" : [
2024-05-30 00:26:57 +02:00
"Assets"
2023-01-21 18:11:55 +02:00
]
2023-08-16 22:04:55 +02:00
} ,
2024-05-31 19:44:04 +02:00
"post" : {
"operationId" : "uploadAsset" ,
"parameters" : [
{
"name" : "key" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "x-immich-checksum" ,
"in" : "header" ,
"description" : "sha1 checksum that can be used for duplicate detection before the file is uploaded" ,
"required" : false ,
"schema" : {
"type" : "string"
}
}
] ,
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"$ref" : "#/components/schemas/AssetMediaCreateDto"
}
}
} ,
"description" : "Asset Upload Information" ,
"required" : true
} ,
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AssetMediaResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Assets"
]
} ,
2023-08-16 22:04:55 +02:00
"put" : {
"operationId" : "updateAssets" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AssetBulkUpdateDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"204" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Assets"
2023-08-16 22:04:55 +02:00
]
2023-01-21 18:11:55 +02:00
}
} ,
2024-05-31 19:44:04 +02:00
"/assets/bulk-upload-check" : {
2023-01-24 06:13:42 +02:00
"post" : {
2023-06-10 06:14:18 +02:00
"description" : "Checks if assets exist by checksums" ,
2023-11-04 03:33:15 +02:00
"operationId" : "checkBulkUpload" ,
2023-01-24 06:13:42 +02:00
"parameters" : [ ] ,
2023-06-10 06:14:18 +02:00
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AssetBulkUploadCheckDto"
2023-01-24 06:13:42 +02:00
}
2022-12-05 19:56:44 +02:00
}
2023-08-01 18:49:18 +02:00
} ,
"required" : true
2023-01-24 06:13:42 +02:00
} ,
2023-03-20 17:55:28 +02:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/AssetBulkUploadCheckResponseDto"
2023-03-20 17:55:28 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-03-20 17:55:28 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2023-03-20 17:55:28 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Assets"
2023-03-20 17:55:28 +02:00
]
}
} ,
2024-05-31 19:44:04 +02:00
"/assets/device/{deviceId}" : {
2023-11-25 17:46:20 +02:00
"get" : {
"description" : "Get all asset of a device that are in the database, ID only." ,
"operationId" : "getAllUserAssetsByDeviceId" ,
"parameters" : [
{
"name" : "deviceId" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Assets"
2023-11-25 17:46:20 +02:00
]
}
} ,
2024-05-31 19:44:04 +02:00
"/assets/exist" : {
2023-06-10 06:14:18 +02:00
"post" : {
"description" : "Checks if multiple assets exist on the server and returns all existing - used by background backup" ,
2023-08-01 18:49:18 +02:00
"operationId" : "checkExistingAssets" ,
2023-06-10 06:14:18 +02:00
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CheckExistingAssetsDto"
}
2023-03-20 22:16:32 +02:00
}
2023-08-01 18:49:18 +02:00
} ,
"required" : true
2023-06-10 06:14:18 +02:00
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CheckExistingAssetsResponseDto"
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-06-10 06:14:18 +02:00
}
} ,
"security" : [
2023-03-20 22:16:32 +02:00
{
2023-06-10 06:14:18 +02:00
"bearer" : [ ]
2023-03-20 22:16:32 +02:00
} ,
{
2023-06-10 06:14:18 +02:00
"cookie" : [ ]
2023-03-20 22:16:32 +02:00
} ,
{
2023-06-10 06:14:18 +02:00
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Assets"
2023-06-10 06:14:18 +02:00
]
}
} ,
2024-05-31 19:44:04 +02:00
"/assets/jobs" : {
2023-08-18 16:31:48 +02:00
"post" : {
"operationId" : "runAssetJobs" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AssetJobsDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"204" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Assets"
2023-08-18 16:31:48 +02:00
]
}
} ,
2024-05-31 19:44:04 +02:00
"/assets/memory-lane" : {
2023-06-15 03:47:18 +02:00
"get" : {
"operationId" : "getMemoryLane" ,
"parameters" : [
{
2023-10-05 00:11:11 +02:00
"name" : "day" ,
2023-06-15 03:47:18 +02:00
"required" : true ,
"in" : "query" ,
"schema" : {
2024-04-23 00:13:44 +02:00
"minimum" : 1 ,
"maximum" : 31 ,
2023-10-05 00:11:11 +02:00
"type" : "integer"
}
} ,
{
"name" : "month" ,
"required" : true ,
"in" : "query" ,
"schema" : {
2024-04-23 00:13:44 +02:00
"minimum" : 1 ,
"maximum" : 12 ,
2023-10-05 00:11:11 +02:00
"type" : "integer"
2023-06-15 03:47:18 +02:00
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/MemoryLaneResponseDto"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-06-15 03:47:18 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-06-15 03:47:18 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Assets"
2023-06-15 03:47:18 +02:00
]
}
} ,
2024-05-31 19:44:04 +02:00
"/assets/random" : {
2023-09-23 17:28:55 +02:00
"get" : {
"operationId" : "getRandom" ,
"parameters" : [
{
"name" : "count" ,
"required" : false ,
"in" : "query" ,
"schema" : {
2024-04-23 00:13:44 +02:00
"minimum" : 1 ,
2023-09-23 17:28:55 +02:00
"type" : "number"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/AssetResponseDto"
} ,
"type" : "array"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Assets"
2023-09-23 17:28:55 +02:00
]
}
} ,
2024-05-31 19:44:04 +02:00
"/assets/stack/parent" : {
2023-10-22 04:38:07 +02:00
"put" : {
"operationId" : "updateStackParent" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateStackParentDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"200" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Assets"
2023-10-22 04:38:07 +02:00
]
}
} ,
2024-05-31 19:44:04 +02:00
"/assets/statistics" : {
2023-01-25 18:35:28 +02:00
"get" : {
2023-11-04 03:33:15 +02:00
"operationId" : "getAssetStatistics" ,
2023-07-14 15:30:17 +02:00
"parameters" : [
{
"name" : "isArchived" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "isFavorite" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
2023-10-06 09:01:14 +02:00
} ,
{
"name" : "isTrashed" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
2023-07-14 15:30:17 +02:00
}
] ,
2023-01-25 18:35:28 +02:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-07-14 15:30:17 +02:00
"$ref" : "#/components/schemas/AssetStatsResponseDto"
2023-01-25 18:35:28 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-01-25 18:35:28 +02:00
}
} ,
2023-02-24 18:01:10 +02:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2023-02-24 18:01:10 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Assets"
2023-01-25 18:35:28 +02:00
]
}
} ,
2024-05-31 19:44:04 +02:00
"/assets/{id}" : {
2023-01-25 18:35:28 +02:00
"get" : {
2024-05-31 19:44:04 +02:00
"operationId" : "getAssetInfo" ,
2023-02-24 18:01:10 +02:00
"parameters" : [
2023-06-10 06:14:18 +02:00
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
2023-02-24 18:01:10 +02:00
{
"name" : "key" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
}
] ,
2023-01-25 18:35:28 +02:00
"responses" : {
"200" : {
2023-07-07 00:25:56 +02:00
"content" : {
2024-05-31 19:44:04 +02:00
"application/json" : {
2023-07-07 00:25:56 +02:00
"schema" : {
2024-05-31 19:44:04 +02:00
"$ref" : "#/components/schemas/AssetResponseDto"
2023-07-07 00:25:56 +02:00
}
}
} ,
2023-06-10 06:14:18 +02:00
"description" : ""
2023-01-25 18:35:28 +02:00
}
} ,
2023-02-24 18:01:10 +02:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2023-02-24 18:01:10 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Assets"
2023-01-25 18:35:28 +02:00
]
2024-05-31 19:44:04 +02:00
} ,
"put" : {
"operationId" : "updateAsset" ,
2023-01-25 18:35:28 +02:00
"parameters" : [
{
2024-05-31 19:44:04 +02:00
"name" : "id" ,
"required" : true ,
"in" : "path" ,
2024-05-02 21:42:26 +02:00
"schema" : {
2024-05-31 19:44:04 +02:00
"format" : "uuid" ,
2024-05-02 21:42:26 +02:00
"type" : "string"
}
2023-01-25 18:35:28 +02:00
}
] ,
2023-06-02 04:09:57 +02:00
"requestBody" : {
"content" : {
2024-05-31 19:44:04 +02:00
"application/json" : {
2023-06-02 04:09:57 +02:00
"schema" : {
2024-05-31 19:44:04 +02:00
"$ref" : "#/components/schemas/UpdateAssetDto"
2023-06-02 04:09:57 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"required" : true
2023-06-02 04:09:57 +02:00
} ,
2023-01-25 18:35:28 +02:00
"responses" : {
2024-05-31 19:44:04 +02:00
"200" : {
2023-06-02 04:09:57 +02:00
"content" : {
"application/json" : {
"schema" : {
2024-05-31 19:44:04 +02:00
"$ref" : "#/components/schemas/AssetResponseDto"
2023-06-02 04:09:57 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-01-25 18:35:28 +02:00
}
} ,
2023-02-24 18:01:10 +02:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2023-02-24 18:01:10 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Assets"
2023-01-25 18:35:28 +02:00
]
2023-06-10 06:14:18 +02:00
}
} ,
2024-05-31 19:44:04 +02:00
"/assets/{id}/original" : {
2024-01-25 19:52:21 +02:00
"get" : {
2024-05-31 19:44:04 +02:00
"operationId" : "downloadAsset" ,
2024-01-25 19:52:21 +02:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
{
"name" : "key" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
"content" : {
2024-05-31 19:44:04 +02:00
"application/octet-stream" : {
2024-01-25 19:52:21 +02:00
"schema" : {
2024-05-31 19:44:04 +02:00
"format" : "binary" ,
"type" : "string"
2024-01-25 19:52:21 +02:00
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Assets"
2024-01-25 19:52:21 +02:00
]
} ,
2023-06-10 06:14:18 +02:00
"put" : {
2024-05-31 19:44:04 +02:00
"description" : "Replace the asset with new file, without changing its id" ,
"operationId" : "replaceAsset" ,
2023-06-10 06:14:18 +02:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
2024-05-31 19:44:04 +02:00
} ,
{
"name" : "key" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
2023-06-10 06:14:18 +02:00
}
] ,
"requestBody" : {
"content" : {
2024-05-31 19:44:04 +02:00
"multipart/form-data" : {
2023-06-10 06:14:18 +02:00
"schema" : {
2024-05-31 19:44:04 +02:00
"$ref" : "#/components/schemas/AssetMediaReplaceDto"
2023-06-10 06:14:18 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"required" : true
2023-06-10 06:14:18 +02:00
} ,
2022-12-05 19:56:44 +02:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2024-05-31 19:44:04 +02:00
"$ref" : "#/components/schemas/AssetMediaResponseDto"
2022-12-05 19:56:44 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2022-12-05 19:56:44 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 18:01:10 +02:00
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2022-12-05 19:56:44 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Assets"
2024-05-31 19:44:04 +02:00
] ,
"x-immich-lifecycle" : {
"addedAt" : "v1.106.0"
}
2023-06-10 06:14:18 +02:00
}
} ,
2024-05-31 19:44:04 +02:00
"/assets/{id}/thumbnail" : {
"get" : {
"operationId" : "viewAsset" ,
2024-05-24 02:26:22 +02:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
{
"name" : "key" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
2024-05-31 19:44:04 +02:00
} ,
{
"name" : "size" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"$ref" : "#/components/schemas/AssetMediaSize"
}
2024-05-24 02:26:22 +02:00
}
] ,
2024-05-31 19:44:04 +02:00
"responses" : {
"200" : {
"content" : {
"application/octet-stream" : {
"schema" : {
"format" : "binary" ,
"type" : "string"
}
2024-05-24 02:26:22 +02:00
}
2024-05-31 19:44:04 +02:00
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Assets"
]
}
} ,
"/assets/{id}/video/playback" : {
"get" : {
"operationId" : "playAssetVideo" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
2024-05-24 02:26:22 +02:00
}
} ,
2024-05-31 19:44:04 +02:00
{
"name" : "key" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
}
] ,
2024-05-24 02:26:22 +02:00
"responses" : {
"200" : {
"content" : {
2024-05-31 19:44:04 +02:00
"application/octet-stream" : {
2024-05-24 02:26:22 +02:00
"schema" : {
2024-05-31 19:44:04 +02:00
"format" : "binary" ,
"type" : "string"
2024-05-24 02:26:22 +02:00
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Assets"
2024-05-31 19:44:04 +02:00
]
2024-05-24 02:26:22 +02:00
}
} ,
2023-08-24 21:28:50 +02:00
"/audit/deletes" : {
"get" : {
"operationId" : "getAuditDeletes" ,
"parameters" : [
{
2024-01-22 18:49:51 +02:00
"name" : "after" ,
2023-08-24 21:28:50 +02:00
"required" : true ,
"in" : "query" ,
"schema" : {
2024-01-22 18:49:51 +02:00
"format" : "date-time" ,
"type" : "string"
2023-08-24 21:28:50 +02:00
}
} ,
{
2024-01-22 18:49:51 +02:00
"name" : "entityType" ,
"required" : true ,
2023-08-24 21:28:50 +02:00
"in" : "query" ,
"schema" : {
2024-01-22 18:49:51 +02:00
"$ref" : "#/components/schemas/EntityType"
2023-08-24 21:28:50 +02:00
}
} ,
{
2024-01-22 18:49:51 +02:00
"name" : "userId" ,
"required" : false ,
2023-08-24 21:28:50 +02:00
"in" : "query" ,
"schema" : {
2024-01-22 18:49:51 +02:00
"format" : "uuid" ,
2023-08-24 21:28:50 +02:00
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AuditDeletesResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Audit"
]
}
} ,
2023-06-10 06:14:18 +02:00
"/auth/admin-sign-up" : {
"post" : {
2023-11-04 03:33:15 +02:00
"operationId" : "signUpAdmin" ,
2023-01-24 06:13:42 +02:00
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/SignUpDto"
2023-01-24 06:13:42 +02:00
}
2022-12-09 22:53:11 +02:00
}
2023-08-01 18:49:18 +02:00
} ,
"required" : true
2023-01-24 06:13:42 +02:00
} ,
2022-12-05 19:56:44 +02:00
"responses" : {
2023-06-10 06:14:18 +02:00
"201" : {
2022-12-05 19:56:44 +02:00
"content" : {
"application/json" : {
"schema" : {
2024-05-27 00:15:52 +02:00
"$ref" : "#/components/schemas/UserAdminResponseDto"
2023-06-10 06:14:18 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-06-10 06:14:18 +02:00
}
} ,
"tags" : [
"Authentication"
]
}
} ,
"/auth/change-password" : {
"post" : {
"operationId" : "changePassword" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ChangePasswordDto"
}
}
2023-08-01 18:49:18 +02:00
} ,
"required" : true
2023-06-10 06:14:18 +02:00
} ,
"responses" : {
2023-08-01 18:49:18 +02:00
"200" : {
2023-06-10 06:14:18 +02:00
"content" : {
"application/json" : {
"schema" : {
2024-05-27 00:15:52 +02:00
"$ref" : "#/components/schemas/UserAdminResponseDto"
2022-12-05 19:56:44 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2022-12-05 19:56:44 +02:00
}
} ,
2023-01-24 06:13:42 +02:00
"security" : [
2022-12-05 19:56:44 +02:00
{
2023-01-24 06:13:42 +02:00
"bearer" : [ ]
2023-02-24 18:01:10 +02:00
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2023-01-24 06:13:42 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
"Authentication"
2023-01-24 06:13:42 +02:00
]
}
} ,
2023-06-10 06:14:18 +02:00
"/auth/login" : {
2023-06-01 03:51:28 +02:00
"post" : {
2023-06-10 06:14:18 +02:00
"operationId" : "login" ,
2023-06-01 03:51:28 +02:00
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/LoginCredentialDto"
2023-06-01 03:51:28 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"required" : true
2023-06-01 03:51:28 +02:00
} ,
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/LoginResponseDto"
2023-06-01 03:51:28 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-06-01 03:51:28 +02:00
}
} ,
"tags" : [
2023-06-10 06:14:18 +02:00
"Authentication"
]
}
} ,
"/auth/logout" : {
"post" : {
"operationId" : "logout" ,
"parameters" : [ ] ,
"responses" : {
2023-08-01 18:49:18 +02:00
"200" : {
2023-06-10 06:14:18 +02:00
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LogoutResponseDto"
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-06-10 06:14:18 +02:00
}
} ,
2023-06-01 03:51:28 +02:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
"Authentication"
2023-06-01 03:51:28 +02:00
]
2023-06-10 06:14:18 +02:00
}
} ,
"/auth/validateToken" : {
"post" : {
"operationId" : "validateAccessToken" ,
2023-06-01 03:51:28 +02:00
"parameters" : [ ] ,
"responses" : {
2023-08-01 18:49:18 +02:00
"200" : {
2023-06-01 03:51:28 +02:00
"content" : {
"application/json" : {
"schema" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/ValidateAccessTokenResponseDto"
2023-06-01 03:51:28 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-06-01 03:51:28 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
"Authentication"
2023-06-01 03:51:28 +02:00
]
}
} ,
2024-01-26 16:19:13 +02:00
"/download/archive" : {
"post" : {
"operationId" : "downloadArchive" ,
"parameters" : [
{
"name" : "key" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AssetIdsDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"200" : {
"content" : {
"application/octet-stream" : {
"schema" : {
"format" : "binary" ,
"type" : "string"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Download"
]
}
} ,
"/download/info" : {
"post" : {
"operationId" : "getDownloadInfo" ,
"parameters" : [
{
"name" : "key" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DownloadInfoDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DownloadResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Download"
]
}
} ,
2024-05-17 19:05:23 +02:00
"/duplicates" : {
"get" : {
"operationId" : "getAssetDuplicates" ,
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
2024-05-18 20:50:28 +02:00
"$ref" : "#/components/schemas/DuplicateResponseDto"
2024-05-17 19:05:23 +02:00
} ,
"type" : "array"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Duplicates"
2024-05-17 19:05:23 +02:00
]
}
} ,
2024-05-22 19:24:57 +02:00
"/faces" : {
2023-12-05 17:43:15 +02:00
"get" : {
"operationId" : "getFaces" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "query" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/AssetFaceResponseDto"
} ,
"type" : "array"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Faces"
2023-12-05 17:43:15 +02:00
]
}
} ,
2024-05-22 19:24:57 +02:00
"/faces/{id}" : {
2023-12-05 17:43:15 +02:00
"put" : {
"operationId" : "reassignFacesById" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FaceDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PersonResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Faces"
2023-12-05 17:43:15 +02:00
]
}
} ,
2023-06-10 06:14:18 +02:00
"/jobs" : {
2023-06-01 03:51:28 +02:00
"get" : {
2023-06-10 06:14:18 +02:00
"operationId" : "getAllJobsStatus" ,
"parameters" : [ ] ,
2023-06-01 03:51:28 +02:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/AllJobStatusResponseDto"
2023-06-01 03:51:28 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-06-01 03:51:28 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Jobs"
2023-06-01 03:51:28 +02:00
]
2023-06-10 06:14:18 +02:00
}
} ,
2023-06-16 21:36:07 +02:00
"/jobs/{id}" : {
2023-06-10 06:14:18 +02:00
"put" : {
"operationId" : "sendJobCommand" ,
2023-06-01 03:51:28 +02:00
"parameters" : [
{
2023-06-16 21:36:07 +02:00
"name" : "id" ,
2023-06-01 03:51:28 +02:00
"required" : true ,
"in" : "path" ,
"schema" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/JobName"
2023-06-01 03:51:28 +02:00
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/JobCommandDto"
2023-06-01 03:51:28 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"required" : true
2023-06-01 03:51:28 +02:00
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/JobStatusDto"
2023-06-01 03:51:28 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-06-01 03:51:28 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Jobs"
2023-06-01 03:51:28 +02:00
]
2023-06-10 06:14:18 +02:00
}
} ,
2024-05-22 19:24:57 +02:00
"/libraries" : {
2023-09-20 13:16:33 +02:00
"get" : {
2024-02-29 20:35:37 +02:00
"operationId" : "getAllLibraries" ,
2024-05-21 00:09:10 +02:00
"parameters" : [ ] ,
2023-09-20 13:16:33 +02:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/LibraryResponseDto"
} ,
"type" : "array"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Libraries"
2023-09-20 13:16:33 +02:00
]
} ,
"post" : {
"operationId" : "createLibrary" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateLibraryDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LibraryResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Libraries"
2023-09-20 13:16:33 +02:00
]
}
} ,
2024-05-22 19:24:57 +02:00
"/libraries/{id}" : {
2023-09-20 13:16:33 +02:00
"delete" : {
"operationId" : "deleteLibrary" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"responses" : {
2024-02-29 22:10:08 +02:00
"204" : {
2023-09-20 13:16:33 +02:00
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Libraries"
2023-09-20 13:16:33 +02:00
]
} ,
"get" : {
2024-02-29 20:35:37 +02:00
"operationId" : "getLibrary" ,
2023-09-20 13:16:33 +02:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LibraryResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Libraries"
2023-09-20 13:16:33 +02:00
]
} ,
"put" : {
"operationId" : "updateLibrary" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateLibraryDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LibraryResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Libraries"
2023-09-20 13:16:33 +02:00
]
}
} ,
2024-05-22 19:24:57 +02:00
"/libraries/{id}/removeOffline" : {
2023-09-20 13:16:33 +02:00
"post" : {
"operationId" : "removeOfflineFiles" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"responses" : {
2024-02-29 22:10:08 +02:00
"204" : {
2023-09-20 13:16:33 +02:00
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Libraries"
2023-09-20 13:16:33 +02:00
]
}
} ,
2024-05-22 19:24:57 +02:00
"/libraries/{id}/scan" : {
2023-09-20 13:16:33 +02:00
"post" : {
"operationId" : "scanLibrary" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ScanLibraryDto"
}
}
} ,
"required" : true
} ,
"responses" : {
2024-02-29 22:10:08 +02:00
"204" : {
2023-09-20 13:16:33 +02:00
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Libraries"
2023-09-20 13:16:33 +02:00
]
}
} ,
2024-05-22 19:24:57 +02:00
"/libraries/{id}/statistics" : {
2023-09-20 13:16:33 +02:00
"get" : {
"operationId" : "getLibraryStatistics" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LibraryStatsResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Libraries"
2023-09-20 13:16:33 +02:00
]
}
} ,
2024-05-22 19:24:57 +02:00
"/libraries/{id}/validate" : {
2024-02-20 17:53:12 +02:00
"post" : {
"operationId" : "validate" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ValidateLibraryDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ValidateLibraryResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Libraries"
2024-02-20 17:53:12 +02:00
]
}
} ,
2024-05-29 17:51:01 +02:00
"/map/markers" : {
"get" : {
"operationId" : "getMapMarkers" ,
"parameters" : [
{
"name" : "fileCreatedAfter" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
{
"name" : "fileCreatedBefore" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
{
"name" : "isArchived" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "isFavorite" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "withPartners" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "withSharedAlbums" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/MapMarkerResponseDto"
} ,
"type" : "array"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Map"
]
}
} ,
2024-07-30 00:17:26 +02:00
"/map/reverse-geocode" : {
"get" : {
"operationId" : "reverseGeocode" ,
"parameters" : [
{
"name" : "lat" ,
"required" : true ,
"in" : "query" ,
"schema" : {
"format" : "double" ,
"type" : "number"
}
} ,
{
"name" : "lon" ,
"required" : true ,
"in" : "query" ,
"schema" : {
"format" : "double" ,
"type" : "number"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/MapReverseGeocodeResponseDto"
} ,
"type" : "array"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Map"
]
}
} ,
2024-05-29 17:51:01 +02:00
"/map/style.json" : {
"get" : {
"operationId" : "getMapStyle" ,
"parameters" : [
{
"name" : "key" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "theme" ,
"required" : true ,
"in" : "query" ,
"schema" : {
"$ref" : "#/components/schemas/MapTheme"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Map"
]
}
} ,
2024-04-02 16:23:17 +02:00
"/memories" : {
"get" : {
"operationId" : "searchMemories" ,
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/MemoryResponseDto"
} ,
"type" : "array"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Memories"
2024-04-02 16:23:17 +02:00
]
} ,
"post" : {
"operationId" : "createMemory" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MemoryCreateDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MemoryResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Memories"
2024-04-02 16:23:17 +02:00
]
}
} ,
"/memories/{id}" : {
"delete" : {
"operationId" : "deleteMemory" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"responses" : {
"204" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Memories"
2024-04-02 16:23:17 +02:00
]
} ,
"get" : {
"operationId" : "getMemory" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MemoryResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Memories"
2024-04-02 16:23:17 +02:00
]
} ,
"put" : {
"operationId" : "updateMemory" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MemoryUpdateDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MemoryResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Memories"
2024-04-02 16:23:17 +02:00
]
}
} ,
"/memories/{id}/assets" : {
"delete" : {
"operationId" : "removeMemoryAssets" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BulkIdsDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/BulkIdResponseDto"
} ,
"type" : "array"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Memories"
2024-04-02 16:23:17 +02:00
]
} ,
"put" : {
"operationId" : "addMemoryAssets" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BulkIdsDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/BulkIdResponseDto"
} ,
"type" : "array"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Memories"
2024-04-02 16:23:17 +02:00
]
}
} ,
2024-06-07 18:34:09 +02:00
"/notifications/test-email" : {
"post" : {
"operationId" : "sendTestEmail" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SystemConfigSmtpDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"200" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Notifications"
]
}
} ,
2023-09-01 13:08:42 +02:00
"/oauth/authorize" : {
"post" : {
2023-11-04 03:33:15 +02:00
"operationId" : "startOAuth" ,
2023-09-01 13:08:42 +02:00
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/OAuthConfigDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/OAuthAuthorizeResponseDto"
}
}
} ,
"description" : ""
}
} ,
"tags" : [
"OAuth"
]
}
} ,
2023-06-10 06:14:18 +02:00
"/oauth/callback" : {
"post" : {
2023-11-04 03:33:15 +02:00
"operationId" : "finishOAuth" ,
2023-06-10 06:14:18 +02:00
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/OAuthCallbackDto"
}
}
2023-08-01 18:49:18 +02:00
} ,
"required" : true
2023-06-10 06:14:18 +02:00
} ,
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LoginResponseDto"
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-06-10 06:14:18 +02:00
}
} ,
"tags" : [
"OAuth"
]
}
} ,
"/oauth/link" : {
"post" : {
2023-11-04 03:33:15 +02:00
"operationId" : "linkOAuthAccount" ,
2023-06-10 06:14:18 +02:00
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/OAuthCallbackDto"
}
}
2023-08-01 18:49:18 +02:00
} ,
"required" : true
2023-06-10 06:14:18 +02:00
} ,
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
2024-05-27 00:15:52 +02:00
"$ref" : "#/components/schemas/UserAdminResponseDto"
2023-06-10 06:14:18 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-06-01 03:51:28 +02:00
}
2023-06-10 06:14:18 +02:00
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
"OAuth"
2023-06-10 06:14:18 +02:00
]
}
} ,
"/oauth/mobile-redirect" : {
"get" : {
2023-11-04 03:33:15 +02:00
"operationId" : "redirectOAuthToMobile" ,
2023-06-10 06:14:18 +02:00
"parameters" : [ ] ,
2023-06-01 03:51:28 +02:00
"responses" : {
"200" : {
"description" : ""
}
} ,
"tags" : [
2023-06-10 06:14:18 +02:00
"OAuth"
]
}
} ,
"/oauth/unlink" : {
"post" : {
2023-11-04 03:33:15 +02:00
"operationId" : "unlinkOAuthAccount" ,
2023-06-10 06:14:18 +02:00
"parameters" : [ ] ,
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
2024-05-27 00:15:52 +02:00
"$ref" : "#/components/schemas/UserAdminResponseDto"
2023-06-10 06:14:18 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-06-10 06:14:18 +02:00
}
} ,
2023-06-01 03:51:28 +02:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
"OAuth"
2023-06-01 03:51:28 +02:00
]
}
} ,
2024-05-22 19:24:57 +02:00
"/partners" : {
2023-06-01 03:51:28 +02:00
"get" : {
2023-06-10 06:14:18 +02:00
"operationId" : "getPartners" ,
2023-06-01 03:51:28 +02:00
"parameters" : [
{
2023-06-10 06:14:18 +02:00
"name" : "direction" ,
2023-06-01 03:51:28 +02:00
"required" : true ,
2023-06-10 06:14:18 +02:00
"in" : "query" ,
2023-06-01 03:51:28 +02:00
"schema" : {
2024-07-08 22:41:39 +02:00
"$ref" : "#/components/schemas/PartnerDirection"
2023-06-01 03:51:28 +02:00
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
2023-11-11 23:06:19 +02:00
"$ref" : "#/components/schemas/PartnerResponseDto"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-06-01 03:51:28 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-06-01 03:51:28 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Partners"
2023-06-01 03:51:28 +02:00
]
2023-06-10 06:14:18 +02:00
}
} ,
2024-05-22 19:24:57 +02:00
"/partners/{id}" : {
2023-08-01 18:49:18 +02:00
"delete" : {
"operationId" : "removePartner" ,
2023-06-01 03:51:28 +02:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"responses" : {
2023-08-01 18:49:18 +02:00
"200" : {
"description" : ""
2023-06-01 03:51:28 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Partners"
2023-06-01 03:51:28 +02:00
]
} ,
2023-08-01 18:49:18 +02:00
"post" : {
"operationId" : "createPartner" ,
2023-06-01 03:51:28 +02:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
2023-06-10 06:14:18 +02:00
"responses" : {
2023-08-01 18:49:18 +02:00
"201" : {
"content" : {
"application/json" : {
"schema" : {
2023-11-11 23:06:19 +02:00
"$ref" : "#/components/schemas/PartnerResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Partners"
2023-11-11 23:06:19 +02:00
]
} ,
"put" : {
"operationId" : "updatePartner" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdatePartnerDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PartnerResponseDto"
2023-08-01 18:49:18 +02:00
}
}
} ,
2023-06-10 06:14:18 +02:00
"description" : ""
2023-06-01 03:51:28 +02:00
}
} ,
2023-06-10 06:14:18 +02:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Partners"
2023-06-10 06:14:18 +02:00
]
}
} ,
2024-05-22 19:24:57 +02:00
"/people" : {
2023-06-10 06:14:18 +02:00
"get" : {
"operationId" : "getAllPeople" ,
2023-07-18 20:09:43 +02:00
"parameters" : [
2024-07-25 21:59:28 +02:00
{
"name" : "page" ,
"required" : false ,
"in" : "query" ,
"description" : "Page number for pagination" ,
"schema" : {
"minimum" : 1 ,
"default" : 1 ,
"type" : "number"
}
} ,
{
"name" : "size" ,
"required" : false ,
"in" : "query" ,
"description" : "Number of items per page" ,
"schema" : {
"minimum" : 1 ,
"maximum" : 1000 ,
"default" : 500 ,
"type" : "number"
}
} ,
2023-07-18 20:09:43 +02:00
{
"name" : "withHidden" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
}
] ,
2023-06-01 03:51:28 +02:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-07-18 20:09:43 +02:00
"$ref" : "#/components/schemas/PeopleResponseDto"
2023-06-01 03:51:28 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-06-01 03:51:28 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"People"
2023-06-01 03:51:28 +02:00
]
2023-07-23 05:00:43 +02:00
} ,
2023-12-05 17:43:15 +02:00
"post" : {
"operationId" : "createPerson" ,
"parameters" : [ ] ,
2024-03-07 22:34:57 +02:00
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PersonCreateDto"
}
}
} ,
"required" : true
} ,
2023-12-05 17:43:15 +02:00
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PersonResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"People"
2023-12-05 17:43:15 +02:00
]
} ,
2023-07-23 05:00:43 +02:00
"put" : {
"operationId" : "updatePeople" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PeopleUpdateDto"
}
}
2023-08-01 18:49:18 +02:00
} ,
"required" : true
2023-07-23 05:00:43 +02:00
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/BulkIdResponseDto"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-07-23 05:00:43 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-07-23 05:00:43 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"People"
2023-07-23 05:00:43 +02:00
]
2023-06-01 03:51:28 +02:00
}
} ,
2024-05-22 19:24:57 +02:00
"/people/{id}" : {
2023-01-24 06:13:42 +02:00
"get" : {
2023-06-10 06:14:18 +02:00
"operationId" : "getPerson" ,
2022-12-05 19:56:44 +02:00
"parameters" : [
{
2023-06-10 06:14:18 +02:00
"name" : "id" ,
2022-12-05 19:56:44 +02:00
"required" : true ,
2023-06-10 06:14:18 +02:00
"in" : "path" ,
2022-12-05 19:56:44 +02:00
"schema" : {
2023-06-10 06:14:18 +02:00
"format" : "uuid" ,
"type" : "string"
2022-12-05 19:56:44 +02:00
}
}
] ,
"responses" : {
2023-01-24 06:13:42 +02:00
"200" : {
2022-12-05 19:56:44 +02:00
"content" : {
"application/json" : {
"schema" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/PersonResponseDto"
2022-12-05 19:56:44 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2022-12-05 19:56:44 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 18:01:10 +02:00
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2022-12-05 19:56:44 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"People"
2022-12-05 19:56:44 +02:00
]
2023-01-24 06:13:42 +02:00
} ,
2023-06-10 06:14:18 +02:00
"put" : {
"operationId" : "updatePerson" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
2022-12-05 19:56:44 +02:00
"requestBody" : {
"content" : {
2023-01-24 06:13:42 +02:00
"application/json" : {
2022-12-05 19:56:44 +02:00
"schema" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/PersonUpdateDto"
2022-12-05 19:56:44 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"required" : true
2022-12-05 19:56:44 +02:00
} ,
"responses" : {
2023-06-10 06:14:18 +02:00
"200" : {
2022-12-05 19:56:44 +02:00
"content" : {
"application/json" : {
"schema" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/PersonResponseDto"
2022-12-05 19:56:44 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2022-12-05 19:56:44 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 18:01:10 +02:00
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2022-12-05 19:56:44 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"People"
2022-12-05 19:56:44 +02:00
]
2023-06-10 06:14:18 +02:00
}
} ,
2024-05-22 19:24:57 +02:00
"/people/{id}/assets" : {
2023-06-10 06:14:18 +02:00
"get" : {
2024-08-06 18:22:13 +02:00
"deprecated" : true ,
"description" : "This property was deprecated in v1.113.0" ,
2023-06-10 06:14:18 +02:00
"operationId" : "getPersonAssets" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
2022-12-05 19:56:44 +02:00
}
}
2023-06-10 06:14:18 +02:00
] ,
2022-12-05 19:56:44 +02:00
"responses" : {
2023-01-24 06:13:42 +02:00
"200" : {
2022-12-05 19:56:44 +02:00
"content" : {
"application/json" : {
"schema" : {
2023-06-10 06:14:18 +02:00
"items" : {
"$ref" : "#/components/schemas/AssetResponseDto"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2022-12-05 19:56:44 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2022-12-05 19:56:44 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 18:01:10 +02:00
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2022-12-05 19:56:44 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-08-06 18:22:13 +02:00
"People" ,
"Deprecated"
] ,
"x-immich-lifecycle" : {
"deprecatedAt" : "v1.113.0"
}
2022-12-05 19:56:44 +02:00
}
} ,
2024-05-22 19:24:57 +02:00
"/people/{id}/merge" : {
2023-07-11 23:52:41 +02:00
"post" : {
"operationId" : "mergePerson" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MergePersonDto"
}
}
2023-08-01 18:49:18 +02:00
} ,
"required" : true
2023-07-11 23:52:41 +02:00
} ,
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/BulkIdResponseDto"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-07-11 23:52:41 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-07-11 23:52:41 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"People"
2023-07-11 23:52:41 +02:00
]
}
} ,
2024-05-22 19:24:57 +02:00
"/people/{id}/reassign" : {
2023-12-05 17:43:15 +02:00
"put" : {
"operationId" : "reassignFaces" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AssetFaceUpdateDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/PersonResponseDto"
} ,
"type" : "array"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
2024-02-13 03:50:47 +02:00
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"People"
2024-02-13 03:50:47 +02:00
]
}
} ,
2024-05-22 19:24:57 +02:00
"/people/{id}/statistics" : {
2024-02-13 03:50:47 +02:00
"get" : {
"operationId" : "getPersonStatistics" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PersonStatisticsResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"People"
2024-02-13 03:50:47 +02:00
]
}
} ,
2024-05-22 19:24:57 +02:00
"/people/{id}/thumbnail" : {
2024-02-13 03:50:47 +02:00
"get" : {
"operationId" : "getPersonThumbnail" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/octet-stream" : {
"schema" : {
"format" : "binary" ,
"type" : "string"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"People"
2024-02-13 03:50:47 +02:00
]
}
2024-04-20 02:35:54 +02:00
} ,
2024-05-22 19:24:57 +02:00
"/reports" : {
2024-04-20 02:35:54 +02:00
"get" : {
"operationId" : "getAuditFiles" ,
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FileReportDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"File Reports"
2024-04-20 02:35:54 +02:00
]
}
} ,
2024-05-22 19:24:57 +02:00
"/reports/checksum" : {
2024-04-20 02:35:54 +02:00
"post" : {
"operationId" : "getFileChecksums" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FileChecksumDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/FileChecksumResponseDto"
} ,
"type" : "array"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"File Reports"
2024-04-20 02:35:54 +02:00
]
}
} ,
2024-05-22 19:24:57 +02:00
"/reports/fix" : {
2024-04-20 02:35:54 +02:00
"post" : {
"operationId" : "fixAuditFiles" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FileReportFixDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"201" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"File Reports"
2024-04-20 02:35:54 +02:00
]
}
2024-02-13 03:50:47 +02:00
} ,
2024-03-20 05:23:57 +02:00
"/search/cities" : {
"get" : {
"operationId" : "getAssetsByCity" ,
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/AssetResponseDto"
} ,
"type" : "array"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Search"
]
}
} ,
2024-02-13 03:50:47 +02:00
"/search/explore" : {
"get" : {
"operationId" : "getExploreData" ,
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/SearchExploreResponseDto"
} ,
"type" : "array"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Search"
]
}
} ,
"/search/metadata" : {
2024-02-17 19:00:55 +02:00
"post" : {
2024-02-13 03:50:47 +02:00
"operationId" : "searchMetadata" ,
2024-02-17 19:00:55 +02:00
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MetadataSearchDto"
}
2024-02-13 03:50:47 +02:00
}
} ,
2024-02-17 19:00:55 +02:00
"required" : true
} ,
"responses" : {
2024-03-09 22:01:52 +02:00
"200" : {
2024-02-17 19:00:55 +02:00
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SearchResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
2024-02-13 03:50:47 +02:00
{
2024-02-17 19:00:55 +02:00
"bearer" : [ ]
2024-02-13 03:50:47 +02:00
} ,
{
2024-02-17 19:00:55 +02:00
"cookie" : [ ]
2024-02-13 03:50:47 +02:00
} ,
{
2024-02-17 19:00:55 +02:00
"api_key" : [ ]
}
] ,
"tags" : [
"Search"
]
}
} ,
"/search/person" : {
"get" : {
"operationId" : "searchPerson" ,
"parameters" : [
2024-02-13 03:50:47 +02:00
{
2024-02-17 19:00:55 +02:00
"name" : "name" ,
"required" : true ,
2024-02-13 03:50:47 +02:00
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
2024-02-17 19:00:55 +02:00
"name" : "withHidden" ,
2024-02-13 03:50:47 +02:00
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/PersonResponseDto"
} ,
"type" : "array"
}
}
} ,
"description" : ""
2024-02-17 19:00:55 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
2024-02-17 19:00:55 +02:00
"cookie" : [ ]
2023-10-24 17:53:49 +02:00
} ,
{
2024-02-17 19:00:55 +02:00
"api_key" : [ ]
2023-10-10 16:34:25 +02:00
}
] ,
2024-02-17 19:00:55 +02:00
"tags" : [
"Search"
]
}
} ,
2024-02-24 02:42:37 +02:00
"/search/places" : {
"get" : {
"operationId" : "searchPlaces" ,
"parameters" : [
{
"name" : "name" ,
"required" : true ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/PlacesResponseDto"
} ,
"type" : "array"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Search"
]
}
} ,
2024-02-17 19:00:55 +02:00
"/search/smart" : {
"post" : {
"operationId" : "searchSmart" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SmartSearchDto"
}
}
} ,
"required" : true
} ,
2023-10-10 16:34:25 +02:00
"responses" : {
2024-03-09 22:01:52 +02:00
"200" : {
2023-10-10 16:34:25 +02:00
"content" : {
"application/json" : {
"schema" : {
2024-02-13 03:50:47 +02:00
"$ref" : "#/components/schemas/SearchResponseDto"
2023-10-10 16:34:25 +02:00
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 18:01:10 +02:00
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2022-12-05 19:56:44 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
"Search"
2022-12-05 19:56:44 +02:00
]
}
} ,
2024-02-13 21:54:58 +02:00
"/search/suggestions" : {
"get" : {
"operationId" : "getSearchSuggestions" ,
"parameters" : [
{
"name" : "country" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
2024-08-02 05:27:40 +02:00
{
"name" : "includeNull" ,
"required" : false ,
"in" : "query" ,
"description" : "This property was added in v111.0.0" ,
"schema" : {
"type" : "boolean"
}
} ,
2024-02-13 21:54:58 +02:00
{
"name" : "make" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "model" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "state" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "type" ,
"required" : true ,
"in" : "query" ,
"schema" : {
"$ref" : "#/components/schemas/SearchSuggestionType"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Search"
]
}
} ,
2024-06-26 14:25:09 +02:00
"/server-info/about" : {
"get" : {
2024-06-28 18:08:19 +02:00
"deprecated" : true ,
"description" : "This property was deprecated in v1.107.0" ,
2024-06-26 14:25:09 +02:00
"operationId" : "getAboutInfo" ,
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServerAboutResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-06-28 18:08:19 +02:00
"Server Info" ,
"Deprecated"
] ,
"x-immich-lifecycle" : {
"deprecatedAt" : "v1.107.0"
}
2024-06-26 14:25:09 +02:00
}
} ,
2023-09-09 04:51:46 +02:00
"/server-info/config" : {
"get" : {
2024-06-28 18:08:19 +02:00
"deprecated" : true ,
"description" : "This property was deprecated in v1.107.0" ,
2023-09-09 04:51:46 +02:00
"operationId" : "getServerConfig" ,
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServerConfigDto"
}
}
} ,
"description" : ""
}
} ,
"tags" : [
2024-06-28 18:08:19 +02:00
"Server Info" ,
"Deprecated"
] ,
"x-immich-lifecycle" : {
"deprecatedAt" : "v1.107.0"
}
2023-09-09 04:51:46 +02:00
}
} ,
2023-08-18 06:55:26 +02:00
"/server-info/features" : {
"get" : {
2024-06-28 18:08:19 +02:00
"deprecated" : true ,
"description" : "This property was deprecated in v1.107.0" ,
2023-08-18 06:55:26 +02:00
"operationId" : "getServerFeatures" ,
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServerFeaturesDto"
}
}
} ,
"description" : ""
}
} ,
"tags" : [
2024-06-28 18:08:19 +02:00
"Server Info" ,
"Deprecated"
] ,
"x-immich-lifecycle" : {
"deprecatedAt" : "v1.107.0"
}
2023-08-18 06:55:26 +02:00
}
} ,
2023-07-16 03:24:46 +02:00
"/server-info/media-types" : {
"get" : {
2024-06-28 18:08:19 +02:00
"deprecated" : true ,
"description" : "This property was deprecated in v1.107.0" ,
2023-07-16 03:24:46 +02:00
"operationId" : "getSupportedMediaTypes" ,
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServerMediaTypesResponseDto"
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-07-16 03:24:46 +02:00
}
} ,
"tags" : [
2024-06-28 18:08:19 +02:00
"Server Info" ,
"Deprecated"
] ,
"x-immich-lifecycle" : {
"deprecatedAt" : "v1.107.0"
}
2023-07-16 03:24:46 +02:00
}
} ,
2023-06-10 06:14:18 +02:00
"/server-info/ping" : {
2023-05-17 19:07:17 +02:00
"get" : {
2024-06-28 18:08:19 +02:00
"deprecated" : true ,
"description" : "This property was deprecated in v1.107.0" ,
2023-06-10 06:14:18 +02:00
"operationId" : "pingServer" ,
2023-05-17 19:07:17 +02:00
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/ServerPingResponse"
2023-05-17 19:07:17 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-05-17 19:07:17 +02:00
}
} ,
"tags" : [
2024-06-28 18:08:19 +02:00
"Server Info" ,
"Deprecated"
] ,
"x-immich-lifecycle" : {
"deprecatedAt" : "v1.107.0"
}
2023-05-17 19:07:17 +02:00
}
} ,
2023-11-04 03:33:15 +02:00
"/server-info/statistics" : {
2023-05-17 19:07:17 +02:00
"get" : {
2024-06-28 18:08:19 +02:00
"deprecated" : true ,
"description" : "This property was deprecated in v1.107.0" ,
2023-11-04 03:33:15 +02:00
"operationId" : "getServerStatistics" ,
2023-06-10 06:14:18 +02:00
"parameters" : [ ] ,
2023-05-17 19:07:17 +02:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/ServerStatsResponseDto"
2023-05-17 19:07:17 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-05-17 19:07:17 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-06-28 18:08:19 +02:00
"Server Info" ,
"Deprecated"
] ,
"x-immich-lifecycle" : {
"deprecatedAt" : "v1.107.0"
}
2023-06-10 06:14:18 +02:00
}
} ,
2024-05-22 11:25:55 +02:00
"/server-info/storage" : {
"get" : {
2024-06-28 18:08:19 +02:00
"deprecated" : true ,
"description" : "This property was deprecated in v1.107.0" ,
2024-05-22 11:25:55 +02:00
"operationId" : "getStorage" ,
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServerStorageResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-06-28 18:08:19 +02:00
"Server Info" ,
"Deprecated"
] ,
"x-immich-lifecycle" : {
"deprecatedAt" : "v1.107.0"
}
2024-05-22 11:25:55 +02:00
}
} ,
2023-10-26 00:13:05 +02:00
"/server-info/theme" : {
"get" : {
2024-06-28 18:08:19 +02:00
"deprecated" : true ,
"description" : "This property was deprecated in v1.107.0" ,
2023-10-26 00:13:05 +02:00
"operationId" : "getTheme" ,
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServerThemeDto"
}
}
} ,
"description" : ""
}
} ,
"tags" : [
2024-06-28 18:08:19 +02:00
"Server Info" ,
"Deprecated"
] ,
"x-immich-lifecycle" : {
"deprecatedAt" : "v1.107.0"
}
2023-10-26 00:13:05 +02:00
}
} ,
2023-06-10 06:14:18 +02:00
"/server-info/version" : {
"get" : {
2024-06-28 18:08:19 +02:00
"deprecated" : true ,
"description" : "This property was deprecated in v1.107.0" ,
2023-06-10 06:14:18 +02:00
"operationId" : "getServerVersion" ,
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-08-18 06:55:26 +02:00
"$ref" : "#/components/schemas/ServerVersionResponseDto"
2023-06-10 06:14:18 +02:00
}
2023-05-17 19:07:17 +02:00
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-05-17 19:07:17 +02:00
}
} ,
2023-06-10 06:14:18 +02:00
"tags" : [
2024-06-28 18:08:19 +02:00
"Server Info" ,
"Deprecated"
] ,
"x-immich-lifecycle" : {
"deprecatedAt" : "v1.107.0"
}
2023-06-10 06:14:18 +02:00
}
} ,
2024-07-01 19:43:16 +02:00
"/server/license" : {
"delete" : {
"operationId" : "deleteServerLicense" ,
"parameters" : [ ] ,
"responses" : {
"200" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Server"
]
} ,
"get" : {
"operationId" : "getServerLicense" ,
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2024-07-22 15:50:45 +02:00
"$ref" : "#/components/schemas/LicenseResponseDto"
2024-07-01 19:43:16 +02:00
}
}
} ,
"description" : ""
2024-07-22 15:50:45 +02:00
} ,
"404" : {
"description" : ""
2024-07-01 19:43:16 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Server"
]
} ,
"put" : {
"operationId" : "setServerLicense" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LicenseKeyDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LicenseResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Server"
]
}
} ,
2024-04-19 12:47:29 +02:00
"/sessions" : {
"delete" : {
"operationId" : "deleteAllSessions" ,
"parameters" : [ ] ,
"responses" : {
"204" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Sessions"
]
} ,
"get" : {
"operationId" : "getSessions" ,
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/SessionResponseDto"
} ,
"type" : "array"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Sessions"
]
}
} ,
"/sessions/{id}" : {
"delete" : {
"operationId" : "deleteSession" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"responses" : {
"204" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Sessions"
]
}
} ,
2024-05-22 19:24:57 +02:00
"/shared-links" : {
2023-06-10 06:14:18 +02:00
"get" : {
"operationId" : "getAllSharedLinks" ,
"parameters" : [ ] ,
2023-05-17 19:07:17 +02:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 06:14:18 +02:00
"items" : {
"$ref" : "#/components/schemas/SharedLinkResponseDto"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-05-17 19:07:17 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-05-17 19:07:17 +02:00
}
} ,
2023-06-21 03:08:43 +02:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Shared Links"
2023-06-21 03:08:43 +02:00
]
} ,
"post" : {
"operationId" : "createSharedLink" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SharedLinkCreateDto"
}
}
2023-08-01 18:49:18 +02:00
} ,
"required" : true
2023-06-21 03:08:43 +02:00
} ,
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SharedLinkResponseDto"
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-06-21 03:08:43 +02:00
}
} ,
2023-05-17 19:07:17 +02:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Shared Links"
2023-05-17 19:07:17 +02:00
]
}
} ,
2024-05-22 19:24:57 +02:00
"/shared-links/me" : {
2023-05-17 19:07:17 +02:00
"get" : {
2023-06-10 06:14:18 +02:00
"operationId" : "getMySharedLink" ,
2023-05-17 19:07:17 +02:00
"parameters" : [
2023-10-29 03:35:38 +02:00
{
2024-01-22 18:49:51 +02:00
"name" : "key" ,
2023-10-29 03:35:38 +02:00
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
2024-01-22 18:49:51 +02:00
"name" : "password" ,
2023-10-29 03:35:38 +02:00
"required" : false ,
"in" : "query" ,
2024-01-22 18:49:51 +02:00
"example" : "password" ,
2023-10-29 03:35:38 +02:00
"schema" : {
"type" : "string"
}
} ,
2023-05-17 19:07:17 +02:00
{
2024-01-22 18:49:51 +02:00
"name" : "token" ,
2023-06-10 06:14:18 +02:00
"required" : false ,
"in" : "query" ,
2023-05-17 19:07:17 +02:00
"schema" : {
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
"content" : {
2023-06-10 06:14:18 +02:00
"application/json" : {
2023-05-17 19:07:17 +02:00
"schema" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/SharedLinkResponseDto"
2023-05-17 19:07:17 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-05-17 19:07:17 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Shared Links"
2023-05-17 19:07:17 +02:00
]
}
} ,
2024-05-22 19:24:57 +02:00
"/shared-links/{id}" : {
2023-08-01 18:49:18 +02:00
"delete" : {
"operationId" : "removeSharedLink" ,
2023-05-17 19:07:17 +02:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
2023-08-01 18:49:18 +02:00
"description" : ""
2023-05-17 19:07:17 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Shared Links"
2023-05-17 19:07:17 +02:00
]
2023-06-10 06:14:18 +02:00
} ,
2023-08-01 18:49:18 +02:00
"get" : {
"operationId" : "getSharedLinkById" ,
2023-02-24 18:01:10 +02:00
"parameters" : [
{
2023-06-10 06:14:18 +02:00
"name" : "id" ,
"required" : true ,
"in" : "path" ,
2023-02-24 18:01:10 +02:00
"schema" : {
2023-06-10 06:14:18 +02:00
"format" : "uuid" ,
2023-02-24 18:01:10 +02:00
"type" : "string"
}
}
] ,
2022-12-05 19:56:44 +02:00
"responses" : {
2023-06-10 06:14:18 +02:00
"200" : {
2022-12-05 19:56:44 +02:00
"content" : {
"application/json" : {
"schema" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/SharedLinkResponseDto"
2022-12-05 19:56:44 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2022-12-05 19:56:44 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 18:01:10 +02:00
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2022-12-05 19:56:44 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Shared Links"
2022-12-05 19:56:44 +02:00
]
2023-06-10 06:14:18 +02:00
} ,
2023-08-01 18:49:18 +02:00
"patch" : {
"operationId" : "updateSharedLink" ,
2023-01-24 06:13:42 +02:00
"parameters" : [
{
2023-06-02 04:19:25 +02:00
"name" : "id" ,
2023-01-24 06:13:42 +02:00
"required" : true ,
"in" : "path" ,
"schema" : {
2023-04-05 00:24:08 +02:00
"format" : "uuid" ,
2023-01-24 06:13:42 +02:00
"type" : "string"
2022-12-05 19:56:44 +02:00
}
}
2023-01-24 06:13:42 +02:00
] ,
2023-08-01 18:49:18 +02:00
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SharedLinkEditDto"
}
}
} ,
"required" : true
} ,
2022-12-05 19:56:44 +02:00
"responses" : {
2023-01-24 06:13:42 +02:00
"200" : {
2023-08-01 18:49:18 +02:00
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SharedLinkResponseDto"
}
}
} ,
2023-02-24 18:01:10 +02:00
"description" : ""
2022-12-05 19:56:44 +02:00
}
} ,
2023-06-21 03:08:43 +02:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Shared Links"
2023-06-21 03:08:43 +02:00
]
}
} ,
2024-05-22 19:24:57 +02:00
"/shared-links/{id}/assets" : {
2023-08-01 18:49:18 +02:00
"delete" : {
"operationId" : "removeSharedLinkAssets" ,
2023-06-21 03:08:43 +02:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
{
"name" : "key" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AssetIdsDto"
}
}
2023-08-01 18:49:18 +02:00
} ,
"required" : true
2023-06-21 03:08:43 +02:00
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/AssetIdsResponseDto"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-06-21 03:08:43 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-06-21 03:08:43 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Shared Links"
2023-08-01 18:49:18 +02:00
]
2023-06-21 03:08:43 +02:00
} ,
2023-08-01 18:49:18 +02:00
"put" : {
"operationId" : "addSharedLinkAssets" ,
2023-06-21 03:08:43 +02:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
{
"name" : "key" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AssetIdsDto"
}
}
2023-08-01 18:49:18 +02:00
} ,
"required" : true
2023-06-21 03:08:43 +02:00
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/AssetIdsResponseDto"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-06-21 03:08:43 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-06-21 03:08:43 +02:00
}
} ,
2022-12-05 19:56:44 +02:00
"security" : [
{
"bearer" : [ ]
2023-02-24 18:01:10 +02:00
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2022-12-05 19:56:44 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Shared Links"
2022-12-05 19:56:44 +02:00
]
}
} ,
2024-04-16 07:26:37 +02:00
"/sync/delta-sync" : {
2024-04-29 05:24:21 +02:00
"post" : {
2024-04-16 07:26:37 +02:00
"operationId" : "getDeltaSync" ,
2024-04-29 05:24:21 +02:00
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AssetDeltaSyncDto"
2024-04-16 07:26:37 +02:00
}
}
2024-04-29 05:24:21 +02:00
} ,
"required" : true
} ,
2024-04-16 07:26:37 +02:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AssetDeltaSyncResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Sync"
]
}
} ,
"/sync/full-sync" : {
2024-04-29 05:24:21 +02:00
"post" : {
"operationId" : "getFullSyncForUser" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AssetFullSyncDto"
}
2024-04-16 07:26:37 +02:00
}
} ,
2024-04-29 05:24:21 +02:00
"required" : true
} ,
2024-04-16 07:26:37 +02:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/AssetResponseDto"
} ,
"type" : "array"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Sync"
]
}
} ,
2023-06-10 06:14:18 +02:00
"/system-config" : {
"get" : {
"operationId" : "getConfig" ,
"parameters" : [ ] ,
2022-12-05 19:56:44 +02:00
"responses" : {
2023-02-24 18:01:10 +02:00
"200" : {
2022-12-05 19:56:44 +02:00
"content" : {
2023-06-10 06:14:18 +02:00
"application/json" : {
2022-12-05 19:56:44 +02:00
"schema" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/SystemConfigDto"
2022-12-05 19:56:44 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2022-12-05 19:56:44 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 18:01:10 +02:00
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2022-12-05 19:56:44 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
"System Config"
2022-12-05 19:56:44 +02:00
]
2023-06-10 06:14:18 +02:00
} ,
"put" : {
"operationId" : "updateConfig" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SystemConfigDto"
}
2023-02-24 18:01:10 +02:00
}
2023-08-01 18:49:18 +02:00
} ,
"required" : true
2023-06-10 06:14:18 +02:00
} ,
2022-12-05 19:56:44 +02:00
"responses" : {
"200" : {
"content" : {
2023-06-10 06:14:18 +02:00
"application/json" : {
2022-12-05 19:56:44 +02:00
"schema" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/SystemConfigDto"
2022-12-05 19:56:44 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2022-12-05 19:56:44 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 18:01:10 +02:00
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2022-12-05 19:56:44 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
"System Config"
2022-12-05 19:56:44 +02:00
]
}
} ,
2023-06-10 06:14:18 +02:00
"/system-config/defaults" : {
2022-12-05 19:56:44 +02:00
"get" : {
2023-11-04 03:33:15 +02:00
"operationId" : "getConfigDefaults" ,
2023-06-10 06:14:18 +02:00
"parameters" : [ ] ,
2022-12-05 19:56:44 +02:00
"responses" : {
"200" : {
"content" : {
2023-06-10 06:14:18 +02:00
"application/json" : {
2022-12-05 19:56:44 +02:00
"schema" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/SystemConfigDto"
2022-12-05 19:56:44 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2022-12-05 19:56:44 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 18:01:10 +02:00
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2022-12-05 19:56:44 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
"System Config"
2022-12-05 19:56:44 +02:00
]
2023-01-24 06:13:42 +02:00
}
} ,
2023-06-10 06:14:18 +02:00
"/system-config/storage-template-options" : {
2023-01-24 06:13:42 +02:00
"get" : {
2023-06-10 06:14:18 +02:00
"operationId" : "getStorageTemplateOptions" ,
"parameters" : [ ] ,
2022-12-05 19:56:44 +02:00
"responses" : {
"200" : {
"content" : {
2023-06-10 06:14:18 +02:00
"application/json" : {
2022-12-05 19:56:44 +02:00
"schema" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/SystemConfigTemplateStorageOptionDto"
2022-12-05 19:56:44 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2022-12-05 19:56:44 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 18:01:10 +02:00
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2022-12-05 19:56:44 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
"System Config"
2022-12-05 19:56:44 +02:00
]
}
} ,
2024-04-20 02:36:15 +02:00
"/system-metadata/admin-onboarding" : {
"get" : {
"operationId" : "getAdminOnboarding" ,
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AdminOnboardingUpdateDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"System Metadata"
]
} ,
"post" : {
"operationId" : "updateAdminOnboarding" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AdminOnboardingUpdateDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"204" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"System Metadata"
]
}
} ,
"/system-metadata/reverse-geocoding-state" : {
"get" : {
"operationId" : "getReverseGeocodingState" ,
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ReverseGeocodingStateResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"System Metadata"
]
}
} ,
2024-05-22 19:24:57 +02:00
"/tags" : {
2023-08-01 18:49:18 +02:00
"get" : {
"operationId" : "getAllTags" ,
2022-12-05 19:56:44 +02:00
"parameters" : [ ] ,
"responses" : {
2023-08-01 18:49:18 +02:00
"200" : {
2022-12-05 19:56:44 +02:00
"content" : {
"application/json" : {
"schema" : {
2023-08-01 18:49:18 +02:00
"items" : {
"$ref" : "#/components/schemas/TagResponseDto"
} ,
"type" : "array"
2022-12-05 19:56:44 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2022-12-05 19:56:44 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 18:01:10 +02:00
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2022-12-05 19:56:44 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Tags"
2022-12-05 19:56:44 +02:00
]
2023-06-10 06:14:18 +02:00
} ,
2023-08-01 18:49:18 +02:00
"post" : {
"operationId" : "createTag" ,
2023-01-24 06:13:42 +02:00
"parameters" : [ ] ,
2023-08-01 18:49:18 +02:00
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateTagDto"
}
}
} ,
"required" : true
} ,
2022-12-05 19:56:44 +02:00
"responses" : {
2023-08-01 18:49:18 +02:00
"201" : {
2022-12-05 19:56:44 +02:00
"content" : {
"application/json" : {
"schema" : {
2023-08-01 18:49:18 +02:00
"$ref" : "#/components/schemas/TagResponseDto"
2022-12-05 19:56:44 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2022-12-05 19:56:44 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 18:01:10 +02:00
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2022-12-05 19:56:44 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Tags"
2022-12-05 19:56:44 +02:00
]
}
} ,
2024-05-22 19:24:57 +02:00
"/tags/{id}" : {
2023-08-01 18:49:18 +02:00
"delete" : {
"operationId" : "deleteTag" ,
2023-06-10 06:14:18 +02:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
2022-12-05 19:56:44 +02:00
"responses" : {
"200" : {
2023-08-01 18:49:18 +02:00
"description" : ""
2022-12-05 19:56:44 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 18:01:10 +02:00
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2022-12-05 19:56:44 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Tags"
2022-12-05 19:56:44 +02:00
]
2023-06-10 06:14:18 +02:00
} ,
2023-08-01 18:49:18 +02:00
"get" : {
"operationId" : "getTagById" ,
2023-06-10 06:14:18 +02:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
2022-12-05 19:56:44 +02:00
"responses" : {
2023-06-10 06:14:18 +02:00
"200" : {
2022-12-05 19:56:44 +02:00
"content" : {
"application/json" : {
"schema" : {
2024-03-29 05:20:40 +02:00
"$ref" : "#/components/schemas/TagResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Tags"
2024-03-29 05:20:40 +02:00
]
} ,
"patch" : {
"operationId" : "updateTag" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateTagDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TagResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Tags"
2024-03-29 05:20:40 +02:00
]
}
} ,
2024-05-22 19:24:57 +02:00
"/tags/{id}/assets" : {
2024-03-29 05:20:40 +02:00
"delete" : {
"operationId" : "untagAssets" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AssetIdsDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/AssetIdsResponseDto"
} ,
"type" : "array"
2022-12-05 19:56:44 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2022-12-05 19:56:44 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 18:01:10 +02:00
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2022-12-05 19:56:44 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Tags"
2022-12-05 19:56:44 +02:00
]
2023-06-10 06:14:18 +02:00
} ,
2024-03-29 05:20:40 +02:00
"get" : {
"operationId" : "getTagAssets" ,
2023-06-10 06:14:18 +02:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
2022-12-05 19:56:44 +02:00
}
}
2023-06-10 06:14:18 +02:00
] ,
2022-12-05 19:56:44 +02:00
"responses" : {
2023-06-10 06:14:18 +02:00
"200" : {
2023-08-01 18:49:18 +02:00
"content" : {
"application/json" : {
"schema" : {
2024-03-29 05:20:40 +02:00
"items" : {
"$ref" : "#/components/schemas/AssetResponseDto"
} ,
"type" : "array"
2023-08-01 18:49:18 +02:00
}
}
} ,
2023-06-10 06:14:18 +02:00
"description" : ""
2022-12-05 19:56:44 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 18:01:10 +02:00
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2022-12-05 19:56:44 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Tags"
2022-12-05 19:56:44 +02:00
]
2024-03-29 05:20:40 +02:00
} ,
"put" : {
"operationId" : "tagAssets" ,
2023-06-10 06:14:18 +02:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
2023-08-01 18:49:18 +02:00
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AssetIdsDto"
}
}
} ,
"required" : true
} ,
2022-12-05 19:56:44 +02:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 06:14:18 +02:00
"items" : {
2023-08-01 18:49:18 +02:00
"$ref" : "#/components/schemas/AssetIdsResponseDto"
} ,
"type" : "array"
2022-12-05 19:56:44 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2022-12-05 19:56:44 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 18:01:10 +02:00
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2022-12-05 19:56:44 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Tags"
2022-12-05 19:56:44 +02:00
]
2024-03-29 05:20:40 +02:00
}
} ,
"/timeline/bucket" : {
2023-08-01 18:49:18 +02:00
"get" : {
2024-03-29 05:20:40 +02:00
"operationId" : "getTimeBucket" ,
2023-06-10 06:14:18 +02:00
"parameters" : [
{
2024-03-29 05:20:40 +02:00
"name" : "albumId" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
{
"name" : "isArchived" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "isFavorite" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "isTrashed" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "key" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "order" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"$ref" : "#/components/schemas/AssetOrder"
}
} ,
{
"name" : "personId" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
{
"name" : "size" ,
2023-06-10 06:14:18 +02:00
"required" : true ,
2024-03-29 05:20:40 +02:00
"in" : "query" ,
"schema" : {
"$ref" : "#/components/schemas/TimeBucketSize"
}
} ,
{
"name" : "timeBucket" ,
"required" : true ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "userId" ,
"required" : false ,
"in" : "query" ,
2023-06-10 06:14:18 +02:00
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
2024-03-29 05:20:40 +02:00
} ,
{
"name" : "withPartners" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "withStacked" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
2023-06-10 06:14:18 +02:00
}
] ,
2023-04-12 17:37:52 +02:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 06:14:18 +02:00
"items" : {
2023-08-01 18:49:18 +02:00
"$ref" : "#/components/schemas/AssetResponseDto"
} ,
"type" : "array"
2023-04-12 17:37:52 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-04-12 17:37:52 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2023-04-12 17:37:52 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-03-29 05:20:40 +02:00
"Timeline"
2023-04-12 17:37:52 +02:00
]
2024-03-29 05:20:40 +02:00
}
} ,
"/timeline/buckets" : {
"get" : {
"operationId" : "getTimeBuckets" ,
2023-01-24 06:13:42 +02:00
"parameters" : [
2023-05-25 05:52:43 +02:00
{
2024-03-29 05:20:40 +02:00
"name" : "albumId" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
{
"name" : "isArchived" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "isFavorite" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "isTrashed" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "key" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "order" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"$ref" : "#/components/schemas/AssetOrder"
}
} ,
{
"name" : "personId" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
{
"name" : "size" ,
2023-06-10 06:14:18 +02:00
"required" : true ,
2024-03-29 05:20:40 +02:00
"in" : "query" ,
"schema" : {
"$ref" : "#/components/schemas/TimeBucketSize"
}
} ,
{
"name" : "userId" ,
"required" : false ,
"in" : "query" ,
2023-05-25 05:52:43 +02:00
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
2024-03-29 05:20:40 +02:00
} ,
{
"name" : "withPartners" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
2023-06-10 06:14:18 +02:00
}
2023-08-01 18:49:18 +02:00
} ,
2024-03-29 05:20:40 +02:00
{
"name" : "withStacked" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
}
] ,
2023-01-15 07:49:47 +02:00
"responses" : {
2023-01-24 06:13:42 +02:00
"200" : {
2023-01-15 07:49:47 +02:00
"content" : {
"application/json" : {
"schema" : {
2023-01-24 06:13:42 +02:00
"items" : {
2024-03-29 05:20:40 +02:00
"$ref" : "#/components/schemas/TimeBucketResponseDto"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-01-15 07:49:47 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-01-15 07:49:47 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 18:01:10 +02:00
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2023-01-15 07:49:47 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-03-29 05:20:40 +02:00
"Timeline"
2023-01-15 07:49:47 +02:00
]
2023-06-10 06:14:18 +02:00
}
} ,
2024-01-26 18:48:37 +02:00
"/trash/empty" : {
"post" : {
"operationId" : "emptyTrash" ,
"parameters" : [ ] ,
"responses" : {
"204" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Trash"
]
}
} ,
"/trash/restore" : {
"post" : {
"operationId" : "restoreTrash" ,
"parameters" : [ ] ,
"responses" : {
"204" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Trash"
]
}
} ,
"/trash/restore/assets" : {
"post" : {
"operationId" : "restoreAssets" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BulkIdsDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"204" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Trash"
]
}
} ,
2024-05-22 19:24:57 +02:00
"/users" : {
2023-06-10 06:14:18 +02:00
"get" : {
2024-05-27 00:15:52 +02:00
"operationId" : "searchUsers" ,
"parameters" : [ ] ,
2023-01-15 07:49:47 +02:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-01-24 06:13:42 +02:00
"items" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/UserResponseDto"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-01-15 07:49:47 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-01-15 07:49:47 +02:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 18:01:10 +02:00
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2023-01-15 07:49:47 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Users"
2023-01-15 07:49:47 +02:00
]
2024-05-27 00:15:52 +02:00
}
} ,
"/users/me" : {
"get" : {
"operationId" : "getMyUser" ,
2022-12-05 19:56:44 +02:00
"parameters" : [ ] ,
"responses" : {
2024-05-27 00:15:52 +02:00
"200" : {
2022-12-05 19:56:44 +02:00
"content" : {
"application/json" : {
"schema" : {
2024-05-27 00:15:52 +02:00
"$ref" : "#/components/schemas/UserAdminResponseDto"
2022-12-05 19:56:44 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2022-12-05 19:56:44 +02:00
}
} ,
2023-01-24 06:13:42 +02:00
"security" : [
{
"bearer" : [ ]
2023-02-24 18:01:10 +02:00
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2023-01-24 06:13:42 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Users"
2022-12-05 19:56:44 +02:00
]
2023-06-10 06:14:18 +02:00
} ,
"put" : {
2024-05-27 00:15:52 +02:00
"operationId" : "updateMyUser" ,
2023-06-10 06:14:18 +02:00
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
2024-05-27 00:15:52 +02:00
"$ref" : "#/components/schemas/UserUpdateMeDto"
2023-06-10 06:14:18 +02:00
}
2022-12-05 19:56:44 +02:00
}
2023-08-01 18:49:18 +02:00
} ,
"required" : true
2023-06-10 06:14:18 +02:00
} ,
2022-12-05 19:56:44 +02:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2024-05-27 00:15:52 +02:00
"$ref" : "#/components/schemas/UserAdminResponseDto"
2023-01-15 22:01:10 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-01-15 22:01:10 +02:00
}
} ,
2023-02-24 18:01:10 +02:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2023-02-24 18:01:10 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Users"
2023-01-15 22:01:10 +02:00
]
2023-06-01 03:51:28 +02:00
}
} ,
2024-07-01 19:43:16 +02:00
"/users/me/license" : {
"delete" : {
"operationId" : "deleteUserLicense" ,
"parameters" : [ ] ,
"responses" : {
"200" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Users"
]
} ,
"get" : {
"operationId" : "getUserLicense" ,
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LicenseResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Users"
]
} ,
"put" : {
"operationId" : "setUserLicense" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LicenseKeyDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LicenseResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Users"
]
}
} ,
2024-05-28 04:16:53 +02:00
"/users/me/preferences" : {
"get" : {
"operationId" : "getMyPreferences" ,
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UserPreferencesResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Users"
2024-05-28 04:16:53 +02:00
]
} ,
"put" : {
"operationId" : "updateMyPreferences" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UserPreferencesUpdateDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UserPreferencesResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Users"
2024-05-28 04:16:53 +02:00
]
}
} ,
2024-05-22 19:24:57 +02:00
"/users/profile-image" : {
2023-11-14 05:10:35 +02:00
"delete" : {
"operationId" : "deleteProfileImage" ,
"parameters" : [ ] ,
"responses" : {
"204" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Users"
2023-11-14 05:10:35 +02:00
]
} ,
2023-06-01 03:51:28 +02:00
"post" : {
2023-06-10 06:14:18 +02:00
"operationId" : "createProfileImage" ,
2023-01-15 22:01:10 +02:00
"parameters" : [ ] ,
2023-06-01 03:51:28 +02:00
"requestBody" : {
"content" : {
2023-06-10 06:14:18 +02:00
"multipart/form-data" : {
2023-06-01 03:51:28 +02:00
"schema" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/CreateProfileImageDto"
2023-06-01 03:51:28 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : "A new avatar for the user" ,
"required" : true
2023-06-01 03:51:28 +02:00
} ,
2023-01-15 22:01:10 +02:00
"responses" : {
2023-06-10 06:14:18 +02:00
"201" : {
2023-01-15 22:01:10 +02:00
"content" : {
"application/json" : {
"schema" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/CreateProfileImageResponseDto"
2023-01-15 22:01:10 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-01-15 22:01:10 +02:00
}
} ,
2023-02-24 18:01:10 +02:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2023-02-24 18:01:10 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Users"
2023-01-15 22:01:10 +02:00
]
}
} ,
2024-05-22 20:31:12 +02:00
"/users/{id}" : {
"get" : {
2024-05-27 00:15:52 +02:00
"operationId" : "getUser" ,
2023-01-15 22:01:10 +02:00
"parameters" : [
{
2023-08-03 20:17:38 +02:00
"name" : "id" ,
2023-06-10 06:14:18 +02:00
"required" : true ,
"in" : "path" ,
2023-01-15 22:01:10 +02:00
"schema" : {
2023-06-10 06:14:18 +02:00
"format" : "uuid" ,
2023-01-15 22:01:10 +02:00
"type" : "string"
}
}
] ,
2024-05-22 20:15:33 +02:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UserResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Users"
2024-05-22 20:15:33 +02:00
]
2024-05-22 20:31:12 +02:00
}
} ,
"/users/{id}/profile-image" : {
2024-05-22 20:15:33 +02:00
"get" : {
2024-05-22 20:31:12 +02:00
"operationId" : "getProfileImage" ,
2024-05-22 20:15:33 +02:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
2023-01-15 22:01:10 +02:00
"responses" : {
"200" : {
"content" : {
2024-05-22 20:31:12 +02:00
"application/octet-stream" : {
2023-01-15 22:01:10 +02:00
"schema" : {
2024-05-22 20:31:12 +02:00
"format" : "binary" ,
"type" : "string"
2023-01-15 22:01:10 +02:00
}
}
2023-08-01 18:49:18 +02:00
} ,
"description" : ""
2023-01-15 22:01:10 +02:00
}
} ,
2023-02-24 18:01:10 +02:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 18:41:29 +02:00
} ,
{
"api_key" : [ ]
2023-02-24 18:01:10 +02:00
}
2023-08-01 18:49:18 +02:00
] ,
"tags" : [
2024-05-30 00:26:57 +02:00
"Users"
2023-01-15 22:01:10 +02:00
]
2023-06-01 03:51:28 +02:00
}
2023-06-10 06:14:18 +02:00
}
} ,
"info" : {
"title" : "Immich" ,
"description" : "Immich API" ,
2024-08-15 02:00:22 +02:00
"version" : "1.112.1" ,
2023-06-10 06:14:18 +02:00
"contact" : { }
} ,
"tags" : [ ] ,
"servers" : [
{
"url" : "/api"
}
] ,
"components" : {
"securitySchemes" : {
"bearer" : {
"scheme" : "Bearer" ,
"bearerFormat" : "JWT" ,
"type" : "http" ,
"in" : "header"
} ,
"cookie" : {
"type" : "apiKey" ,
"in" : "cookie" ,
"name" : "immich_access_token"
} ,
"api_key" : {
"type" : "apiKey" ,
"in" : "header" ,
"name" : "x-api-key"
}
2023-01-15 22:01:10 +02:00
} ,
2023-06-10 06:14:18 +02:00
"schemas" : {
"APIKeyCreateDto" : {
2023-05-25 04:10:45 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"name" : {
2023-05-25 04:10:45 +02:00
"type" : "string"
}
2023-08-01 18:49:18 +02:00
} ,
"type" : "object"
2023-05-25 04:10:45 +02:00
} ,
2023-06-10 06:14:18 +02:00
"APIKeyCreateResponseDto" : {
2023-05-25 21:37:19 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"apiKey" : {
"$ref" : "#/components/schemas/APIKeyResponseDto"
2023-08-01 18:49:18 +02:00
} ,
"secret" : {
"type" : "string"
2023-06-07 16:37:25 +02:00
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"apiKey" ,
"secret"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-06-07 16:37:25 +02:00
} ,
2023-03-26 04:46:48 +02:00
"APIKeyResponseDto" : {
2023-03-20 17:55:28 +02:00
"properties" : {
2023-08-01 18:49:18 +02:00
"createdAt" : {
"format" : "date-time" ,
2023-03-26 04:46:48 +02:00
"type" : "string"
2023-03-20 17:55:28 +02:00
} ,
2023-08-01 18:49:18 +02:00
"id" : {
2023-03-26 04:46:48 +02:00
"type" : "string"
2023-03-20 17:55:28 +02:00
} ,
2023-08-01 18:49:18 +02:00
"name" : {
2023-03-26 04:46:48 +02:00
"type" : "string"
2023-03-20 17:55:28 +02:00
} ,
2023-03-26 04:46:48 +02:00
"updatedAt" : {
2023-05-30 15:15:56 +02:00
"format" : "date-time" ,
2023-03-26 04:46:48 +02:00
"type" : "string"
2023-03-20 17:55:28 +02:00
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"createdAt" ,
2023-03-26 04:46:48 +02:00
"id" ,
"name" ,
"updatedAt"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-03-20 17:55:28 +02:00
} ,
2023-03-26 04:46:48 +02:00
"APIKeyUpdateDto" : {
2023-01-24 06:13:42 +02:00
"properties" : {
2023-03-26 04:46:48 +02:00
"name" : {
2023-01-24 06:13:42 +02:00
"type" : "string"
}
} ,
"required" : [
2023-03-26 04:46:48 +02:00
"name"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-01-24 06:13:42 +02:00
} ,
2023-11-01 05:13:34 +02:00
"ActivityCreateDto" : {
"properties" : {
"albumId" : {
"format" : "uuid" ,
"type" : "string"
} ,
"assetId" : {
"format" : "uuid" ,
"type" : "string"
} ,
"comment" : {
"type" : "string"
} ,
"type" : {
"$ref" : "#/components/schemas/ReactionType"
}
} ,
"required" : [
"albumId" ,
"type"
] ,
"type" : "object"
} ,
"ActivityResponseDto" : {
"properties" : {
"assetId" : {
"nullable" : true ,
"type" : "string"
} ,
"comment" : {
"nullable" : true ,
"type" : "string"
} ,
"createdAt" : {
"format" : "date-time" ,
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"type" : {
2024-07-31 19:08:31 +02:00
"$ref" : "#/components/schemas/ReactionType"
2023-11-01 05:13:34 +02:00
} ,
"user" : {
2024-05-27 00:15:52 +02:00
"$ref" : "#/components/schemas/UserResponseDto"
2023-11-01 05:13:34 +02:00
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"assetId" ,
2023-11-01 05:13:34 +02:00
"createdAt" ,
2024-01-22 18:49:51 +02:00
"id" ,
2023-11-01 05:13:34 +02:00
"type" ,
2024-01-22 18:49:51 +02:00
"user"
2023-11-01 05:13:34 +02:00
] ,
"type" : "object"
} ,
"ActivityStatisticsResponseDto" : {
"properties" : {
"comments" : {
"type" : "integer"
}
} ,
"required" : [
"comments"
] ,
"type" : "object"
} ,
2023-06-10 06:14:18 +02:00
"AddUsersDto" : {
2023-03-26 04:46:48 +02:00
"properties" : {
2024-04-25 06:19:49 +02:00
"albumUsers" : {
"items" : {
"$ref" : "#/components/schemas/AlbumUserAddDto"
} ,
"type" : "array"
2023-03-26 04:46:48 +02:00
}
} ,
"required" : [
2024-04-25 06:19:49 +02:00
"albumUsers"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-03-26 04:46:48 +02:00
} ,
2024-04-20 02:36:15 +02:00
"AdminOnboardingUpdateDto" : {
"properties" : {
"isOnboarded" : {
"type" : "boolean"
}
} ,
"required" : [
"isOnboarded"
] ,
"type" : "object"
} ,
2023-06-10 06:14:18 +02:00
"AlbumCountResponseDto" : {
"properties" : {
2023-08-01 18:49:18 +02:00
"notShared" : {
2023-06-10 06:14:18 +02:00
"type" : "integer"
} ,
2023-08-01 18:49:18 +02:00
"owned" : {
2023-06-10 06:14:18 +02:00
"type" : "integer"
} ,
2023-08-01 18:49:18 +02:00
"shared" : {
2023-06-10 06:14:18 +02:00
"type" : "integer"
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"notShared" ,
2023-06-10 06:14:18 +02:00
"owned" ,
2024-01-22 18:49:51 +02:00
"shared"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-06-10 06:14:18 +02:00
} ,
"AlbumResponseDto" : {
2023-04-26 04:19:23 +02:00
"properties" : {
2023-08-01 18:49:18 +02:00
"albumName" : {
2023-04-26 04:19:23 +02:00
"type" : "string"
} ,
2023-08-01 18:49:18 +02:00
"albumThumbnailAssetId" : {
"nullable" : true ,
2023-06-10 06:14:18 +02:00
"type" : "string"
} ,
2024-04-25 06:19:49 +02:00
"albumUsers" : {
"items" : {
"$ref" : "#/components/schemas/AlbumUserResponseDto"
} ,
"type" : "array"
} ,
2023-08-01 18:49:18 +02:00
"assetCount" : {
"type" : "integer"
} ,
"assets" : {
"items" : {
"$ref" : "#/components/schemas/AssetResponseDto"
} ,
"type" : "array"
2023-06-10 06:14:18 +02:00
} ,
2023-04-26 04:19:23 +02:00
"createdAt" : {
2023-06-10 06:14:18 +02:00
"format" : "date-time" ,
2023-04-26 04:19:23 +02:00
"type" : "string"
} ,
2023-08-06 04:43:26 +02:00
"description" : {
"type" : "string"
} ,
2023-08-11 18:00:51 +02:00
"endDate" : {
"format" : "date-time" ,
"type" : "string"
} ,
"hasSharedLink" : {
"type" : "boolean"
} ,
2023-08-01 18:49:18 +02:00
"id" : {
"type" : "string"
} ,
2023-11-07 06:37:21 +02:00
"isActivityEnabled" : {
"type" : "boolean"
} ,
2023-08-01 18:49:18 +02:00
"lastModifiedAssetTimestamp" : {
2023-06-10 06:14:18 +02:00
"format" : "date-time" ,
2023-04-26 04:19:23 +02:00
"type" : "string"
} ,
2024-03-14 18:45:03 +02:00
"order" : {
"$ref" : "#/components/schemas/AssetOrder"
} ,
2023-08-01 18:49:18 +02:00
"owner" : {
"$ref" : "#/components/schemas/UserResponseDto"
} ,
"ownerId" : {
"type" : "string"
2023-06-10 06:14:18 +02:00
} ,
"shared" : {
2023-04-26 04:19:23 +02:00
"type" : "boolean"
} ,
2023-08-11 18:00:51 +02:00
"startDate" : {
"format" : "date-time" ,
"type" : "string"
} ,
2023-08-01 18:49:18 +02:00
"updatedAt" : {
2023-06-21 03:00:59 +02:00
"format" : "date-time" ,
"type" : "string"
2023-04-26 04:19:23 +02:00
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"albumName" ,
"albumThumbnailAssetId" ,
2024-04-25 06:19:49 +02:00
"albumUsers" ,
2023-06-10 06:14:18 +02:00
"assetCount" ,
2024-01-22 18:49:51 +02:00
"assets" ,
"createdAt" ,
"description" ,
"hasSharedLink" ,
2023-04-26 04:19:23 +02:00
"id" ,
2024-01-22 18:49:51 +02:00
"isActivityEnabled" ,
"owner" ,
2023-06-10 06:14:18 +02:00
"ownerId" ,
"shared" ,
2024-01-22 18:49:51 +02:00
"updatedAt"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-04-26 04:19:23 +02:00
} ,
2024-04-25 06:19:49 +02:00
"AlbumUserAddDto" : {
"properties" : {
"role" : {
"$ref" : "#/components/schemas/AlbumUserRole"
} ,
"userId" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
"required" : [
"userId"
] ,
"type" : "object"
} ,
2024-05-07 22:38:09 +02:00
"AlbumUserCreateDto" : {
"properties" : {
"role" : {
"$ref" : "#/components/schemas/AlbumUserRole"
} ,
"userId" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
"required" : [
"role" ,
"userId"
] ,
"type" : "object"
} ,
2024-04-25 06:19:49 +02:00
"AlbumUserResponseDto" : {
"properties" : {
"role" : {
"$ref" : "#/components/schemas/AlbumUserRole"
} ,
"user" : {
"$ref" : "#/components/schemas/UserResponseDto"
}
} ,
"required" : [
"role" ,
"user"
] ,
"type" : "object"
} ,
"AlbumUserRole" : {
"enum" : [
"editor" ,
"viewer"
] ,
"type" : "string"
} ,
2023-06-10 06:14:18 +02:00
"AllJobStatusResponseDto" : {
2023-03-26 04:46:48 +02:00
"properties" : {
2023-08-01 18:49:18 +02:00
"backgroundTask" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/JobStatusDto"
} ,
2024-05-16 19:08:37 +02:00
"duplicateDetection" : {
"$ref" : "#/components/schemas/JobStatusDto"
} ,
2024-01-18 07:08:48 +02:00
"faceDetection" : {
"$ref" : "#/components/schemas/JobStatusDto"
} ,
"facialRecognition" : {
"$ref" : "#/components/schemas/JobStatusDto"
} ,
2023-09-20 13:16:33 +02:00
"library" : {
"$ref" : "#/components/schemas/JobStatusDto"
} ,
2023-08-01 18:49:18 +02:00
"metadataExtraction" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/JobStatusDto"
} ,
2023-09-25 17:07:21 +02:00
"migration" : {
"$ref" : "#/components/schemas/JobStatusDto"
} ,
2024-05-02 16:43:18 +02:00
"notifications" : {
"$ref" : "#/components/schemas/JobStatusDto"
} ,
2023-08-01 18:49:18 +02:00
"search" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/JobStatusDto"
} ,
2023-08-01 18:49:18 +02:00
"sidecar" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/JobStatusDto"
} ,
2023-12-16 18:50:46 +02:00
"smartSearch" : {
"$ref" : "#/components/schemas/JobStatusDto"
} ,
2023-08-01 18:49:18 +02:00
"storageTemplateMigration" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/JobStatusDto"
} ,
2023-08-01 18:49:18 +02:00
"thumbnailGeneration" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/JobStatusDto"
} ,
2023-08-01 18:49:18 +02:00
"videoConversion" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/JobStatusDto"
}
} ,
"required" : [
"backgroundTask" ,
2024-05-16 19:08:37 +02:00
"duplicateDetection" ,
2024-01-18 07:08:48 +02:00
"faceDetection" ,
"facialRecognition" ,
2024-01-22 18:49:51 +02:00
"library" ,
"metadataExtraction" ,
"migration" ,
2024-05-02 16:43:18 +02:00
"notifications" ,
2024-01-22 18:49:51 +02:00
"search" ,
2023-09-20 13:16:33 +02:00
"sidecar" ,
2024-01-22 18:49:51 +02:00
"smartSearch" ,
"storageTemplateMigration" ,
"thumbnailGeneration" ,
"videoConversion"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-06-10 06:14:18 +02:00
} ,
2023-10-06 09:01:14 +02:00
"AssetBulkDeleteDto" : {
"properties" : {
"force" : {
"type" : "boolean"
} ,
"ids" : {
"items" : {
"format" : "uuid" ,
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"ids"
] ,
"type" : "object"
} ,
2023-08-16 22:04:55 +02:00
"AssetBulkUpdateDto" : {
"properties" : {
2023-11-30 05:52:28 +02:00
"dateTimeOriginal" : {
"type" : "string"
} ,
2024-05-23 19:57:25 +02:00
"duplicateId" : {
"nullable" : true ,
"type" : "string"
} ,
2023-08-16 22:04:55 +02:00
"ids" : {
"items" : {
"format" : "uuid" ,
"type" : "string"
} ,
"type" : "array"
} ,
"isArchived" : {
"type" : "boolean"
} ,
"isFavorite" : {
"type" : "boolean"
2023-10-22 04:38:07 +02:00
} ,
2023-11-30 05:52:28 +02:00
"latitude" : {
"type" : "number"
} ,
"longitude" : {
"type" : "number"
} ,
2024-08-09 19:45:52 +02:00
"rating" : {
"maximum" : 5 ,
"minimum" : 0 ,
"type" : "number"
} ,
2023-10-22 04:38:07 +02:00
"removeParent" : {
"type" : "boolean"
} ,
"stackParentId" : {
"format" : "uuid" ,
"type" : "string"
2023-08-16 22:04:55 +02:00
}
} ,
"required" : [
"ids"
] ,
"type" : "object"
} ,
2023-06-10 06:14:18 +02:00
"AssetBulkUploadCheckDto" : {
"properties" : {
"assets" : {
"items" : {
"$ref" : "#/components/schemas/AssetBulkUploadCheckItem"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-06-10 06:14:18 +02:00
}
} ,
"required" : [
"assets"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-06-10 06:14:18 +02:00
} ,
"AssetBulkUploadCheckItem" : {
"properties" : {
2023-08-01 18:49:18 +02:00
"checksum" : {
"description" : "base64 or hex encoded sha1 hash" ,
2023-06-10 06:14:18 +02:00
"type" : "string"
} ,
2023-08-01 18:49:18 +02:00
"id" : {
"type" : "string"
2023-06-10 06:14:18 +02:00
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"checksum" ,
"id"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-06-10 06:14:18 +02:00
} ,
"AssetBulkUploadCheckResponseDto" : {
"properties" : {
"results" : {
"items" : {
"$ref" : "#/components/schemas/AssetBulkUploadCheckResult"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-06-10 06:14:18 +02:00
}
} ,
"required" : [
"results"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-06-10 06:14:18 +02:00
} ,
"AssetBulkUploadCheckResult" : {
"properties" : {
"action" : {
"enum" : [
"accept" ,
"reject"
2023-08-01 18:49:18 +02:00
] ,
"type" : "string"
} ,
"assetId" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
2023-06-10 06:14:18 +02:00
} ,
"reason" : {
"enum" : [
"duplicate" ,
"unsupported-format"
2023-08-01 18:49:18 +02:00
] ,
2023-06-10 06:14:18 +02:00
"type" : "string"
2023-03-26 04:46:48 +02:00
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"action" ,
"id"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-03-26 04:46:48 +02:00
} ,
2024-04-29 05:24:21 +02:00
"AssetDeltaSyncDto" : {
"properties" : {
"updatedAfter" : {
"format" : "date-time" ,
"type" : "string"
} ,
"userIds" : {
"items" : {
"format" : "uuid" ,
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"updatedAfter" ,
"userIds"
] ,
"type" : "object"
} ,
2024-04-16 07:26:37 +02:00
"AssetDeltaSyncResponseDto" : {
"properties" : {
"deleted" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"needsFullSync" : {
"type" : "boolean"
} ,
"upserted" : {
"items" : {
"$ref" : "#/components/schemas/AssetResponseDto"
} ,
"type" : "array"
}
} ,
"required" : [
"deleted" ,
"needsFullSync" ,
"upserted"
] ,
"type" : "object"
} ,
2023-12-05 17:43:15 +02:00
"AssetFaceResponseDto" : {
"properties" : {
"boundingBoxX1" : {
"type" : "integer"
} ,
"boundingBoxX2" : {
"type" : "integer"
} ,
"boundingBoxY1" : {
"type" : "integer"
} ,
"boundingBoxY2" : {
"type" : "integer"
} ,
"id" : {
"format" : "uuid" ,
"type" : "string"
} ,
"imageHeight" : {
"type" : "integer"
} ,
"imageWidth" : {
"type" : "integer"
} ,
"person" : {
"allOf" : [
{
"$ref" : "#/components/schemas/PersonResponseDto"
}
] ,
"nullable" : true
}
} ,
"required" : [
"boundingBoxX1" ,
"boundingBoxX2" ,
"boundingBoxY1" ,
"boundingBoxY2" ,
2024-01-22 18:49:51 +02:00
"id" ,
"imageHeight" ,
"imageWidth" ,
2023-12-05 17:43:15 +02:00
"person"
] ,
"type" : "object"
} ,
"AssetFaceUpdateDto" : {
"properties" : {
"data" : {
"items" : {
"$ref" : "#/components/schemas/AssetFaceUpdateItem"
} ,
"type" : "array"
}
} ,
"required" : [
"data"
] ,
"type" : "object"
} ,
"AssetFaceUpdateItem" : {
"properties" : {
"assetId" : {
"format" : "uuid" ,
"type" : "string"
} ,
"personId" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"assetId" ,
"personId"
2023-12-05 17:43:15 +02:00
] ,
"type" : "object"
} ,
"AssetFaceWithoutPersonResponseDto" : {
"properties" : {
"boundingBoxX1" : {
"type" : "integer"
} ,
"boundingBoxX2" : {
"type" : "integer"
} ,
"boundingBoxY1" : {
"type" : "integer"
} ,
"boundingBoxY2" : {
"type" : "integer"
} ,
"id" : {
"format" : "uuid" ,
"type" : "string"
} ,
"imageHeight" : {
"type" : "integer"
} ,
"imageWidth" : {
"type" : "integer"
}
} ,
"required" : [
"boundingBoxX1" ,
"boundingBoxX2" ,
"boundingBoxY1" ,
2024-01-22 18:49:51 +02:00
"boundingBoxY2" ,
"id" ,
"imageHeight" ,
"imageWidth"
2023-12-05 17:43:15 +02:00
] ,
"type" : "object"
} ,
2024-04-29 05:24:21 +02:00
"AssetFullSyncDto" : {
"properties" : {
"lastId" : {
"format" : "uuid" ,
"type" : "string"
} ,
"limit" : {
"minimum" : 1 ,
"type" : "integer"
} ,
"updatedUntil" : {
"format" : "date-time" ,
"type" : "string"
} ,
"userId" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
"required" : [
"limit" ,
"updatedUntil"
] ,
"type" : "object"
} ,
2023-06-10 06:14:18 +02:00
"AssetIdsDto" : {
2023-04-01 22:46:07 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"assetIds" : {
"items" : {
2023-08-01 18:49:18 +02:00
"format" : "uuid" ,
"type" : "string"
} ,
"type" : "array"
2023-06-10 06:14:18 +02:00
}
} ,
"required" : [
"assetIds"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-06-10 06:14:18 +02:00
} ,
"AssetIdsResponseDto" : {
"properties" : {
"assetId" : {
"type" : "string"
2023-04-01 22:46:07 +02:00
} ,
2023-06-10 06:14:18 +02:00
"error" : {
"enum" : [
"duplicate" ,
"no_permission" ,
"not_found"
] ,
"type" : "string"
2023-08-01 18:49:18 +02:00
} ,
"success" : {
"type" : "boolean"
2023-04-01 22:46:07 +02:00
}
} ,
"required" : [
2023-06-10 06:14:18 +02:00
"assetId" ,
"success"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-04-01 22:46:07 +02:00
} ,
2023-08-18 16:31:48 +02:00
"AssetJobName" : {
"enum" : [
"regenerate-thumbnail" ,
"refresh-metadata" ,
"transcode-video"
] ,
"type" : "string"
} ,
"AssetJobsDto" : {
"properties" : {
"assetIds" : {
"items" : {
"format" : "uuid" ,
"type" : "string"
} ,
"type" : "array"
} ,
"name" : {
"$ref" : "#/components/schemas/AssetJobName"
}
} ,
"required" : [
"assetIds" ,
"name"
] ,
"type" : "object"
} ,
2024-05-31 19:44:04 +02:00
"AssetMediaCreateDto" : {
"properties" : {
"assetData" : {
"format" : "binary" ,
"type" : "string"
} ,
"deviceAssetId" : {
"type" : "string"
} ,
"deviceId" : {
"type" : "string"
} ,
"duration" : {
"type" : "string"
} ,
"fileCreatedAt" : {
"format" : "date-time" ,
"type" : "string"
} ,
"fileModifiedAt" : {
"format" : "date-time" ,
"type" : "string"
} ,
"isArchived" : {
"type" : "boolean"
} ,
"isFavorite" : {
"type" : "boolean"
} ,
"isOffline" : {
"type" : "boolean"
} ,
"isVisible" : {
"type" : "boolean"
} ,
"livePhotoVideoId" : {
"format" : "uuid" ,
"type" : "string"
} ,
"sidecarData" : {
"format" : "binary" ,
"type" : "string"
}
} ,
"required" : [
"assetData" ,
"deviceAssetId" ,
"deviceId" ,
"fileCreatedAt" ,
"fileModifiedAt"
] ,
"type" : "object"
} ,
2024-05-24 02:26:22 +02:00
"AssetMediaReplaceDto" : {
"properties" : {
"assetData" : {
"format" : "binary" ,
"type" : "string"
} ,
"deviceAssetId" : {
"type" : "string"
} ,
"deviceId" : {
"type" : "string"
} ,
"duration" : {
"type" : "string"
} ,
"fileCreatedAt" : {
"format" : "date-time" ,
"type" : "string"
} ,
"fileModifiedAt" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assetData" ,
"deviceAssetId" ,
"deviceId" ,
"fileCreatedAt" ,
"fileModifiedAt"
] ,
"type" : "object"
} ,
"AssetMediaResponseDto" : {
"properties" : {
"id" : {
"type" : "string"
} ,
"status" : {
"$ref" : "#/components/schemas/AssetMediaStatus"
}
} ,
"required" : [
"id" ,
"status"
] ,
"type" : "object"
} ,
2024-05-31 19:44:04 +02:00
"AssetMediaSize" : {
"enum" : [
"preview" ,
"thumbnail"
] ,
"type" : "string"
} ,
2024-05-24 02:26:22 +02:00
"AssetMediaStatus" : {
"enum" : [
2024-05-31 19:44:04 +02:00
"created" ,
2024-05-24 02:26:22 +02:00
"replaced" ,
"duplicate"
] ,
"type" : "string"
} ,
2023-11-15 00:47:15 +02:00
"AssetOrder" : {
"enum" : [
"asc" ,
"desc"
] ,
"type" : "string"
} ,
2023-06-10 06:14:18 +02:00
"AssetResponseDto" : {
2023-03-26 04:46:48 +02:00
"properties" : {
2023-08-01 18:49:18 +02:00
"checksum" : {
"description" : "base64 encoded sha1 hash" ,
2023-06-10 06:14:18 +02:00
"type" : "string"
2023-01-25 18:35:28 +02:00
} ,
2023-06-10 06:14:18 +02:00
"deviceAssetId" : {
"type" : "string"
2023-01-25 18:35:28 +02:00
} ,
2023-06-10 06:14:18 +02:00
"deviceId" : {
"type" : "string"
2023-01-25 18:35:28 +02:00
} ,
2024-05-18 20:50:28 +02:00
"duplicateId" : {
"nullable" : true ,
"type" : "string"
} ,
2023-08-01 18:49:18 +02:00
"duration" : {
2023-06-10 06:14:18 +02:00
"type" : "string"
2023-01-25 18:35:28 +02:00
} ,
2023-08-01 18:49:18 +02:00
"exifInfo" : {
"$ref" : "#/components/schemas/ExifResponseDto"
2023-06-18 05:22:31 +02:00
} ,
2023-06-10 06:14:18 +02:00
"fileCreatedAt" : {
"format" : "date-time" ,
"type" : "string"
feat(server): xmp sidecar metadata (#2466)
* initial commit for XMP sidecar support
* Added support for 'missing' metadata files to include those without sidecar files, now detects sidecar files in the filesystem for media already ingested but the sidecar was created afterwards
* didn't mean to commit default log level during testing
* new sidecar logic for video metadata as well
* Added xml mimetype for sidecars only
* don't need capture group for this regex
* wrong default value reverted
* simplified the move here - keep it in the same try catch since the outcome is to move the media back anyway
* simplified setter logic
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
* simplified logic per suggestions
* sidecar is now its own queue with a discover and sync, updated UI for the new job queueing
* queue a sidecar job for every asset based on discovery or sync, though the logic is almost identical aside from linking the sidecar
* now queue sidecar jobs for each assset, though logic is mostly the same between discovery and sync
* simplified logic of filename extraction and asset instantiation
* not sure how that got deleted..
* updated code per suggestions and comments in the PR
* stat was not being used, removed the variable set
* better type checking, using in-scope variables for exif getter instead of passing in every time
* removed commented out test
* ran and resolved all lints, formats, checks, and tests
* resolved suggested change in PR
* made getExifProperty more dynamic with multiple possible args for fallbacks, fixed typo, used generic in function for better type checking
* better error handling and moving files back to positions on move or save failure
* regenerated api
* format fixes
* Added XMP documentation
* documentation typo
* Merged in main
* missed merge conflict
* more changes due to a merge
* Resolving conflicts
* added icon for sidecar jobs
---------
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2023-05-25 03:59:30 +02:00
} ,
2023-06-10 06:14:18 +02:00
"fileModifiedAt" : {
"format" : "date-time" ,
"type" : "string"
} ,
2023-10-14 03:46:30 +02:00
"hasMetadata" : {
"type" : "boolean"
} ,
2023-08-01 18:49:18 +02:00
"id" : {
2023-06-10 06:14:18 +02:00
"type" : "string"
} ,
2023-08-01 18:49:18 +02:00
"isArchived" : {
2023-06-10 06:14:18 +02:00
"type" : "boolean"
} ,
2023-08-01 18:49:18 +02:00
"isFavorite" : {
2023-06-10 06:14:18 +02:00
"type" : "boolean"
} ,
2023-09-20 13:16:33 +02:00
"isOffline" : {
"type" : "boolean"
} ,
2023-10-06 09:01:14 +02:00
"isTrashed" : {
"type" : "boolean"
} ,
2023-09-20 13:16:33 +02:00
"libraryId" : {
2024-05-21 00:09:10 +02:00
"deprecated" : true ,
"description" : "This property was deprecated in v1.106.0" ,
"nullable" : true ,
2023-09-20 13:16:33 +02:00
"type" : "string"
} ,
2023-08-01 18:49:18 +02:00
"livePhotoVideoId" : {
"nullable" : true ,
2023-06-10 06:14:18 +02:00
"type" : "string"
} ,
2023-10-05 00:11:11 +02:00
"localDateTime" : {
"format" : "date-time" ,
"type" : "string"
} ,
2023-08-01 18:49:18 +02:00
"originalFileName" : {
"type" : "string"
} ,
2024-06-13 12:57:46 +02:00
"originalMimeType" : {
"type" : "string"
} ,
2023-08-01 18:49:18 +02:00
"originalPath" : {
"type" : "string"
} ,
2023-09-06 05:14:44 +02:00
"owner" : {
"$ref" : "#/components/schemas/UserResponseDto"
} ,
2023-08-01 18:49:18 +02:00
"ownerId" : {
"type" : "string"
} ,
"people" : {
"items" : {
2023-12-05 17:43:15 +02:00
"$ref" : "#/components/schemas/PersonWithFacesResponseDto"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
} ,
"resized" : {
"type" : "boolean"
2023-06-10 06:14:18 +02:00
} ,
"smartInfo" : {
"$ref" : "#/components/schemas/SmartInfoResponseDto"
} ,
2023-10-22 04:38:07 +02:00
"stack" : {
"items" : {
"$ref" : "#/components/schemas/AssetResponseDto"
} ,
"type" : "array"
} ,
"stackCount" : {
2023-10-26 16:19:06 +02:00
"nullable" : true ,
2023-10-22 04:38:07 +02:00
"type" : "integer"
} ,
"stackParentId" : {
"nullable" : true ,
"type" : "string"
} ,
2023-06-10 06:14:18 +02:00
"tags" : {
"items" : {
"$ref" : "#/components/schemas/TagResponseDto"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-06-10 06:14:18 +02:00
} ,
2023-08-01 18:49:18 +02:00
"thumbhash" : {
"nullable" : true ,
"type" : "string"
2023-06-10 06:14:18 +02:00
} ,
2023-08-01 18:49:18 +02:00
"type" : {
"$ref" : "#/components/schemas/AssetTypeEnum"
} ,
2024-06-05 09:26:00 +02:00
"unassignedFaces" : {
"items" : {
"$ref" : "#/components/schemas/AssetFaceWithoutPersonResponseDto"
} ,
"type" : "array"
} ,
2023-08-01 18:49:18 +02:00
"updatedAt" : {
"format" : "date-time" ,
"type" : "string"
2023-01-25 18:35:28 +02:00
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"checksum" ,
2023-06-10 06:14:18 +02:00
"deviceAssetId" ,
"deviceId" ,
2024-01-22 18:49:51 +02:00
"duration" ,
2023-06-10 06:14:18 +02:00
"fileCreatedAt" ,
"fileModifiedAt" ,
2024-01-22 18:49:51 +02:00
"hasMetadata" ,
"id" ,
2023-06-10 06:14:18 +02:00
"isArchived" ,
2024-01-22 18:49:51 +02:00
"isFavorite" ,
"isOffline" ,
"isTrashed" ,
2023-10-14 03:46:30 +02:00
"localDateTime" ,
2024-01-22 18:49:51 +02:00
"originalFileName" ,
"originalPath" ,
"ownerId" ,
"resized" ,
"stackCount" ,
"thumbhash" ,
"type" ,
"updatedAt"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-03-26 04:46:48 +02:00
} ,
2023-07-14 15:30:17 +02:00
"AssetStatsResponseDto" : {
"properties" : {
"images" : {
"type" : "integer"
} ,
2023-08-02 23:10:55 +02:00
"total" : {
2023-07-14 15:30:17 +02:00
"type" : "integer"
} ,
2023-08-02 23:10:55 +02:00
"videos" : {
2023-07-14 15:30:17 +02:00
"type" : "integer"
}
} ,
"required" : [
"images" ,
2024-01-22 18:49:51 +02:00
"total" ,
"videos"
2023-08-02 23:10:55 +02:00
] ,
"type" : "object"
2023-07-14 15:30:17 +02:00
} ,
2023-06-10 06:14:18 +02:00
"AssetTypeEnum" : {
2023-03-26 04:46:48 +02:00
"enum" : [
2023-06-10 06:14:18 +02:00
"IMAGE" ,
"VIDEO" ,
"AUDIO" ,
"OTHER"
2023-08-01 18:49:18 +02:00
] ,
"type" : "string"
2023-03-26 04:46:48 +02:00
} ,
2023-07-09 04:43:11 +02:00
"AudioCodec" : {
"enum" : [
"mp3" ,
"aac" ,
2023-09-16 02:52:45 +02:00
"libopus"
2023-08-01 18:49:18 +02:00
] ,
"type" : "string"
2023-07-09 04:43:11 +02:00
} ,
2023-08-24 21:28:50 +02:00
"AuditDeletesResponseDto" : {
"properties" : {
"ids" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"needsFullSync" : {
"type" : "boolean"
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"ids" ,
"needsFullSync"
2023-08-24 21:28:50 +02:00
] ,
"type" : "object"
} ,
2024-05-28 04:16:53 +02:00
"AvatarResponse" : {
"properties" : {
"color" : {
"$ref" : "#/components/schemas/UserAvatarColor"
}
} ,
"required" : [
"color"
] ,
"type" : "object"
} ,
"AvatarUpdate" : {
"properties" : {
"color" : {
"$ref" : "#/components/schemas/UserAvatarColor"
}
} ,
"type" : "object"
} ,
2023-07-11 23:52:41 +02:00
"BulkIdResponseDto" : {
"properties" : {
"error" : {
"enum" : [
"duplicate" ,
"no_permission" ,
"not_found" ,
"unknown"
2023-07-23 05:00:43 +02:00
] ,
"type" : "string"
2023-08-01 18:49:18 +02:00
} ,
"id" : {
"type" : "string"
} ,
"success" : {
"type" : "boolean"
2023-07-11 23:52:41 +02:00
}
} ,
"required" : [
"id" ,
"success"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-07-11 23:52:41 +02:00
} ,
2023-08-02 03:29:14 +02:00
"BulkIdsDto" : {
"properties" : {
"ids" : {
"items" : {
"format" : "uuid" ,
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"ids"
] ,
"type" : "object"
} ,
2023-08-29 15:58:00 +02:00
"CLIPConfig" : {
"properties" : {
"enabled" : {
"type" : "boolean"
} ,
"modelName" : {
"type" : "string"
}
} ,
"required" : [
"enabled" ,
"modelName"
] ,
"type" : "object"
} ,
2023-09-03 03:22:42 +02:00
"CQMode" : {
"enum" : [
"auto" ,
"cqp" ,
"icq"
] ,
"type" : "string"
} ,
2023-06-10 06:14:18 +02:00
"ChangePasswordDto" : {
2023-03-26 04:46:48 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"newPassword" : {
2023-08-01 18:49:18 +02:00
"example" : "password" ,
2024-04-23 00:13:44 +02:00
"minLength" : 8 ,
2023-08-01 18:49:18 +02:00
"type" : "string"
} ,
"password" : {
"example" : "password" ,
"type" : "string"
2023-03-26 04:46:48 +02:00
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"newPassword" ,
"password"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-03-26 04:46:48 +02:00
} ,
2023-06-10 06:14:18 +02:00
"CheckExistingAssetsDto" : {
2023-03-03 04:47:08 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"deviceAssetIds" : {
"items" : {
"type" : "string"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-03-03 04:47:08 +02:00
} ,
2023-06-10 06:14:18 +02:00
"deviceId" : {
2023-03-03 04:47:08 +02:00
"type" : "string"
}
} ,
"required" : [
2023-06-10 06:14:18 +02:00
"deviceAssetIds" ,
"deviceId"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-03-03 04:47:08 +02:00
} ,
2023-06-10 06:14:18 +02:00
"CheckExistingAssetsResponseDto" : {
2023-03-03 04:47:08 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"existingIds" : {
2023-03-03 04:47:08 +02:00
"items" : {
2023-06-10 06:14:18 +02:00
"type" : "string"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-03-03 04:47:08 +02:00
}
} ,
"required" : [
2023-06-10 06:14:18 +02:00
"existingIds"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-03-03 04:47:08 +02:00
} ,
2023-09-03 08:21:51 +02:00
"Colorspace" : {
"enum" : [
"srgb" ,
"p3"
] ,
"type" : "string"
} ,
2023-06-10 06:14:18 +02:00
"CreateAlbumDto" : {
2023-03-03 04:47:08 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"albumName" : {
"type" : "string"
2023-03-03 04:47:08 +02:00
} ,
2024-05-07 22:38:09 +02:00
"albumUsers" : {
"items" : {
"$ref" : "#/components/schemas/AlbumUserCreateDto"
} ,
"type" : "array"
} ,
2023-08-01 18:49:18 +02:00
"assetIds" : {
2023-03-03 04:47:08 +02:00
"items" : {
2023-08-01 18:49:18 +02:00
"format" : "uuid" ,
"type" : "string"
} ,
"type" : "array"
2023-03-03 04:47:08 +02:00
} ,
2023-08-06 04:43:26 +02:00
"description" : {
"type" : "string"
2023-03-03 04:47:08 +02:00
}
} ,
"required" : [
2023-06-10 06:14:18 +02:00
"albumName"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-03-03 04:47:08 +02:00
} ,
2023-09-20 13:16:33 +02:00
"CreateLibraryDto" : {
"properties" : {
"exclusionPatterns" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"importPaths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"name" : {
"type" : "string"
} ,
2024-02-29 20:35:37 +02:00
"ownerId" : {
"format" : "uuid" ,
"type" : "string"
2023-09-20 13:16:33 +02:00
}
} ,
"required" : [
2024-05-21 00:09:10 +02:00
"ownerId"
2023-09-20 13:16:33 +02:00
] ,
"type" : "object"
} ,
2023-06-10 06:14:18 +02:00
"CreateProfileImageDto" : {
2023-03-03 04:47:08 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"file" : {
2023-08-01 18:49:18 +02:00
"format" : "binary" ,
"type" : "string"
2023-03-03 04:47:08 +02:00
}
} ,
"required" : [
2023-06-10 06:14:18 +02:00
"file"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-03-03 04:47:08 +02:00
} ,
2023-06-10 06:14:18 +02:00
"CreateProfileImageResponseDto" : {
2023-03-05 22:44:31 +02:00
"properties" : {
2023-08-01 18:49:18 +02:00
"profileImagePath" : {
2023-03-05 22:44:31 +02:00
"type" : "string"
} ,
2023-08-01 18:49:18 +02:00
"userId" : {
2023-06-10 06:14:18 +02:00
"type" : "string"
2023-03-05 22:44:31 +02:00
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"profileImagePath" ,
"userId"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-03-05 22:44:31 +02:00
} ,
2023-06-10 06:14:18 +02:00
"CreateTagDto" : {
2023-03-05 22:44:31 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"name" : {
"type" : "string"
2023-08-01 18:49:18 +02:00
} ,
"type" : {
"$ref" : "#/components/schemas/TagTypeEnum"
2023-03-05 22:44:31 +02:00
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"name" ,
"type"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-03-05 22:44:31 +02:00
} ,
2023-06-30 18:24:28 +02:00
"DownloadArchiveInfo" : {
2023-01-25 18:35:28 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"assetIds" : {
"items" : {
"type" : "string"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
} ,
"size" : {
"type" : "integer"
2023-01-25 18:35:28 +02:00
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"assetIds" ,
"size"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-01-25 18:35:28 +02:00
} ,
2023-08-15 17:49:32 +02:00
"DownloadInfoDto" : {
"properties" : {
"albumId" : {
"format" : "uuid" ,
"type" : "string"
} ,
"archiveSize" : {
2024-04-23 00:13:44 +02:00
"minimum" : 1 ,
2023-08-15 17:49:32 +02:00
"type" : "integer"
} ,
"assetIds" : {
"items" : {
"format" : "uuid" ,
"type" : "string"
} ,
"type" : "array"
} ,
"userId" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
"type" : "object"
} ,
2024-06-14 17:27:12 +02:00
"DownloadResponse" : {
"properties" : {
"archiveSize" : {
"type" : "integer"
}
} ,
"required" : [
"archiveSize"
] ,
"type" : "object"
} ,
2023-06-30 18:24:28 +02:00
"DownloadResponseDto" : {
"properties" : {
"archives" : {
"items" : {
"$ref" : "#/components/schemas/DownloadArchiveInfo"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
} ,
"totalSize" : {
"type" : "integer"
2023-06-30 18:24:28 +02:00
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"archives" ,
"totalSize"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-06-30 18:24:28 +02:00
} ,
2024-06-14 17:27:12 +02:00
"DownloadUpdate" : {
"properties" : {
"archiveSize" : {
"minimum" : 1 ,
"type" : "integer"
}
} ,
"type" : "object"
} ,
2024-05-16 19:08:37 +02:00
"DuplicateDetectionConfig" : {
"properties" : {
"enabled" : {
"type" : "boolean"
} ,
"maxDistance" : {
2024-06-12 18:36:24 +02:00
"format" : "double" ,
2024-05-16 19:08:37 +02:00
"maximum" : 0.1 ,
"minimum" : 0.001 ,
"type" : "number"
}
} ,
"required" : [
"enabled" ,
"maxDistance"
] ,
"type" : "object"
} ,
2024-05-18 20:50:28 +02:00
"DuplicateResponseDto" : {
"properties" : {
"assets" : {
"items" : {
"$ref" : "#/components/schemas/AssetResponseDto"
} ,
"type" : "array"
} ,
"duplicateId" : {
"type" : "string"
}
} ,
"required" : [
"assets" ,
"duplicateId"
] ,
"type" : "object"
} ,
2024-06-03 23:00:20 +02:00
"EmailNotificationsResponse" : {
"properties" : {
"albumInvite" : {
"type" : "boolean"
} ,
"albumUpdate" : {
"type" : "boolean"
} ,
"enabled" : {
"type" : "boolean"
}
} ,
"required" : [
"albumInvite" ,
"albumUpdate" ,
"enabled"
] ,
"type" : "object"
} ,
"EmailNotificationsUpdate" : {
"properties" : {
"albumInvite" : {
"type" : "boolean"
} ,
"albumUpdate" : {
"type" : "boolean"
} ,
"enabled" : {
"type" : "boolean"
}
} ,
"type" : "object"
} ,
2023-08-24 21:28:50 +02:00
"EntityType" : {
"enum" : [
"ASSET" ,
"ALBUM"
] ,
"type" : "string"
} ,
2023-06-10 06:14:18 +02:00
"ExifResponseDto" : {
2023-01-25 18:35:28 +02:00
"properties" : {
2023-08-01 18:49:18 +02:00
"city" : {
2023-06-10 06:14:18 +02:00
"default" : null ,
"nullable" : true ,
2023-08-01 18:49:18 +02:00
"type" : "string"
2023-01-25 18:35:28 +02:00
} ,
2023-08-01 18:49:18 +02:00
"country" : {
"default" : null ,
2023-06-10 06:14:18 +02:00
"nullable" : true ,
2023-08-01 18:49:18 +02:00
"type" : "string"
2023-01-25 18:35:28 +02:00
} ,
2023-08-01 18:49:18 +02:00
"dateTimeOriginal" : {
"default" : null ,
"format" : "date-time" ,
2023-06-10 06:14:18 +02:00
"nullable" : true ,
2023-08-01 18:49:18 +02:00
"type" : "string"
2023-01-25 18:35:28 +02:00
} ,
2023-08-01 18:49:18 +02:00
"description" : {
"default" : null ,
2023-06-10 06:14:18 +02:00
"nullable" : true ,
2023-08-01 18:49:18 +02:00
"type" : "string"
2023-01-25 18:35:28 +02:00
} ,
2023-08-01 18:49:18 +02:00
"exifImageHeight" : {
"default" : null ,
2023-06-10 06:14:18 +02:00
"nullable" : true ,
2023-08-01 18:49:18 +02:00
"type" : "number"
2023-05-22 20:07:43 +02:00
} ,
2023-08-01 18:49:18 +02:00
"exifImageWidth" : {
"default" : null ,
2023-06-10 06:14:18 +02:00
"nullable" : true ,
2023-08-01 18:49:18 +02:00
"type" : "number"
2023-05-22 20:07:43 +02:00
} ,
2023-08-01 18:49:18 +02:00
"exposureTime" : {
"default" : null ,
2023-06-10 06:14:18 +02:00
"nullable" : true ,
2023-08-01 18:49:18 +02:00
"type" : "string"
2023-06-10 06:14:18 +02:00
} ,
2023-08-01 18:49:18 +02:00
"fNumber" : {
"default" : null ,
2023-06-10 06:14:18 +02:00
"nullable" : true ,
2023-08-01 18:49:18 +02:00
"type" : "number"
2023-06-10 06:14:18 +02:00
} ,
2023-08-01 18:49:18 +02:00
"fileSizeInByte" : {
"default" : null ,
"format" : "int64" ,
2023-06-10 06:14:18 +02:00
"nullable" : true ,
2023-08-01 18:49:18 +02:00
"type" : "integer"
2023-06-10 06:14:18 +02:00
} ,
"focalLength" : {
2023-08-01 18:49:18 +02:00
"default" : null ,
2023-06-10 06:14:18 +02:00
"nullable" : true ,
2023-08-01 18:49:18 +02:00
"type" : "number"
2023-06-10 06:14:18 +02:00
} ,
"iso" : {
2023-08-01 18:49:18 +02:00
"default" : null ,
2023-06-10 06:14:18 +02:00
"nullable" : true ,
2023-08-01 18:49:18 +02:00
"type" : "number"
2023-06-10 06:14:18 +02:00
} ,
2023-08-01 18:49:18 +02:00
"latitude" : {
"default" : null ,
2023-06-10 06:14:18 +02:00
"nullable" : true ,
2023-08-01 18:49:18 +02:00
"type" : "number"
2023-06-10 06:14:18 +02:00
} ,
2023-08-01 18:49:18 +02:00
"lensModel" : {
"default" : null ,
2023-06-10 06:14:18 +02:00
"nullable" : true ,
2023-08-01 18:49:18 +02:00
"type" : "string"
2023-06-10 06:14:18 +02:00
} ,
"longitude" : {
2023-08-01 18:49:18 +02:00
"default" : null ,
2023-06-10 06:14:18 +02:00
"nullable" : true ,
2023-08-01 18:49:18 +02:00
"type" : "number"
2023-06-10 06:14:18 +02:00
} ,
2023-08-01 18:49:18 +02:00
"make" : {
"default" : null ,
2023-06-10 06:14:18 +02:00
"nullable" : true ,
2023-08-01 18:49:18 +02:00
"type" : "string"
2023-06-10 06:14:18 +02:00
} ,
2023-08-01 18:49:18 +02:00
"model" : {
"default" : null ,
2023-06-10 06:14:18 +02:00
"nullable" : true ,
2023-08-01 18:49:18 +02:00
"type" : "string"
2023-06-10 06:14:18 +02:00
} ,
2023-08-01 18:49:18 +02:00
"modifyDate" : {
"default" : null ,
"format" : "date-time" ,
2023-06-10 06:14:18 +02:00
"nullable" : true ,
2023-08-01 18:49:18 +02:00
"type" : "string"
2023-06-10 06:14:18 +02:00
} ,
2023-08-01 18:49:18 +02:00
"orientation" : {
"default" : null ,
2023-06-10 06:14:18 +02:00
"nullable" : true ,
2023-08-01 18:49:18 +02:00
"type" : "string"
2023-07-28 06:29:09 +02:00
} ,
"projectionType" : {
2023-08-01 18:49:18 +02:00
"default" : null ,
"nullable" : true ,
"type" : "string"
} ,
2024-08-09 19:45:52 +02:00
"rating" : {
"default" : null ,
"nullable" : true ,
"type" : "number"
} ,
2023-08-01 18:49:18 +02:00
"state" : {
"default" : null ,
"nullable" : true ,
"type" : "string"
} ,
"timeZone" : {
"default" : null ,
2023-07-28 06:29:09 +02:00
"nullable" : true ,
2023-08-01 18:49:18 +02:00
"type" : "string"
2023-06-10 06:14:18 +02:00
}
2023-08-01 18:49:18 +02:00
} ,
"type" : "object"
2023-06-10 06:14:18 +02:00
} ,
2023-12-05 17:43:15 +02:00
"FaceDto" : {
"properties" : {
"id" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
"required" : [
"id"
] ,
"type" : "object"
} ,
2024-06-07 05:09:47 +02:00
"FacialRecognitionConfig" : {
"properties" : {
"enabled" : {
"type" : "boolean"
} ,
"maxDistance" : {
2024-06-12 18:36:24 +02:00
"format" : "double" ,
2024-06-07 05:09:47 +02:00
"maximum" : 2 ,
"minimum" : 0 ,
"type" : "number"
} ,
"minFaces" : {
"minimum" : 1 ,
"type" : "integer"
} ,
"minScore" : {
2024-06-12 18:36:24 +02:00
"format" : "double" ,
2024-06-07 05:09:47 +02:00
"maximum" : 1 ,
"minimum" : 0 ,
"type" : "number"
} ,
"modelName" : {
"type" : "string"
}
} ,
"required" : [
"enabled" ,
"maxDistance" ,
"minFaces" ,
"minScore" ,
"modelName"
] ,
"type" : "object"
} ,
2023-10-14 19:12:59 +02:00
"FileChecksumDto" : {
"properties" : {
"filenames" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"filenames"
] ,
"type" : "object"
} ,
"FileChecksumResponseDto" : {
"properties" : {
"checksum" : {
"type" : "string"
} ,
"filename" : {
"type" : "string"
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"checksum" ,
"filename"
2023-10-14 19:12:59 +02:00
] ,
"type" : "object"
} ,
"FileReportDto" : {
"properties" : {
"extras" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"orphans" : {
"items" : {
"$ref" : "#/components/schemas/FileReportItemDto"
} ,
"type" : "array"
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"extras" ,
"orphans"
2023-10-14 19:12:59 +02:00
] ,
"type" : "object"
} ,
"FileReportFixDto" : {
"properties" : {
"items" : {
"items" : {
"$ref" : "#/components/schemas/FileReportItemDto"
} ,
"type" : "array"
}
} ,
"required" : [
"items"
] ,
"type" : "object"
} ,
"FileReportItemDto" : {
"properties" : {
"checksum" : {
"type" : "string"
} ,
"entityId" : {
"format" : "uuid" ,
"type" : "string"
} ,
"entityType" : {
"$ref" : "#/components/schemas/PathEntityType"
} ,
"pathType" : {
"$ref" : "#/components/schemas/PathType"
} ,
"pathValue" : {
"type" : "string"
}
} ,
"required" : [
"entityId" ,
"entityType" ,
"pathType" ,
"pathValue"
] ,
"type" : "object"
} ,
2024-04-02 06:56:56 +02:00
"ImageFormat" : {
"enum" : [
"jpeg" ,
"webp"
] ,
"type" : "string"
} ,
2023-06-10 06:14:18 +02:00
"JobCommand" : {
"enum" : [
"start" ,
"pause" ,
"resume" ,
2023-12-05 04:07:20 +02:00
"empty" ,
"clear-failed"
2023-08-01 18:49:18 +02:00
] ,
"type" : "string"
2023-06-10 06:14:18 +02:00
} ,
"JobCommandDto" : {
"properties" : {
"command" : {
"$ref" : "#/components/schemas/JobCommand"
2023-01-25 18:35:28 +02:00
} ,
2023-06-10 06:14:18 +02:00
"force" : {
"type" : "boolean"
}
} ,
"required" : [
"command" ,
"force"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-06-10 06:14:18 +02:00
} ,
"JobCountsDto" : {
"properties" : {
"active" : {
"type" : "integer"
2023-01-25 18:35:28 +02:00
} ,
2023-06-10 06:14:18 +02:00
"completed" : {
"type" : "integer"
2023-01-25 18:35:28 +02:00
} ,
2023-06-10 06:14:18 +02:00
"delayed" : {
"type" : "integer"
2023-01-21 18:11:55 +02:00
} ,
2023-08-01 18:49:18 +02:00
"failed" : {
2023-06-10 06:14:18 +02:00
"type" : "integer"
2023-01-21 18:11:55 +02:00
} ,
2023-06-10 06:14:18 +02:00
"paused" : {
"type" : "integer"
2023-08-01 18:49:18 +02:00
} ,
"waiting" : {
"type" : "integer"
2023-06-10 06:14:18 +02:00
}
} ,
"required" : [
"active" ,
"completed" ,
"delayed" ,
2024-01-22 18:49:51 +02:00
"failed" ,
"paused" ,
"waiting"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-01-21 18:11:55 +02:00
} ,
2023-06-10 06:14:18 +02:00
"JobName" : {
"enum" : [
"thumbnailGeneration" ,
"metadataExtraction" ,
"videoConversion" ,
2024-01-18 07:08:48 +02:00
"faceDetection" ,
"facialRecognition" ,
2023-12-16 18:50:46 +02:00
"smartSearch" ,
2024-05-16 19:08:37 +02:00
"duplicateDetection" ,
2023-06-10 06:14:18 +02:00
"backgroundTask" ,
"storageTemplateMigration" ,
2023-09-25 17:07:21 +02:00
"migration" ,
2023-06-10 06:14:18 +02:00
"search" ,
2023-09-20 13:16:33 +02:00
"sidecar" ,
2024-05-02 16:43:18 +02:00
"library" ,
"notifications"
2023-08-01 18:49:18 +02:00
] ,
"type" : "string"
2023-06-10 06:14:18 +02:00
} ,
"JobSettingsDto" : {
2023-01-21 18:11:55 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"concurrency" : {
2024-04-23 00:13:44 +02:00
"minimum" : 1 ,
2023-06-10 06:14:18 +02:00
"type" : "integer"
2023-01-21 18:11:55 +02:00
}
} ,
"required" : [
2023-06-10 06:14:18 +02:00
"concurrency"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-01-21 18:11:55 +02:00
} ,
2023-06-10 06:14:18 +02:00
"JobStatusDto" : {
2023-01-21 18:11:55 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"jobCounts" : {
"$ref" : "#/components/schemas/JobCountsDto"
} ,
"queueStatus" : {
"$ref" : "#/components/schemas/QueueStatusDto"
2023-01-21 18:11:55 +02:00
}
} ,
"required" : [
2023-06-10 06:14:18 +02:00
"jobCounts" ,
"queueStatus"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-01-21 18:11:55 +02:00
} ,
2023-09-20 13:16:33 +02:00
"LibraryResponseDto" : {
"properties" : {
"assetCount" : {
"type" : "integer"
} ,
"createdAt" : {
"format" : "date-time" ,
"type" : "string"
} ,
"exclusionPatterns" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"id" : {
"type" : "string"
} ,
"importPaths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"name" : {
"type" : "string"
} ,
"ownerId" : {
"type" : "string"
} ,
"refreshedAt" : {
"format" : "date-time" ,
"nullable" : true ,
"type" : "string"
} ,
"updatedAt" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assetCount" ,
2024-01-22 18:49:51 +02:00
"createdAt" ,
"exclusionPatterns" ,
2023-09-20 13:16:33 +02:00
"id" ,
"importPaths" ,
2024-01-22 18:49:51 +02:00
"name" ,
"ownerId" ,
"refreshedAt" ,
"updatedAt"
2023-09-20 13:16:33 +02:00
] ,
"type" : "object"
} ,
"LibraryStatsResponseDto" : {
"properties" : {
"photos" : {
"default" : 0 ,
"type" : "integer"
} ,
"total" : {
"default" : 0 ,
"type" : "integer"
} ,
"usage" : {
"default" : 0 ,
"format" : "int64" ,
"type" : "integer"
} ,
"videos" : {
"default" : 0 ,
"type" : "integer"
}
} ,
"required" : [
"photos" ,
"total" ,
2024-01-22 18:49:51 +02:00
"usage" ,
"videos"
2023-09-20 13:16:33 +02:00
] ,
"type" : "object"
} ,
2024-07-01 19:43:16 +02:00
"LicenseKeyDto" : {
"properties" : {
"activationKey" : {
"type" : "string"
} ,
"licenseKey" : {
"pattern" : "/IM(SV|CL)(-[\\dA-Za-z]{4}){8}/" ,
"type" : "string"
}
} ,
"required" : [
"activationKey" ,
"licenseKey"
] ,
"type" : "object"
} ,
"LicenseResponseDto" : {
"properties" : {
"activatedAt" : {
"format" : "date-time" ,
"type" : "string"
} ,
"activationKey" : {
"type" : "string"
} ,
"licenseKey" : {
"pattern" : "/IM(SV|CL)(-[\\dA-Za-z]{4}){8}/" ,
"type" : "string"
}
} ,
"required" : [
"activatedAt" ,
"activationKey" ,
"licenseKey"
] ,
"type" : "object"
} ,
2023-12-14 18:55:40 +02:00
"LogLevel" : {
"enum" : [
"verbose" ,
"debug" ,
"log" ,
"warn" ,
"error" ,
"fatal"
] ,
"type" : "string"
} ,
2023-06-10 06:14:18 +02:00
"LoginCredentialDto" : {
2023-06-01 12:32:51 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"email" : {
2023-08-01 18:49:18 +02:00
"example" : "testuser@email.com" ,
"type" : "string"
2023-06-10 06:14:18 +02:00
} ,
"password" : {
2023-08-01 18:49:18 +02:00
"example" : "password" ,
"type" : "string"
2023-06-01 12:32:51 +02:00
}
} ,
"required" : [
2023-06-10 06:14:18 +02:00
"email" ,
"password"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-06-01 12:32:51 +02:00
} ,
2023-06-10 06:14:18 +02:00
"LoginResponseDto" : {
2023-06-01 12:32:51 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"accessToken" : {
2023-08-01 18:49:18 +02:00
"type" : "string"
2023-06-01 12:32:51 +02:00
} ,
2023-08-01 18:49:18 +02:00
"isAdmin" : {
"type" : "boolean"
2023-06-01 12:32:51 +02:00
} ,
2023-11-12 03:03:32 +02:00
"name" : {
2023-08-01 18:49:18 +02:00
"type" : "string"
2023-06-01 12:32:51 +02:00
} ,
2023-06-10 06:14:18 +02:00
"profileImagePath" : {
2023-08-01 18:49:18 +02:00
"type" : "string"
2023-06-01 12:32:51 +02:00
} ,
2023-06-10 06:14:18 +02:00
"shouldChangePassword" : {
2023-08-01 18:49:18 +02:00
"type" : "boolean"
} ,
"userEmail" : {
"type" : "string"
} ,
"userId" : {
"type" : "string"
2023-06-01 12:32:51 +02:00
}
} ,
"required" : [
2023-06-10 06:14:18 +02:00
"accessToken" ,
2024-01-22 18:49:51 +02:00
"isAdmin" ,
2023-11-12 03:03:32 +02:00
"name" ,
2023-06-10 06:14:18 +02:00
"profileImagePath" ,
2024-01-22 18:49:51 +02:00
"shouldChangePassword" ,
"userEmail" ,
"userId"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-06-01 12:32:51 +02:00
} ,
2023-06-10 06:14:18 +02:00
"LogoutResponseDto" : {
2023-01-21 18:11:55 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"redirectUri" : {
"type" : "string"
2023-08-01 18:49:18 +02:00
} ,
"successful" : {
"type" : "boolean"
2023-01-21 18:11:55 +02:00
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"redirectUri" ,
"successful"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-01-21 18:11:55 +02:00
} ,
2023-06-10 06:14:18 +02:00
"MapMarkerResponseDto" : {
2023-01-21 18:11:55 +02:00
"properties" : {
2024-03-03 23:42:17 +02:00
"city" : {
"nullable" : true ,
"type" : "string"
} ,
"country" : {
"nullable" : true ,
"type" : "string"
} ,
2023-06-10 06:14:18 +02:00
"id" : {
"type" : "string"
2023-01-21 18:11:55 +02:00
} ,
2023-06-10 06:14:18 +02:00
"lat" : {
2023-08-01 18:49:18 +02:00
"format" : "double" ,
"type" : "number"
2022-12-26 17:35:52 +02:00
} ,
2023-06-10 06:14:18 +02:00
"lon" : {
2023-08-01 18:49:18 +02:00
"format" : "double" ,
"type" : "number"
2024-03-03 23:42:17 +02:00
} ,
"state" : {
"nullable" : true ,
"type" : "string"
2022-12-05 19:56:44 +02:00
}
} ,
"required" : [
2024-03-03 23:42:17 +02:00
"city" ,
"country" ,
2023-06-10 06:14:18 +02:00
"id" ,
"lat" ,
2024-03-03 23:42:17 +02:00
"lon" ,
"state"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2022-12-05 19:56:44 +02:00
} ,
2024-07-30 00:17:26 +02:00
"MapReverseGeocodeResponseDto" : {
"properties" : {
"city" : {
"nullable" : true ,
"type" : "string"
} ,
"country" : {
"nullable" : true ,
"type" : "string"
} ,
"state" : {
"nullable" : true ,
"type" : "string"
}
} ,
"required" : [
"city" ,
"country" ,
"state"
] ,
"type" : "object"
} ,
2023-11-09 18:10:56 +02:00
"MapTheme" : {
"enum" : [
"light" ,
"dark"
] ,
"type" : "string"
} ,
2024-04-02 16:23:17 +02:00
"MemoryCreateDto" : {
"properties" : {
"assetIds" : {
"items" : {
"format" : "uuid" ,
"type" : "string"
} ,
"type" : "array"
} ,
"data" : {
2024-04-02 21:21:58 +02:00
"$ref" : "#/components/schemas/OnThisDayDto"
2024-04-02 16:23:17 +02:00
} ,
"isSaved" : {
"type" : "boolean"
} ,
"memoryAt" : {
"format" : "date-time" ,
"type" : "string"
} ,
"seenAt" : {
"format" : "date-time" ,
"type" : "string"
} ,
"type" : {
"$ref" : "#/components/schemas/MemoryType"
}
} ,
"required" : [
"data" ,
"memoryAt" ,
"type"
] ,
"type" : "object"
} ,
2023-06-15 03:47:18 +02:00
"MemoryLaneResponseDto" : {
"properties" : {
"assets" : {
"items" : {
"$ref" : "#/components/schemas/AssetResponseDto"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
} ,
2024-03-27 22:14:29 +02:00
"yearsAgo" : {
2024-03-28 05:27:26 +02:00
"type" : "integer"
2023-06-15 03:47:18 +02:00
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"assets" ,
2024-03-27 22:14:29 +02:00
"yearsAgo"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-06-15 03:47:18 +02:00
} ,
2024-05-28 04:16:53 +02:00
"MemoryResponse" : {
"properties" : {
"enabled" : {
"type" : "boolean"
}
} ,
"required" : [
"enabled"
] ,
"type" : "object"
} ,
2024-04-02 16:23:17 +02:00
"MemoryResponseDto" : {
"properties" : {
"assets" : {
"items" : {
"$ref" : "#/components/schemas/AssetResponseDto"
} ,
"type" : "array"
} ,
"createdAt" : {
"format" : "date-time" ,
"type" : "string"
} ,
"data" : {
2024-04-02 21:21:58 +02:00
"$ref" : "#/components/schemas/OnThisDayDto"
2024-04-02 16:23:17 +02:00
} ,
"deletedAt" : {
"format" : "date-time" ,
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"isSaved" : {
"type" : "boolean"
} ,
"memoryAt" : {
"format" : "date-time" ,
"type" : "string"
} ,
"ownerId" : {
"type" : "string"
} ,
"seenAt" : {
"format" : "date-time" ,
"type" : "string"
} ,
"type" : {
2024-07-31 19:08:31 +02:00
"$ref" : "#/components/schemas/MemoryType"
2024-04-02 16:23:17 +02:00
} ,
"updatedAt" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assets" ,
"createdAt" ,
"data" ,
"id" ,
"isSaved" ,
"memoryAt" ,
"ownerId" ,
"type" ,
"updatedAt"
] ,
"type" : "object"
} ,
"MemoryType" : {
"enum" : [
"on_this_day"
] ,
"type" : "string"
} ,
2024-05-28 04:16:53 +02:00
"MemoryUpdate" : {
"properties" : {
"enabled" : {
"type" : "boolean"
}
} ,
"type" : "object"
} ,
2024-04-02 16:23:17 +02:00
"MemoryUpdateDto" : {
"properties" : {
"isSaved" : {
"type" : "boolean"
} ,
"memoryAt" : {
"format" : "date-time" ,
"type" : "string"
} ,
"seenAt" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"type" : "object"
} ,
2023-07-11 23:52:41 +02:00
"MergePersonDto" : {
"properties" : {
"ids" : {
"items" : {
2023-08-01 18:49:18 +02:00
"format" : "uuid" ,
"type" : "string"
} ,
"type" : "array"
2023-07-11 23:52:41 +02:00
}
} ,
"required" : [
"ids"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-07-11 23:52:41 +02:00
} ,
2024-02-17 19:00:55 +02:00
"MetadataSearchDto" : {
"properties" : {
"checksum" : {
"type" : "string"
} ,
"city" : {
2024-08-02 05:27:40 +02:00
"nullable" : true ,
2024-02-17 19:00:55 +02:00
"type" : "string"
} ,
"country" : {
2024-08-02 05:27:40 +02:00
"nullable" : true ,
2024-02-17 19:00:55 +02:00
"type" : "string"
} ,
"createdAfter" : {
"format" : "date-time" ,
"type" : "string"
} ,
"createdBefore" : {
"format" : "date-time" ,
"type" : "string"
} ,
"deviceAssetId" : {
"type" : "string"
} ,
"deviceId" : {
"type" : "string"
} ,
"encodedVideoPath" : {
"type" : "string"
} ,
"id" : {
"format" : "uuid" ,
"type" : "string"
} ,
"isArchived" : {
"type" : "boolean"
} ,
"isEncoded" : {
"type" : "boolean"
} ,
"isFavorite" : {
"type" : "boolean"
} ,
"isMotion" : {
"type" : "boolean"
} ,
"isNotInAlbum" : {
"type" : "boolean"
} ,
"isOffline" : {
"type" : "boolean"
} ,
"isVisible" : {
"type" : "boolean"
} ,
"lensModel" : {
2024-08-02 05:27:40 +02:00
"nullable" : true ,
2024-02-17 19:00:55 +02:00
"type" : "string"
} ,
"libraryId" : {
"format" : "uuid" ,
2024-06-21 01:02:05 +02:00
"nullable" : true ,
2024-02-17 19:00:55 +02:00
"type" : "string"
} ,
"make" : {
"type" : "string"
} ,
"model" : {
2024-08-02 05:27:40 +02:00
"nullable" : true ,
2024-02-17 19:00:55 +02:00
"type" : "string"
} ,
"order" : {
"$ref" : "#/components/schemas/AssetOrder"
} ,
"originalFileName" : {
"type" : "string"
} ,
"originalPath" : {
"type" : "string"
} ,
"page" : {
2024-04-23 00:13:44 +02:00
"minimum" : 1 ,
2024-02-17 19:00:55 +02:00
"type" : "number"
} ,
"personIds" : {
"items" : {
2024-03-09 22:01:52 +02:00
"format" : "uuid" ,
2024-02-17 19:00:55 +02:00
"type" : "string"
} ,
"type" : "array"
} ,
2024-04-02 06:56:56 +02:00
"previewPath" : {
"type" : "string"
} ,
2024-02-17 19:00:55 +02:00
"size" : {
2024-04-23 00:13:44 +02:00
"maximum" : 1000 ,
"minimum" : 1 ,
2024-02-17 19:00:55 +02:00
"type" : "number"
} ,
"state" : {
2024-08-02 05:27:40 +02:00
"nullable" : true ,
2024-02-17 19:00:55 +02:00
"type" : "string"
} ,
"takenAfter" : {
"format" : "date-time" ,
"type" : "string"
} ,
"takenBefore" : {
"format" : "date-time" ,
"type" : "string"
} ,
2024-04-02 06:56:56 +02:00
"thumbnailPath" : {
"type" : "string"
} ,
2024-02-17 19:00:55 +02:00
"trashedAfter" : {
"format" : "date-time" ,
"type" : "string"
} ,
"trashedBefore" : {
"format" : "date-time" ,
"type" : "string"
} ,
"type" : {
"$ref" : "#/components/schemas/AssetTypeEnum"
} ,
"updatedAfter" : {
"format" : "date-time" ,
"type" : "string"
} ,
"updatedBefore" : {
"format" : "date-time" ,
"type" : "string"
} ,
"withArchived" : {
2024-02-21 05:59:26 +02:00
"default" : false ,
2024-02-17 19:00:55 +02:00
"type" : "boolean"
} ,
"withDeleted" : {
"type" : "boolean"
} ,
"withExif" : {
"type" : "boolean"
} ,
"withPeople" : {
"type" : "boolean"
} ,
"withStacked" : {
"type" : "boolean"
}
} ,
"type" : "object"
} ,
2023-09-01 13:08:42 +02:00
"OAuthAuthorizeResponseDto" : {
"properties" : {
"url" : {
"type" : "string"
}
} ,
"required" : [
"url"
] ,
"type" : "object"
} ,
2023-06-10 06:14:18 +02:00
"OAuthCallbackDto" : {
2023-06-01 03:51:28 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"url" : {
2023-06-01 03:51:28 +02:00
"type" : "string"
}
} ,
"required" : [
2023-06-10 06:14:18 +02:00
"url"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-06-01 03:51:28 +02:00
} ,
2023-06-10 06:14:18 +02:00
"OAuthConfigDto" : {
2023-06-01 03:51:28 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"redirectUri" : {
2023-06-01 03:51:28 +02:00
"type" : "string"
}
} ,
"required" : [
2023-06-10 06:14:18 +02:00
"redirectUri"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-06-01 03:51:28 +02:00
} ,
2024-04-02 21:21:58 +02:00
"OnThisDayDto" : {
"properties" : {
"year" : {
2024-04-23 00:13:44 +02:00
"minimum" : 1 ,
2024-04-02 21:21:58 +02:00
"type" : "number"
}
} ,
"required" : [
"year"
] ,
"type" : "object"
} ,
2024-07-08 22:41:39 +02:00
"PartnerDirection" : {
"enum" : [
"shared-by" ,
"shared-with"
] ,
"type" : "string"
} ,
2023-11-11 23:06:19 +02:00
"PartnerResponseDto" : {
"properties" : {
2023-11-14 05:10:35 +02:00
"avatarColor" : {
"$ref" : "#/components/schemas/UserAvatarColor"
} ,
2023-11-11 23:06:19 +02:00
"email" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"inTimeline" : {
"type" : "boolean"
} ,
2023-11-12 03:03:32 +02:00
"name" : {
"type" : "string"
} ,
2023-11-11 23:06:19 +02:00
"profileImagePath" : {
"type" : "string"
}
} ,
"required" : [
2023-11-14 05:10:35 +02:00
"avatarColor" ,
2024-01-22 18:49:51 +02:00
"email" ,
2024-01-13 02:43:36 +02:00
"id" ,
"name" ,
2024-05-27 00:15:52 +02:00
"profileImagePath"
2023-11-11 23:06:19 +02:00
] ,
"type" : "object"
} ,
2023-10-14 19:12:59 +02:00
"PathEntityType" : {
"enum" : [
"asset" ,
"person" ,
"user"
] ,
"type" : "string"
} ,
"PathType" : {
"enum" : [
"original" ,
2024-04-02 06:56:56 +02:00
"preview" ,
"thumbnail" ,
2023-10-14 19:12:59 +02:00
"encoded_video" ,
"sidecar" ,
"face" ,
"profile"
] ,
"type" : "string"
} ,
2023-07-18 20:09:43 +02:00
"PeopleResponseDto" : {
"properties" : {
2024-07-25 21:59:28 +02:00
"hasNextPage" : {
"description" : "This property was added in v1.110.0" ,
"type" : "boolean"
} ,
2024-02-22 00:03:45 +02:00
"hidden" : {
"type" : "integer"
} ,
2023-08-01 18:49:18 +02:00
"people" : {
"items" : {
"$ref" : "#/components/schemas/PersonResponseDto"
} ,
"type" : "array"
} ,
2023-07-18 20:09:43 +02:00
"total" : {
2023-08-06 22:55:14 +02:00
"type" : "integer"
2023-07-18 20:09:43 +02:00
}
} ,
"required" : [
2024-02-22 00:03:45 +02:00
"hidden" ,
2024-01-22 18:49:51 +02:00
"people" ,
2024-01-28 02:54:31 +02:00
"total"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-07-18 20:09:43 +02:00
} ,
2023-07-23 05:00:43 +02:00
"PeopleUpdateDto" : {
"properties" : {
"people" : {
"items" : {
"$ref" : "#/components/schemas/PeopleUpdateItem"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-07-23 05:00:43 +02:00
}
} ,
"required" : [
"people"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-07-23 05:00:43 +02:00
} ,
"PeopleUpdateItem" : {
"properties" : {
2023-08-18 22:10:29 +02:00
"birthDate" : {
2023-09-01 18:40:00 +02:00
"description" : "Person date of birth.\nNote: the mobile app cannot currently set the birth date to null." ,
2023-08-18 22:10:29 +02:00
"format" : "date" ,
"nullable" : true ,
"type" : "string"
} ,
2023-07-23 05:00:43 +02:00
"featureFaceAssetId" : {
2023-08-01 18:49:18 +02:00
"description" : "Asset is used to get the feature face thumbnail." ,
"type" : "string"
} ,
"id" : {
"description" : "Person id." ,
"type" : "string"
2023-07-23 05:00:43 +02:00
} ,
"isHidden" : {
2023-08-01 18:49:18 +02:00
"description" : "Person visibility" ,
"type" : "boolean"
} ,
"name" : {
"description" : "Person name." ,
"type" : "string"
2023-07-23 05:00:43 +02:00
}
} ,
"required" : [
"id"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-07-23 05:00:43 +02:00
} ,
2024-03-07 22:34:57 +02:00
"PersonCreateDto" : {
"properties" : {
"birthDate" : {
"description" : "Person date of birth.\nNote: the mobile app cannot currently set the birth date to null." ,
"format" : "date" ,
"nullable" : true ,
"type" : "string"
} ,
"isHidden" : {
"description" : "Person visibility" ,
"type" : "boolean"
} ,
"name" : {
"description" : "Person name." ,
"type" : "string"
}
} ,
"type" : "object"
} ,
2023-06-10 06:14:18 +02:00
"PersonResponseDto" : {
2022-12-05 19:56:44 +02:00
"properties" : {
2023-08-18 22:10:29 +02:00
"birthDate" : {
"format" : "date" ,
"nullable" : true ,
"type" : "string"
} ,
2023-06-10 06:14:18 +02:00
"id" : {
2023-05-22 05:18:10 +02:00
"type" : "string"
2022-12-05 19:56:44 +02:00
} ,
2023-08-01 18:49:18 +02:00
"isHidden" : {
"type" : "boolean"
} ,
2023-06-10 06:14:18 +02:00
"name" : {
2023-05-22 05:18:10 +02:00
"type" : "string"
2022-12-05 19:56:44 +02:00
} ,
2023-06-10 06:14:18 +02:00
"thumbnailPath" : {
2023-05-22 05:18:10 +02:00
"type" : "string"
2024-06-28 02:16:26 +02:00
} ,
"updatedAt" : {
"description" : "This property was added in v1.107.0" ,
"format" : "date-time" ,
"type" : "string"
2022-12-05 19:56:44 +02:00
}
} ,
"required" : [
2023-08-18 22:10:29 +02:00
"birthDate" ,
2023-06-10 06:14:18 +02:00
"id" ,
2024-01-22 18:49:51 +02:00
"isHidden" ,
2023-06-10 06:14:18 +02:00
"name" ,
2024-01-22 18:49:51 +02:00
"thumbnailPath"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2022-12-05 19:56:44 +02:00
} ,
2023-10-24 17:53:49 +02:00
"PersonStatisticsResponseDto" : {
"properties" : {
"assets" : {
"type" : "integer"
}
} ,
"required" : [
"assets"
] ,
"type" : "object"
} ,
2023-06-10 06:14:18 +02:00
"PersonUpdateDto" : {
2022-12-05 19:56:44 +02:00
"properties" : {
2023-08-18 22:10:29 +02:00
"birthDate" : {
2023-09-01 18:40:00 +02:00
"description" : "Person date of birth.\nNote: the mobile app cannot currently set the birth date to null." ,
2023-08-18 22:10:29 +02:00
"format" : "date" ,
"nullable" : true ,
"type" : "string"
} ,
2023-07-03 00:46:20 +02:00
"featureFaceAssetId" : {
2023-08-01 18:49:18 +02:00
"description" : "Asset is used to get the feature face thumbnail." ,
"type" : "string"
2023-07-18 20:09:43 +02:00
} ,
"isHidden" : {
2023-08-01 18:49:18 +02:00
"description" : "Person visibility" ,
"type" : "boolean"
} ,
"name" : {
"description" : "Person name." ,
"type" : "string"
2022-12-05 19:56:44 +02:00
}
2023-08-01 18:49:18 +02:00
} ,
"type" : "object"
2022-12-05 19:56:44 +02:00
} ,
2023-12-05 17:43:15 +02:00
"PersonWithFacesResponseDto" : {
"properties" : {
"birthDate" : {
"format" : "date" ,
"nullable" : true ,
"type" : "string"
} ,
"faces" : {
"items" : {
"$ref" : "#/components/schemas/AssetFaceWithoutPersonResponseDto"
} ,
"type" : "array"
} ,
"id" : {
"type" : "string"
} ,
"isHidden" : {
"type" : "boolean"
} ,
"name" : {
"type" : "string"
} ,
"thumbnailPath" : {
"type" : "string"
2024-06-28 02:16:26 +02:00
} ,
"updatedAt" : {
"description" : "This property was added in v1.107.0" ,
"format" : "date-time" ,
"type" : "string"
2023-12-05 17:43:15 +02:00
}
} ,
"required" : [
"birthDate" ,
"faces" ,
"id" ,
2024-01-22 18:49:51 +02:00
"isHidden" ,
2023-12-05 17:43:15 +02:00
"name" ,
2024-01-22 18:49:51 +02:00
"thumbnailPath"
2023-12-05 17:43:15 +02:00
] ,
"type" : "object"
} ,
2024-02-24 02:42:37 +02:00
"PlacesResponseDto" : {
"properties" : {
"admin1name" : {
"type" : "string"
} ,
"admin2name" : {
"type" : "string"
} ,
"latitude" : {
"type" : "number"
} ,
"longitude" : {
"type" : "number"
} ,
"name" : {
"type" : "string"
}
} ,
"required" : [
"latitude" ,
"longitude" ,
"name"
] ,
"type" : "object"
} ,
2024-07-26 17:34:35 +02:00
"PurchaseResponse" : {
"properties" : {
"hideBuyButtonUntil" : {
"type" : "string"
} ,
"showSupportBadge" : {
"type" : "boolean"
}
} ,
"required" : [
"hideBuyButtonUntil" ,
"showSupportBadge"
] ,
"type" : "object"
} ,
"PurchaseUpdate" : {
"properties" : {
"hideBuyButtonUntil" : {
"type" : "string"
} ,
"showSupportBadge" : {
"type" : "boolean"
}
} ,
"type" : "object"
} ,
2023-06-10 06:14:18 +02:00
"QueueStatusDto" : {
2022-12-05 19:56:44 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"isActive" : {
2022-12-05 19:56:44 +02:00
"type" : "boolean"
} ,
2023-06-10 06:14:18 +02:00
"isPaused" : {
2022-12-05 19:56:44 +02:00
"type" : "boolean"
}
} ,
"required" : [
2023-06-10 06:14:18 +02:00
"isActive" ,
"isPaused"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2022-12-05 19:56:44 +02:00
} ,
2024-08-09 19:45:52 +02:00
"RatingResponse" : {
"properties" : {
"enabled" : {
2024-08-13 21:39:25 +02:00
"default" : false ,
2024-08-09 19:45:52 +02:00
"type" : "boolean"
}
} ,
"required" : [
"enabled"
] ,
"type" : "object"
} ,
"RatingUpdate" : {
"properties" : {
"enabled" : {
"type" : "boolean"
}
} ,
"type" : "object"
} ,
2023-11-10 04:32:31 +02:00
"ReactionLevel" : {
"enum" : [
"album" ,
"asset"
] ,
"type" : "string"
} ,
2023-11-01 05:13:34 +02:00
"ReactionType" : {
"enum" : [
"comment" ,
"like"
] ,
"type" : "string"
} ,
2024-04-20 02:36:15 +02:00
"ReverseGeocodingStateResponseDto" : {
"properties" : {
"lastImportFileName" : {
"nullable" : true ,
"type" : "string"
} ,
"lastUpdate" : {
"nullable" : true ,
"type" : "string"
}
} ,
"required" : [
"lastImportFileName" ,
"lastUpdate"
] ,
"type" : "object"
} ,
2023-09-20 13:16:33 +02:00
"ScanLibraryDto" : {
"properties" : {
"refreshAllFiles" : {
"type" : "boolean"
} ,
"refreshModifiedFiles" : {
"type" : "boolean"
}
} ,
"type" : "object"
} ,
2023-06-10 06:14:18 +02:00
"SearchAlbumResponseDto" : {
2022-12-05 19:56:44 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"count" : {
"type" : "integer"
} ,
2023-08-01 18:49:18 +02:00
"facets" : {
"items" : {
"$ref" : "#/components/schemas/SearchFacetResponseDto"
} ,
"type" : "array"
} ,
2023-06-10 06:14:18 +02:00
"items" : {
"items" : {
"$ref" : "#/components/schemas/AlbumResponseDto"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-06-10 06:14:18 +02:00
} ,
2023-08-01 18:49:18 +02:00
"total" : {
"type" : "integer"
2022-12-05 19:56:44 +02:00
}
} ,
"required" : [
2023-06-10 06:14:18 +02:00
"count" ,
2024-01-22 18:49:51 +02:00
"facets" ,
2023-06-10 06:14:18 +02:00
"items" ,
2024-01-22 18:49:51 +02:00
"total"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2022-12-05 19:56:44 +02:00
} ,
2023-06-10 06:14:18 +02:00
"SearchAssetResponseDto" : {
2023-01-12 04:34:36 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"count" : {
"type" : "integer"
2023-02-12 07:54:07 +02:00
} ,
2023-08-01 18:49:18 +02:00
"facets" : {
"items" : {
"$ref" : "#/components/schemas/SearchFacetResponseDto"
} ,
"type" : "array"
} ,
2023-06-10 06:14:18 +02:00
"items" : {
"items" : {
"$ref" : "#/components/schemas/AssetResponseDto"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-02-12 07:54:07 +02:00
} ,
2024-02-13 03:50:47 +02:00
"nextPage" : {
"nullable" : true ,
"type" : "string"
} ,
2023-08-01 18:49:18 +02:00
"total" : {
"type" : "integer"
2023-01-12 04:34:36 +02:00
}
} ,
"required" : [
2023-06-10 06:14:18 +02:00
"count" ,
2024-01-22 18:49:51 +02:00
"facets" ,
2023-06-10 06:14:18 +02:00
"items" ,
2024-02-13 03:50:47 +02:00
"nextPage" ,
2024-01-22 18:49:51 +02:00
"total"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2022-12-05 19:56:44 +02:00
} ,
2023-06-10 06:14:18 +02:00
"SearchExploreItem" : {
2023-01-25 18:35:28 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"data" : {
"$ref" : "#/components/schemas/AssetResponseDto"
2023-08-01 18:49:18 +02:00
} ,
"value" : {
"type" : "string"
2022-12-05 19:56:44 +02:00
}
2023-01-25 18:35:28 +02:00
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"data" ,
"value"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2022-12-05 19:56:44 +02:00
} ,
2023-06-10 06:14:18 +02:00
"SearchExploreResponseDto" : {
2022-12-05 19:56:44 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"fieldName" : {
2022-12-06 23:46:13 +02:00
"type" : "string"
} ,
2023-06-10 06:14:18 +02:00
"items" : {
"items" : {
"$ref" : "#/components/schemas/SearchExploreItem"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2022-12-05 19:56:44 +02:00
}
} ,
"required" : [
2023-06-10 06:14:18 +02:00
"fieldName" ,
"items"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2022-12-05 19:56:44 +02:00
} ,
2023-06-10 06:14:18 +02:00
"SearchFacetCountResponseDto" : {
2022-12-05 19:56:44 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"count" : {
"type" : "integer"
2022-12-05 19:56:44 +02:00
} ,
2023-06-10 06:14:18 +02:00
"value" : {
2022-12-05 19:56:44 +02:00
"type" : "string"
}
} ,
"required" : [
2023-06-10 06:14:18 +02:00
"count" ,
"value"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-01-25 18:35:28 +02:00
} ,
2023-06-10 06:14:18 +02:00
"SearchFacetResponseDto" : {
2023-01-25 18:35:28 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"counts" : {
"items" : {
"$ref" : "#/components/schemas/SearchFacetCountResponseDto"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
} ,
"fieldName" : {
"type" : "string"
2023-01-25 18:35:28 +02:00
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"counts" ,
"fieldName"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2022-12-05 19:56:44 +02:00
} ,
2023-06-10 06:14:18 +02:00
"SearchResponseDto" : {
2022-12-05 19:56:44 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"albums" : {
"$ref" : "#/components/schemas/SearchAlbumResponseDto"
2023-06-04 04:41:27 +02:00
} ,
2023-06-10 06:14:18 +02:00
"assets" : {
"$ref" : "#/components/schemas/SearchAssetResponseDto"
2022-12-05 19:56:44 +02:00
}
} ,
"required" : [
2023-06-10 06:14:18 +02:00
"albums" ,
"assets"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2022-12-05 19:56:44 +02:00
} ,
2024-02-13 21:54:58 +02:00
"SearchSuggestionType" : {
"enum" : [
"country" ,
"state" ,
"city" ,
"camera-make" ,
"camera-model"
] ,
"type" : "string"
} ,
2024-06-26 14:25:09 +02:00
"ServerAboutResponseDto" : {
"properties" : {
"build" : {
"type" : "string"
} ,
"buildImage" : {
"type" : "string"
} ,
"buildImageUrl" : {
"type" : "string"
} ,
"buildUrl" : {
"type" : "string"
} ,
"exiftool" : {
"type" : "string"
} ,
"ffmpeg" : {
"type" : "string"
} ,
"imagemagick" : {
"type" : "string"
} ,
"libvips" : {
"type" : "string"
} ,
2024-07-01 19:43:16 +02:00
"licensed" : {
"type" : "boolean"
} ,
2024-06-26 14:25:09 +02:00
"nodejs" : {
"type" : "string"
} ,
"repository" : {
"type" : "string"
} ,
"repositoryUrl" : {
"type" : "string"
} ,
"sourceCommit" : {
"type" : "string"
} ,
"sourceRef" : {
"type" : "string"
} ,
"sourceUrl" : {
"type" : "string"
} ,
"version" : {
"type" : "string"
} ,
"versionUrl" : {
"type" : "string"
}
} ,
"required" : [
2024-07-01 19:43:16 +02:00
"licensed" ,
2024-06-26 14:25:09 +02:00
"version" ,
"versionUrl"
] ,
"type" : "object"
} ,
2023-09-09 04:51:46 +02:00
"ServerConfigDto" : {
"properties" : {
2024-01-04 04:54:48 +02:00
"externalDomain" : {
"type" : "string"
} ,
2023-10-11 04:37:13 +02:00
"isInitialized" : {
"type" : "boolean"
} ,
2024-01-04 07:28:32 +02:00
"isOnboarded" : {
"type" : "boolean"
} ,
2023-09-09 04:51:46 +02:00
"loginPageMessage" : {
"type" : "string"
} ,
"oauthButtonText" : {
"type" : "string"
2023-10-06 09:01:14 +02:00
} ,
"trashDays" : {
"type" : "integer"
2024-03-06 07:45:40 +02:00
} ,
"userDeleteDelay" : {
"type" : "integer"
2023-09-09 04:51:46 +02:00
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"externalDomain" ,
2024-01-04 04:54:48 +02:00
"isInitialized" ,
2024-01-04 07:28:32 +02:00
"isOnboarded" ,
2024-01-22 18:49:51 +02:00
"loginPageMessage" ,
"oauthButtonText" ,
2024-03-06 07:45:40 +02:00
"trashDays" ,
"userDeleteDelay"
2023-09-09 04:51:46 +02:00
] ,
"type" : "object"
} ,
2023-08-18 06:55:26 +02:00
"ServerFeaturesDto" : {
"properties" : {
2023-08-25 19:44:52 +02:00
"configFile" : {
"type" : "boolean"
} ,
2024-05-16 19:08:37 +02:00
"duplicateDetection" : {
"type" : "boolean"
} ,
2024-05-02 16:43:18 +02:00
"email" : {
"type" : "boolean"
} ,
2023-08-25 06:15:03 +02:00
"facialRecognition" : {
2023-08-18 06:55:26 +02:00
"type" : "boolean"
} ,
2023-09-09 04:51:46 +02:00
"map" : {
"type" : "boolean"
} ,
2023-08-18 06:55:26 +02:00
"oauth" : {
"type" : "boolean"
} ,
"oauthAutoLaunch" : {
"type" : "boolean"
} ,
"passwordLogin" : {
"type" : "boolean"
} ,
2023-09-26 09:03:57 +02:00
"reverseGeocoding" : {
"type" : "boolean"
} ,
2023-08-18 06:55:26 +02:00
"search" : {
"type" : "boolean"
2023-08-25 06:15:03 +02:00
} ,
"sidecar" : {
"type" : "boolean"
} ,
2024-01-29 16:51:22 +02:00
"smartSearch" : {
"type" : "boolean"
} ,
2023-10-06 09:01:14 +02:00
"trash" : {
"type" : "boolean"
2023-08-18 06:55:26 +02:00
}
} ,
"required" : [
2023-09-09 04:51:46 +02:00
"configFile" ,
2024-05-16 19:08:37 +02:00
"duplicateDetection" ,
2024-05-02 16:43:18 +02:00
"email" ,
2023-08-25 06:15:03 +02:00
"facialRecognition" ,
2023-09-09 04:51:46 +02:00
"map" ,
2023-08-18 06:55:26 +02:00
"oauth" ,
"oauthAutoLaunch" ,
2023-09-09 04:51:46 +02:00
"passwordLogin" ,
2024-01-22 18:49:51 +02:00
"reverseGeocoding" ,
"search" ,
2023-09-09 04:51:46 +02:00
"sidecar" ,
2024-01-29 16:51:22 +02:00
"smartSearch" ,
2024-01-22 18:49:51 +02:00
"trash"
2023-08-18 06:55:26 +02:00
] ,
"type" : "object"
} ,
2023-07-16 03:24:46 +02:00
"ServerMediaTypesResponseDto" : {
"properties" : {
2023-08-01 18:49:18 +02:00
"image" : {
2023-07-16 03:24:46 +02:00
"items" : {
"type" : "string"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-07-16 03:24:46 +02:00
} ,
2023-08-01 18:49:18 +02:00
"sidecar" : {
2023-07-16 03:24:46 +02:00
"items" : {
"type" : "string"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-07-16 03:24:46 +02:00
} ,
2023-08-01 18:49:18 +02:00
"video" : {
2023-07-16 03:24:46 +02:00
"items" : {
"type" : "string"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-07-16 03:24:46 +02:00
}
} ,
"required" : [
"image" ,
2024-01-22 18:49:51 +02:00
"sidecar" ,
"video"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-07-16 03:24:46 +02:00
} ,
2023-06-10 06:14:18 +02:00
"ServerPingResponse" : {
2022-12-05 19:56:44 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"res" : {
2023-08-01 18:49:18 +02:00
"example" : "pong" ,
2023-06-10 06:14:18 +02:00
"readOnly" : true ,
2023-08-01 18:49:18 +02:00
"type" : "string"
2022-12-05 19:56:44 +02:00
}
} ,
"required" : [
2023-06-10 06:14:18 +02:00
"res"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2022-12-05 19:56:44 +02:00
} ,
2023-06-10 06:14:18 +02:00
"ServerStatsResponseDto" : {
2022-12-05 19:56:44 +02:00
"properties" : {
"photos" : {
2023-08-01 18:49:18 +02:00
"default" : 0 ,
"type" : "integer"
2022-12-05 19:56:44 +02:00
} ,
2023-06-10 06:14:18 +02:00
"usage" : {
"default" : 0 ,
2023-08-01 18:49:18 +02:00
"format" : "int64" ,
"type" : "integer"
2022-12-05 19:56:44 +02:00
} ,
2023-06-10 06:14:18 +02:00
"usageByUser" : {
"default" : [ ] ,
"example" : [
{
"photos" : 1 ,
"videos" : 1 ,
"diskUsageRaw" : 1
}
] ,
"items" : {
"$ref" : "#/components/schemas/UsageByUserDto"
2023-08-01 18:49:18 +02:00
} ,
"title" : "Array of usage for each user" ,
"type" : "array"
} ,
"videos" : {
"default" : 0 ,
"type" : "integer"
2022-12-05 19:56:44 +02:00
}
} ,
"required" : [
"photos" ,
2023-06-10 06:14:18 +02:00
"usage" ,
2024-01-22 18:49:51 +02:00
"usageByUser" ,
"videos"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2022-12-05 19:56:44 +02:00
} ,
2024-05-22 11:25:55 +02:00
"ServerStorageResponseDto" : {
"properties" : {
"diskAvailable" : {
"type" : "string"
} ,
"diskAvailableRaw" : {
"format" : "int64" ,
"type" : "integer"
} ,
"diskSize" : {
"type" : "string"
} ,
"diskSizeRaw" : {
"format" : "int64" ,
"type" : "integer"
} ,
"diskUsagePercentage" : {
2024-06-12 18:36:24 +02:00
"format" : "double" ,
2024-05-22 11:25:55 +02:00
"type" : "number"
} ,
"diskUse" : {
"type" : "string"
} ,
"diskUseRaw" : {
"format" : "int64" ,
"type" : "integer"
}
} ,
"required" : [
"diskAvailable" ,
"diskAvailableRaw" ,
"diskSize" ,
"diskSizeRaw" ,
"diskUsagePercentage" ,
"diskUse" ,
"diskUseRaw"
] ,
"type" : "object"
} ,
2023-10-26 00:13:05 +02:00
"ServerThemeDto" : {
"properties" : {
2023-10-27 04:32:33 +02:00
"customCss" : {
"type" : "string"
2023-10-26 00:13:05 +02:00
}
} ,
"required" : [
2023-10-27 04:32:33 +02:00
"customCss"
2023-10-26 00:13:05 +02:00
] ,
"type" : "object"
} ,
2023-08-18 06:55:26 +02:00
"ServerVersionResponseDto" : {
2022-12-05 19:56:44 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"major" : {
"type" : "integer"
2023-05-15 19:30:53 +02:00
} ,
2023-06-10 06:14:18 +02:00
"minor" : {
"type" : "integer"
2023-05-25 04:13:02 +02:00
} ,
2023-06-10 06:14:18 +02:00
"patch" : {
"type" : "integer"
2022-12-05 19:56:44 +02:00
}
} ,
"required" : [
2023-06-10 06:14:18 +02:00
"major" ,
"minor" ,
"patch"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2022-12-05 19:56:44 +02:00
} ,
2024-04-19 12:47:29 +02:00
"SessionResponseDto" : {
"properties" : {
"createdAt" : {
"type" : "string"
} ,
"current" : {
"type" : "boolean"
} ,
"deviceOS" : {
"type" : "string"
} ,
"deviceType" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"updatedAt" : {
"type" : "string"
}
} ,
"required" : [
"createdAt" ,
"current" ,
"deviceOS" ,
"deviceType" ,
"id" ,
"updatedAt"
] ,
"type" : "object"
} ,
2023-06-21 03:08:43 +02:00
"SharedLinkCreateDto" : {
"properties" : {
2023-08-01 18:49:18 +02:00
"albumId" : {
"format" : "uuid" ,
"type" : "string"
} ,
"allowDownload" : {
"default" : true ,
"type" : "boolean"
} ,
"allowUpload" : {
"type" : "boolean"
2023-06-21 03:08:43 +02:00
} ,
"assetIds" : {
"items" : {
2023-08-01 18:49:18 +02:00
"format" : "uuid" ,
"type" : "string"
} ,
"type" : "array"
2023-06-21 03:08:43 +02:00
} ,
"description" : {
"type" : "string"
} ,
"expiresAt" : {
2023-08-01 18:49:18 +02:00
"default" : null ,
2023-06-21 03:08:43 +02:00
"format" : "date-time" ,
"nullable" : true ,
2023-08-01 18:49:18 +02:00
"type" : "string"
2023-06-21 03:08:43 +02:00
} ,
2023-10-29 03:35:38 +02:00
"password" : {
"type" : "string"
} ,
2023-10-14 03:46:30 +02:00
"showMetadata" : {
2023-08-01 18:49:18 +02:00
"default" : true ,
"type" : "boolean"
} ,
"type" : {
"$ref" : "#/components/schemas/SharedLinkType"
2023-06-21 03:08:43 +02:00
}
} ,
"required" : [
"type"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-06-21 03:08:43 +02:00
} ,
"SharedLinkEditDto" : {
"properties" : {
2023-08-01 18:49:18 +02:00
"allowDownload" : {
"type" : "boolean"
} ,
"allowUpload" : {
"type" : "boolean"
} ,
2023-10-22 17:05:10 +02:00
"changeExpiryTime" : {
"description" : "Few clients cannot send null to set the expiryTime to never.\nSetting this flag and not sending expiryAt is considered as null instead.\nClients that can send null values can ignore this." ,
"type" : "boolean"
} ,
2023-06-21 03:08:43 +02:00
"description" : {
"type" : "string"
} ,
"expiresAt" : {
"format" : "date-time" ,
2023-08-01 18:49:18 +02:00
"nullable" : true ,
"type" : "string"
2023-06-21 03:08:43 +02:00
} ,
2023-10-29 03:35:38 +02:00
"password" : {
"type" : "string"
} ,
2023-10-14 03:46:30 +02:00
"showMetadata" : {
2023-06-21 03:08:43 +02:00
"type" : "boolean"
}
2023-08-01 18:49:18 +02:00
} ,
"type" : "object"
2023-06-21 03:08:43 +02:00
} ,
2023-06-10 06:14:18 +02:00
"SharedLinkResponseDto" : {
2022-12-05 19:56:44 +02:00
"properties" : {
2023-08-01 18:49:18 +02:00
"album" : {
"$ref" : "#/components/schemas/AlbumResponseDto"
2023-06-10 06:14:18 +02:00
} ,
2023-08-01 18:49:18 +02:00
"allowDownload" : {
"type" : "boolean"
2023-06-10 06:14:18 +02:00
} ,
2023-08-01 18:49:18 +02:00
"allowUpload" : {
"type" : "boolean"
2023-06-10 06:14:18 +02:00
} ,
2023-08-01 18:49:18 +02:00
"assets" : {
"items" : {
"$ref" : "#/components/schemas/AssetResponseDto"
} ,
"type" : "array"
2023-06-10 06:14:18 +02:00
} ,
"createdAt" : {
"format" : "date-time" ,
"type" : "string"
} ,
2023-08-01 18:49:18 +02:00
"description" : {
"nullable" : true ,
"type" : "string"
} ,
2023-06-10 06:14:18 +02:00
"expiresAt" : {
"format" : "date-time" ,
2023-08-01 18:49:18 +02:00
"nullable" : true ,
"type" : "string"
2023-06-10 06:14:18 +02:00
} ,
2023-08-01 18:49:18 +02:00
"id" : {
"type" : "string"
2022-12-05 19:56:44 +02:00
} ,
2023-08-01 18:49:18 +02:00
"key" : {
"type" : "string"
2023-06-10 06:14:18 +02:00
} ,
2023-10-29 03:35:38 +02:00
"password" : {
"nullable" : true ,
"type" : "string"
} ,
2023-10-14 03:46:30 +02:00
"showMetadata" : {
2022-12-05 19:56:44 +02:00
"type" : "boolean"
2023-04-12 17:37:52 +02:00
} ,
2023-10-29 03:35:38 +02:00
"token" : {
"nullable" : true ,
"type" : "string"
} ,
2023-08-01 18:49:18 +02:00
"type" : {
"$ref" : "#/components/schemas/SharedLinkType"
2023-04-13 17:22:06 +02:00
} ,
2023-08-01 18:49:18 +02:00
"userId" : {
"type" : "string"
2022-12-05 19:56:44 +02:00
}
2023-06-10 06:14:18 +02:00
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"allowDownload" ,
"allowUpload" ,
"assets" ,
2023-06-10 06:14:18 +02:00
"createdAt" ,
2024-01-22 18:49:51 +02:00
"description" ,
2023-06-10 06:14:18 +02:00
"expiresAt" ,
2024-01-22 18:49:51 +02:00
"id" ,
"key" ,
"password" ,
"showMetadata" ,
"type" ,
"userId"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-06-10 06:14:18 +02:00
} ,
"SharedLinkType" : {
"enum" : [
"ALBUM" ,
"INDIVIDUAL"
2023-08-01 18:49:18 +02:00
] ,
"type" : "string"
2023-06-10 06:14:18 +02:00
} ,
"SignUpDto" : {
"properties" : {
"email" : {
2023-08-01 18:49:18 +02:00
"example" : "testuser@email.com" ,
"type" : "string"
2023-06-10 06:14:18 +02:00
} ,
2023-11-12 03:03:32 +02:00
"name" : {
2023-08-01 18:49:18 +02:00
"example" : "Admin" ,
"type" : "string"
2023-06-10 06:14:18 +02:00
} ,
2023-08-01 18:49:18 +02:00
"password" : {
"example" : "password" ,
"type" : "string"
2023-06-10 06:14:18 +02:00
}
} ,
"required" : [
"email" ,
2024-01-22 18:49:51 +02:00
"name" ,
"password"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2022-12-05 19:56:44 +02:00
} ,
2023-06-10 06:14:18 +02:00
"SmartInfoResponseDto" : {
2022-12-05 19:56:44 +02:00
"properties" : {
2023-08-01 18:49:18 +02:00
"objects" : {
2023-06-10 06:14:18 +02:00
"items" : {
"type" : "string"
2023-08-01 18:49:18 +02:00
} ,
2023-06-10 06:14:18 +02:00
"nullable" : true ,
2023-08-01 18:49:18 +02:00
"type" : "array"
} ,
"tags" : {
2022-12-05 19:56:44 +02:00
"items" : {
"type" : "string"
2023-08-01 18:49:18 +02:00
} ,
"nullable" : true ,
"type" : "array"
2022-12-05 19:56:44 +02:00
}
2023-08-01 18:49:18 +02:00
} ,
"type" : "object"
2022-12-05 19:56:44 +02:00
} ,
2024-02-17 19:00:55 +02:00
"SmartSearchDto" : {
"properties" : {
"city" : {
2024-08-02 05:27:40 +02:00
"nullable" : true ,
2024-02-17 19:00:55 +02:00
"type" : "string"
} ,
"country" : {
2024-08-02 05:27:40 +02:00
"nullable" : true ,
2024-02-17 19:00:55 +02:00
"type" : "string"
} ,
"createdAfter" : {
"format" : "date-time" ,
"type" : "string"
} ,
"createdBefore" : {
"format" : "date-time" ,
"type" : "string"
} ,
"deviceId" : {
"type" : "string"
} ,
"isArchived" : {
"type" : "boolean"
} ,
"isEncoded" : {
"type" : "boolean"
} ,
"isFavorite" : {
"type" : "boolean"
} ,
"isMotion" : {
"type" : "boolean"
} ,
2024-02-21 04:44:34 +02:00
"isNotInAlbum" : {
"type" : "boolean"
} ,
2024-02-17 19:00:55 +02:00
"isOffline" : {
"type" : "boolean"
} ,
"isVisible" : {
"type" : "boolean"
} ,
"lensModel" : {
2024-08-02 05:27:40 +02:00
"nullable" : true ,
2024-02-17 19:00:55 +02:00
"type" : "string"
} ,
"libraryId" : {
"format" : "uuid" ,
2024-06-21 01:02:05 +02:00
"nullable" : true ,
2024-02-17 19:00:55 +02:00
"type" : "string"
} ,
"make" : {
"type" : "string"
} ,
"model" : {
2024-08-02 05:27:40 +02:00
"nullable" : true ,
2024-02-17 19:00:55 +02:00
"type" : "string"
} ,
"page" : {
2024-04-23 00:13:44 +02:00
"minimum" : 1 ,
2024-02-17 19:00:55 +02:00
"type" : "number"
} ,
2024-02-29 23:14:48 +02:00
"personIds" : {
"items" : {
2024-03-09 22:01:52 +02:00
"format" : "uuid" ,
2024-02-29 23:14:48 +02:00
"type" : "string"
} ,
"type" : "array"
} ,
2024-02-17 19:00:55 +02:00
"query" : {
"type" : "string"
} ,
"size" : {
2024-04-23 00:13:44 +02:00
"maximum" : 1000 ,
"minimum" : 1 ,
2024-02-17 19:00:55 +02:00
"type" : "number"
} ,
"state" : {
2024-08-02 05:27:40 +02:00
"nullable" : true ,
2024-02-17 19:00:55 +02:00
"type" : "string"
} ,
"takenAfter" : {
"format" : "date-time" ,
"type" : "string"
} ,
"takenBefore" : {
"format" : "date-time" ,
"type" : "string"
} ,
"trashedAfter" : {
"format" : "date-time" ,
"type" : "string"
} ,
"trashedBefore" : {
"format" : "date-time" ,
"type" : "string"
} ,
"type" : {
"$ref" : "#/components/schemas/AssetTypeEnum"
} ,
"updatedAfter" : {
"format" : "date-time" ,
"type" : "string"
} ,
"updatedBefore" : {
"format" : "date-time" ,
"type" : "string"
} ,
"withArchived" : {
2024-02-21 05:59:26 +02:00
"default" : false ,
2024-02-17 19:00:55 +02:00
"type" : "boolean"
} ,
"withDeleted" : {
"type" : "boolean"
} ,
"withExif" : {
"type" : "boolean"
}
} ,
"required" : [
"query"
] ,
"type" : "object"
} ,
2023-06-10 06:14:18 +02:00
"SystemConfigDto" : {
2022-12-05 19:56:44 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"ffmpeg" : {
"$ref" : "#/components/schemas/SystemConfigFFmpegDto"
2022-12-05 19:56:44 +02:00
} ,
2024-04-02 06:56:56 +02:00
"image" : {
"$ref" : "#/components/schemas/SystemConfigImageDto"
} ,
2023-08-01 18:49:18 +02:00
"job" : {
"$ref" : "#/components/schemas/SystemConfigJobDto"
} ,
2023-10-31 22:19:12 +02:00
"library" : {
"$ref" : "#/components/schemas/SystemConfigLibraryDto"
} ,
2023-12-14 18:55:40 +02:00
"logging" : {
"$ref" : "#/components/schemas/SystemConfigLoggingDto"
} ,
2023-08-25 06:15:03 +02:00
"machineLearning" : {
"$ref" : "#/components/schemas/SystemConfigMachineLearningDto"
} ,
2023-09-09 04:51:46 +02:00
"map" : {
"$ref" : "#/components/schemas/SystemConfigMapDto"
} ,
2023-10-24 17:05:42 +02:00
"newVersionCheck" : {
"$ref" : "#/components/schemas/SystemConfigNewVersionCheckDto"
} ,
2024-05-02 16:43:18 +02:00
"notifications" : {
"$ref" : "#/components/schemas/SystemConfigNotificationsDto"
} ,
2023-06-10 06:14:18 +02:00
"oauth" : {
"$ref" : "#/components/schemas/SystemConfigOAuthDto"
} ,
"passwordLogin" : {
"$ref" : "#/components/schemas/SystemConfigPasswordLoginDto"
} ,
2023-09-26 09:03:57 +02:00
"reverseGeocoding" : {
"$ref" : "#/components/schemas/SystemConfigReverseGeocodingDto"
} ,
2024-01-04 04:54:48 +02:00
"server" : {
"$ref" : "#/components/schemas/SystemConfigServerDto"
} ,
2023-06-10 06:14:18 +02:00
"storageTemplate" : {
"$ref" : "#/components/schemas/SystemConfigStorageTemplateDto"
2023-08-08 16:39:51 +02:00
} ,
2023-10-23 20:38:41 +02:00
"theme" : {
"$ref" : "#/components/schemas/SystemConfigThemeDto"
} ,
2023-10-06 09:01:14 +02:00
"trash" : {
"$ref" : "#/components/schemas/SystemConfigTrashDto"
2024-03-06 07:45:40 +02:00
} ,
"user" : {
"$ref" : "#/components/schemas/SystemConfigUserDto"
2022-12-05 19:56:44 +02:00
}
} ,
"required" : [
2023-06-10 06:14:18 +02:00
"ffmpeg" ,
2024-04-02 06:56:56 +02:00
"image" ,
2024-01-22 18:49:51 +02:00
"job" ,
"library" ,
2023-12-14 18:55:40 +02:00
"logging" ,
2023-08-25 06:15:03 +02:00
"machineLearning" ,
2023-09-09 04:51:46 +02:00
"map" ,
2023-10-24 17:05:42 +02:00
"newVersionCheck" ,
2024-05-02 16:43:18 +02:00
"notifications" ,
2023-06-10 06:14:18 +02:00
"oauth" ,
"passwordLogin" ,
2023-09-26 09:03:57 +02:00
"reverseGeocoding" ,
2024-01-22 18:49:51 +02:00
"server" ,
2023-06-10 06:14:18 +02:00
"storageTemplate" ,
2023-10-31 22:19:12 +02:00
"theme" ,
2024-03-06 07:45:40 +02:00
"trash" ,
"user"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2022-12-05 19:56:44 +02:00
} ,
2023-06-10 06:14:18 +02:00
"SystemConfigFFmpegDto" : {
2022-12-05 19:56:44 +02:00
"properties" : {
2023-08-02 03:56:10 +02:00
"accel" : {
"$ref" : "#/components/schemas/TranscodeHWAccel"
} ,
2024-05-16 19:30:26 +02:00
"accelDecode" : {
"type" : "boolean"
} ,
2024-01-26 19:02:56 +02:00
"acceptedAudioCodecs" : {
"items" : {
"$ref" : "#/components/schemas/AudioCodec"
} ,
"type" : "array"
} ,
2024-07-21 23:14:23 +02:00
"acceptedContainers" : {
"items" : {
"$ref" : "#/components/schemas/VideoContainer"
} ,
"type" : "array"
} ,
2024-01-26 19:02:56 +02:00
"acceptedVideoCodecs" : {
"items" : {
"$ref" : "#/components/schemas/VideoCodec"
} ,
"type" : "array"
} ,
2023-09-03 03:22:42 +02:00
"bframes" : {
2024-04-23 00:13:44 +02:00
"maximum" : 16 ,
"minimum" : -1 ,
2023-09-03 03:22:42 +02:00
"type" : "integer"
} ,
"cqMode" : {
"$ref" : "#/components/schemas/CQMode"
} ,
2023-06-10 06:14:18 +02:00
"crf" : {
2024-04-23 00:13:44 +02:00
"maximum" : 51 ,
"minimum" : 0 ,
2023-06-10 06:14:18 +02:00
"type" : "integer"
} ,
2023-09-03 03:22:42 +02:00
"gopSize" : {
2024-04-23 00:13:44 +02:00
"minimum" : 0 ,
2023-09-03 03:22:42 +02:00
"type" : "integer"
} ,
2023-08-01 18:49:18 +02:00
"maxBitrate" : {
"type" : "string"
2023-06-10 06:14:18 +02:00
} ,
2023-09-03 03:22:42 +02:00
"npl" : {
2024-04-23 00:13:44 +02:00
"minimum" : 0 ,
2023-09-03 03:22:42 +02:00
"type" : "integer"
} ,
2024-01-30 03:40:02 +02:00
"preferredHwDevice" : {
"type" : "string"
} ,
2023-08-01 18:49:18 +02:00
"preset" : {
"type" : "string"
2023-06-10 06:14:18 +02:00
} ,
2023-09-03 03:22:42 +02:00
"refs" : {
2024-04-23 00:13:44 +02:00
"maximum" : 6 ,
"minimum" : 0 ,
2023-09-03 03:22:42 +02:00
"type" : "integer"
} ,
2023-06-10 06:14:18 +02:00
"targetAudioCodec" : {
2023-07-09 04:43:11 +02:00
"$ref" : "#/components/schemas/AudioCodec"
} ,
2023-06-10 06:14:18 +02:00
"targetResolution" : {
"type" : "string"
} ,
2023-08-01 18:49:18 +02:00
"targetVideoCodec" : {
"$ref" : "#/components/schemas/VideoCodec"
} ,
2023-09-03 03:22:42 +02:00
"temporalAQ" : {
"type" : "boolean"
} ,
2023-08-01 18:49:18 +02:00
"threads" : {
2024-04-23 00:13:44 +02:00
"minimum" : 0 ,
2023-08-01 18:49:18 +02:00
"type" : "integer"
} ,
2023-08-07 22:35:25 +02:00
"tonemap" : {
"$ref" : "#/components/schemas/ToneMapping"
} ,
2023-08-01 18:49:18 +02:00
"transcode" : {
"$ref" : "#/components/schemas/TranscodePolicy"
2023-06-10 06:14:18 +02:00
} ,
"twoPass" : {
"type" : "boolean"
2022-12-05 19:56:44 +02:00
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"accel" ,
2024-05-16 19:30:26 +02:00
"accelDecode" ,
2024-01-26 19:02:56 +02:00
"acceptedAudioCodecs" ,
2024-07-21 23:14:23 +02:00
"acceptedContainers" ,
2024-01-26 19:02:56 +02:00
"acceptedVideoCodecs" ,
2023-09-03 03:22:42 +02:00
"bframes" ,
2024-01-22 18:49:51 +02:00
"cqMode" ,
"crf" ,
2023-09-03 03:22:42 +02:00
"gopSize" ,
2024-01-22 18:49:51 +02:00
"maxBitrate" ,
2023-09-03 03:22:42 +02:00
"npl" ,
2024-01-30 03:40:02 +02:00
"preferredHwDevice" ,
2023-07-09 04:43:11 +02:00
"preset" ,
2024-01-22 18:49:51 +02:00
"refs" ,
"targetAudioCodec" ,
2023-06-10 06:14:18 +02:00
"targetResolution" ,
2024-01-22 18:49:51 +02:00
"targetVideoCodec" ,
2023-09-03 03:22:42 +02:00
"temporalAQ" ,
2024-01-22 18:49:51 +02:00
"threads" ,
"tonemap" ,
"transcode" ,
2023-07-09 04:43:11 +02:00
"twoPass"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2022-12-05 19:56:44 +02:00
} ,
2024-04-02 06:56:56 +02:00
"SystemConfigImageDto" : {
"properties" : {
"colorspace" : {
"$ref" : "#/components/schemas/Colorspace"
} ,
2024-04-19 17:50:13 +02:00
"extractEmbedded" : {
"type" : "boolean"
} ,
2024-04-02 06:56:56 +02:00
"previewFormat" : {
"$ref" : "#/components/schemas/ImageFormat"
} ,
"previewSize" : {
2024-04-23 00:13:44 +02:00
"minimum" : 1 ,
2024-04-02 06:56:56 +02:00
"type" : "integer"
} ,
"quality" : {
2024-04-23 00:13:44 +02:00
"maximum" : 100 ,
"minimum" : 1 ,
2024-04-02 06:56:56 +02:00
"type" : "integer"
} ,
"thumbnailFormat" : {
"$ref" : "#/components/schemas/ImageFormat"
} ,
"thumbnailSize" : {
2024-04-23 00:13:44 +02:00
"minimum" : 1 ,
2024-04-02 06:56:56 +02:00
"type" : "integer"
}
} ,
"required" : [
"colorspace" ,
2024-04-19 17:50:13 +02:00
"extractEmbedded" ,
2024-04-02 06:56:56 +02:00
"previewFormat" ,
"previewSize" ,
"quality" ,
"thumbnailFormat" ,
"thumbnailSize"
] ,
"type" : "object"
} ,
2023-06-10 06:14:18 +02:00
"SystemConfigJobDto" : {
2022-12-05 19:56:44 +02:00
"properties" : {
2023-08-01 18:49:18 +02:00
"backgroundTask" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/JobSettingsDto"
2022-12-05 19:56:44 +02:00
} ,
2024-01-18 07:08:48 +02:00
"faceDetection" : {
"$ref" : "#/components/schemas/JobSettingsDto"
} ,
2023-09-20 13:16:33 +02:00
"library" : {
"$ref" : "#/components/schemas/JobSettingsDto"
} ,
2023-08-01 18:49:18 +02:00
"metadataExtraction" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/JobSettingsDto"
} ,
2023-09-25 17:07:21 +02:00
"migration" : {
"$ref" : "#/components/schemas/JobSettingsDto"
} ,
2024-05-02 16:43:18 +02:00
"notifications" : {
"$ref" : "#/components/schemas/JobSettingsDto"
} ,
2023-08-01 18:49:18 +02:00
"search" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/JobSettingsDto"
} ,
2023-08-01 18:49:18 +02:00
"sidecar" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/JobSettingsDto"
} ,
2023-12-16 18:50:46 +02:00
"smartSearch" : {
"$ref" : "#/components/schemas/JobSettingsDto"
} ,
2023-08-01 18:49:18 +02:00
"thumbnailGeneration" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/JobSettingsDto"
} ,
2023-08-01 18:49:18 +02:00
"videoConversion" : {
2023-06-10 06:14:18 +02:00
"$ref" : "#/components/schemas/JobSettingsDto"
2022-12-05 19:56:44 +02:00
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"backgroundTask" ,
"faceDetection" ,
"library" ,
2023-06-10 06:14:18 +02:00
"metadataExtraction" ,
2023-09-25 17:07:21 +02:00
"migration" ,
2024-05-02 16:43:18 +02:00
"notifications" ,
2023-06-10 06:14:18 +02:00
"search" ,
2023-09-20 13:16:33 +02:00
"sidecar" ,
2024-01-22 18:49:51 +02:00
"smartSearch" ,
"thumbnailGeneration" ,
"videoConversion"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2022-12-05 19:56:44 +02:00
} ,
2023-10-31 22:19:12 +02:00
"SystemConfigLibraryDto" : {
"properties" : {
"scan" : {
"$ref" : "#/components/schemas/SystemConfigLibraryScanDto"
2024-01-31 10:15:54 +02:00
} ,
"watch" : {
"$ref" : "#/components/schemas/SystemConfigLibraryWatchDto"
2023-10-31 22:19:12 +02:00
}
} ,
"required" : [
2024-01-31 10:15:54 +02:00
"scan" ,
"watch"
2023-10-31 22:19:12 +02:00
] ,
"type" : "object"
} ,
"SystemConfigLibraryScanDto" : {
"properties" : {
"cronExpression" : {
"type" : "string"
} ,
"enabled" : {
"type" : "boolean"
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"cronExpression" ,
"enabled"
2023-10-31 22:19:12 +02:00
] ,
"type" : "object"
} ,
2024-01-31 10:15:54 +02:00
"SystemConfigLibraryWatchDto" : {
"properties" : {
"enabled" : {
"type" : "boolean"
}
} ,
"required" : [
2024-02-28 22:20:10 +02:00
"enabled"
2024-01-31 10:15:54 +02:00
] ,
"type" : "object"
} ,
2023-12-14 18:55:40 +02:00
"SystemConfigLoggingDto" : {
"properties" : {
"enabled" : {
"type" : "boolean"
} ,
"level" : {
"$ref" : "#/components/schemas/LogLevel"
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"enabled" ,
"level"
2023-12-14 18:55:40 +02:00
] ,
"type" : "object"
} ,
2023-08-25 06:15:03 +02:00
"SystemConfigMachineLearningDto" : {
"properties" : {
2023-08-29 15:58:00 +02:00
"clip" : {
"$ref" : "#/components/schemas/CLIPConfig"
2023-08-25 06:15:03 +02:00
} ,
2024-05-16 19:08:37 +02:00
"duplicateDetection" : {
"$ref" : "#/components/schemas/DuplicateDetectionConfig"
} ,
2023-08-29 15:58:00 +02:00
"enabled" : {
2023-08-25 06:15:03 +02:00
"type" : "boolean"
} ,
2023-08-29 15:58:00 +02:00
"facialRecognition" : {
2024-06-07 05:09:47 +02:00
"$ref" : "#/components/schemas/FacialRecognitionConfig"
2023-08-25 06:15:03 +02:00
} ,
"url" : {
"type" : "string"
}
} ,
"required" : [
2023-08-29 15:58:00 +02:00
"clip" ,
2024-05-16 19:08:37 +02:00
"duplicateDetection" ,
2024-01-22 18:49:51 +02:00
"enabled" ,
"facialRecognition" ,
"url"
2023-08-25 06:15:03 +02:00
] ,
"type" : "object"
} ,
2023-09-09 04:51:46 +02:00
"SystemConfigMapDto" : {
"properties" : {
2023-11-09 18:10:56 +02:00
"darkStyle" : {
"type" : "string"
} ,
2023-09-09 04:51:46 +02:00
"enabled" : {
"type" : "boolean"
} ,
2023-11-09 18:10:56 +02:00
"lightStyle" : {
2023-09-09 04:51:46 +02:00
"type" : "string"
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"darkStyle" ,
2023-09-09 04:51:46 +02:00
"enabled" ,
2024-01-22 18:49:51 +02:00
"lightStyle"
2023-09-09 04:51:46 +02:00
] ,
"type" : "object"
} ,
2023-10-24 17:05:42 +02:00
"SystemConfigNewVersionCheckDto" : {
"properties" : {
"enabled" : {
"type" : "boolean"
}
} ,
"required" : [
"enabled"
] ,
"type" : "object"
} ,
2024-05-02 16:43:18 +02:00
"SystemConfigNotificationsDto" : {
"properties" : {
"smtp" : {
"$ref" : "#/components/schemas/SystemConfigSmtpDto"
}
} ,
"required" : [
"smtp"
] ,
"type" : "object"
} ,
2023-06-10 06:14:18 +02:00
"SystemConfigOAuthDto" : {
2022-12-05 19:56:44 +02:00
"properties" : {
2023-08-01 18:49:18 +02:00
"autoLaunch" : {
2023-06-10 06:14:18 +02:00
"type" : "boolean"
2022-12-05 19:56:44 +02:00
} ,
2023-08-01 18:49:18 +02:00
"autoRegister" : {
"type" : "boolean"
} ,
"buttonText" : {
2023-06-10 06:14:18 +02:00
"type" : "string"
} ,
"clientId" : {
"type" : "string"
} ,
"clientSecret" : {
"type" : "string"
} ,
2024-03-02 02:46:07 +02:00
"defaultStorageQuota" : {
2024-04-23 00:13:44 +02:00
"minimum" : 0 ,
2024-03-02 02:46:07 +02:00
"type" : "number"
} ,
2023-08-01 18:49:18 +02:00
"enabled" : {
2023-06-10 06:14:18 +02:00
"type" : "boolean"
} ,
2023-08-01 18:49:18 +02:00
"issuerUrl" : {
"type" : "string"
2023-06-10 06:14:18 +02:00
} ,
"mobileOverrideEnabled" : {
"type" : "boolean"
} ,
"mobileRedirectUri" : {
2022-12-05 19:56:44 +02:00
"type" : "string"
2023-08-01 18:49:18 +02:00
} ,
2024-07-11 13:55:00 +02:00
"profileSigningAlgorithm" : {
"type" : "string"
} ,
2023-08-01 18:49:18 +02:00
"scope" : {
"type" : "string"
} ,
2024-02-02 07:27:54 +02:00
"signingAlgorithm" : {
"type" : "string"
} ,
2023-08-01 18:49:18 +02:00
"storageLabelClaim" : {
"type" : "string"
2024-03-02 02:46:07 +02:00
} ,
"storageQuotaClaim" : {
"type" : "string"
2022-12-05 19:56:44 +02:00
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"autoLaunch" ,
"autoRegister" ,
"buttonText" ,
2023-06-10 06:14:18 +02:00
"clientId" ,
"clientSecret" ,
2024-03-02 02:46:07 +02:00
"defaultStorageQuota" ,
2024-01-22 18:49:51 +02:00
"enabled" ,
"issuerUrl" ,
2023-06-10 06:14:18 +02:00
"mobileOverrideEnabled" ,
2024-01-22 18:49:51 +02:00
"mobileRedirectUri" ,
2024-07-11 13:55:00 +02:00
"profileSigningAlgorithm" ,
2024-01-22 18:49:51 +02:00
"scope" ,
2024-02-02 07:27:54 +02:00
"signingAlgorithm" ,
2024-03-02 02:46:07 +02:00
"storageLabelClaim" ,
"storageQuotaClaim"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2022-12-05 19:56:44 +02:00
} ,
2023-06-10 06:14:18 +02:00
"SystemConfigPasswordLoginDto" : {
2022-12-05 19:56:44 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"enabled" : {
"type" : "boolean"
2022-12-05 19:56:44 +02:00
}
} ,
"required" : [
2023-06-10 06:14:18 +02:00
"enabled"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2022-12-05 19:56:44 +02:00
} ,
2023-09-26 09:03:57 +02:00
"SystemConfigReverseGeocodingDto" : {
"properties" : {
"enabled" : {
"type" : "boolean"
}
} ,
"required" : [
"enabled"
] ,
"type" : "object"
} ,
2024-01-04 04:54:48 +02:00
"SystemConfigServerDto" : {
"properties" : {
"externalDomain" : {
"type" : "string"
2024-01-04 07:00:17 +02:00
} ,
"loginPageMessage" : {
"type" : "string"
2024-01-04 04:54:48 +02:00
}
} ,
"required" : [
2024-01-04 07:00:17 +02:00
"externalDomain" ,
"loginPageMessage"
2024-01-04 04:54:48 +02:00
] ,
"type" : "object"
} ,
2024-05-02 16:43:18 +02:00
"SystemConfigSmtpDto" : {
"properties" : {
"enabled" : {
"type" : "boolean"
} ,
"from" : {
"type" : "string"
} ,
"replyTo" : {
"type" : "string"
} ,
"transport" : {
"$ref" : "#/components/schemas/SystemConfigSmtpTransportDto"
}
} ,
"required" : [
"enabled" ,
"from" ,
"replyTo" ,
"transport"
] ,
"type" : "object"
} ,
"SystemConfigSmtpTransportDto" : {
"properties" : {
"host" : {
"type" : "string"
} ,
"ignoreCert" : {
"type" : "boolean"
} ,
"password" : {
"type" : "string"
} ,
"port" : {
"maximum" : 65535 ,
"minimum" : 0 ,
"type" : "number"
} ,
"username" : {
"type" : "string"
}
} ,
"required" : [
"host" ,
"ignoreCert" ,
"password" ,
"port" ,
"username"
] ,
"type" : "object"
} ,
2023-06-10 06:14:18 +02:00
"SystemConfigStorageTemplateDto" : {
2023-05-24 23:08:21 +02:00
"properties" : {
2023-12-29 20:41:33 +02:00
"enabled" : {
"type" : "boolean"
} ,
"hashVerificationEnabled" : {
"type" : "boolean"
} ,
2023-06-10 06:14:18 +02:00
"template" : {
2023-05-24 23:08:21 +02:00
"type" : "string"
}
} ,
"required" : [
2023-12-29 20:41:33 +02:00
"enabled" ,
"hashVerificationEnabled" ,
2023-06-10 06:14:18 +02:00
"template"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-05-24 23:08:21 +02:00
} ,
2023-06-10 06:14:18 +02:00
"SystemConfigTemplateStorageOptionDto" : {
2023-05-24 23:08:21 +02:00
"properties" : {
2023-08-01 18:49:18 +02:00
"dayOptions" : {
2023-05-24 23:08:21 +02:00
"items" : {
2023-06-10 06:14:18 +02:00
"type" : "string"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-06-10 06:14:18 +02:00
} ,
2023-08-01 18:49:18 +02:00
"hourOptions" : {
2023-06-10 06:14:18 +02:00
"items" : {
"type" : "string"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-06-10 06:14:18 +02:00
} ,
2023-08-01 18:49:18 +02:00
"minuteOptions" : {
2023-06-10 06:14:18 +02:00
"items" : {
"type" : "string"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-06-10 06:14:18 +02:00
} ,
2023-08-01 18:49:18 +02:00
"monthOptions" : {
2023-06-10 06:14:18 +02:00
"items" : {
"type" : "string"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-06-10 06:14:18 +02:00
} ,
2023-08-01 18:49:18 +02:00
"presetOptions" : {
2023-06-10 06:14:18 +02:00
"items" : {
"type" : "string"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-06-10 06:14:18 +02:00
} ,
"secondOptions" : {
"items" : {
"type" : "string"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-06-10 06:14:18 +02:00
} ,
2023-09-28 19:47:31 +02:00
"weekOptions" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
2023-08-01 18:49:18 +02:00
"yearOptions" : {
2023-06-10 06:14:18 +02:00
"items" : {
"type" : "string"
2023-08-01 18:49:18 +02:00
} ,
"type" : "array"
2023-05-24 23:08:21 +02:00
}
} ,
"required" : [
2023-06-10 06:14:18 +02:00
"dayOptions" ,
"hourOptions" ,
"minuteOptions" ,
2024-01-22 18:49:51 +02:00
"monthOptions" ,
"presetOptions" ,
2023-06-10 06:14:18 +02:00
"secondOptions" ,
2024-01-22 18:49:51 +02:00
"weekOptions" ,
"yearOptions"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-05-24 23:08:21 +02:00
} ,
2023-10-23 20:38:41 +02:00
"SystemConfigThemeDto" : {
"properties" : {
"customCss" : {
"type" : "string"
}
} ,
"required" : [
"customCss"
] ,
"type" : "object"
} ,
2023-10-06 09:01:14 +02:00
"SystemConfigTrashDto" : {
"properties" : {
"days" : {
2024-04-23 00:13:44 +02:00
"minimum" : 0 ,
2023-10-06 09:01:14 +02:00
"type" : "integer"
} ,
"enabled" : {
"type" : "boolean"
}
} ,
"required" : [
"days" ,
"enabled"
] ,
"type" : "object"
} ,
2024-03-06 07:45:40 +02:00
"SystemConfigUserDto" : {
"properties" : {
"deleteDelay" : {
2024-04-23 00:13:44 +02:00
"minimum" : 1 ,
2024-03-06 07:45:40 +02:00
"type" : "integer"
}
} ,
"required" : [
"deleteDelay"
] ,
"type" : "object"
} ,
2023-06-10 06:14:18 +02:00
"TagResponseDto" : {
2023-05-24 23:08:21 +02:00
"properties" : {
"id" : {
"type" : "string"
} ,
2023-06-10 06:14:18 +02:00
"name" : {
"type" : "string"
2023-05-24 23:08:21 +02:00
} ,
2023-08-01 18:49:18 +02:00
"type" : {
"$ref" : "#/components/schemas/TagTypeEnum"
} ,
2023-06-10 06:14:18 +02:00
"userId" : {
2023-05-24 23:08:21 +02:00
"type" : "string"
}
} ,
"required" : [
"id" ,
2023-06-10 06:14:18 +02:00
"name" ,
2024-01-22 18:49:51 +02:00
"type" ,
2023-06-10 06:14:18 +02:00
"userId"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-05-24 23:08:21 +02:00
} ,
2023-06-10 06:14:18 +02:00
"TagTypeEnum" : {
"enum" : [
"OBJECT" ,
"FACE" ,
"CUSTOM"
2023-08-01 18:49:18 +02:00
] ,
"type" : "string"
2023-06-10 06:14:18 +02:00
} ,
2023-08-04 23:07:15 +02:00
"TimeBucketResponseDto" : {
"properties" : {
"count" : {
"type" : "integer"
} ,
"timeBucket" : {
"type" : "string"
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"count" ,
"timeBucket"
2023-08-04 23:07:15 +02:00
] ,
"type" : "object"
} ,
"TimeBucketSize" : {
2023-06-10 06:14:18 +02:00
"enum" : [
2023-08-04 23:07:15 +02:00
"DAY" ,
"MONTH"
2023-08-01 18:49:18 +02:00
] ,
"type" : "string"
2023-08-07 22:35:25 +02:00
} ,
"ToneMapping" : {
"enum" : [
"hable" ,
"mobius" ,
"reinhard" ,
"disabled"
] ,
"type" : "string"
2023-06-10 06:14:18 +02:00
} ,
2023-08-02 03:56:10 +02:00
"TranscodeHWAccel" : {
"enum" : [
"nvenc" ,
"qsv" ,
"vaapi" ,
2023-10-30 16:39:37 +02:00
"rkmpp" ,
2023-08-02 03:56:10 +02:00
"disabled"
] ,
"type" : "string"
} ,
2023-07-09 04:43:11 +02:00
"TranscodePolicy" : {
"enum" : [
"all" ,
"optimal" ,
2024-01-31 03:25:07 +02:00
"bitrate" ,
2023-07-09 04:43:11 +02:00
"required" ,
"disabled"
2023-08-01 18:49:18 +02:00
] ,
"type" : "string"
2023-07-09 04:43:11 +02:00
} ,
2023-06-10 06:14:18 +02:00
"UpdateAlbumDto" : {
2023-05-24 23:08:21 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"albumName" : {
"type" : "string"
} ,
"albumThumbnailAssetId" : {
2023-08-01 18:49:18 +02:00
"format" : "uuid" ,
"type" : "string"
2023-08-06 04:43:26 +02:00
} ,
"description" : {
"type" : "string"
2023-11-07 06:37:21 +02:00
} ,
"isActivityEnabled" : {
"type" : "boolean"
2024-03-14 18:45:03 +02:00
} ,
"order" : {
"$ref" : "#/components/schemas/AssetOrder"
2023-05-24 23:08:21 +02:00
}
2023-08-01 18:49:18 +02:00
} ,
"type" : "object"
2023-05-24 23:08:21 +02:00
} ,
2024-04-25 06:19:49 +02:00
"UpdateAlbumUserDto" : {
"properties" : {
"role" : {
"$ref" : "#/components/schemas/AlbumUserRole"
}
} ,
"required" : [
"role"
] ,
"type" : "object"
} ,
2023-06-10 06:14:18 +02:00
"UpdateAssetDto" : {
2023-01-15 07:49:47 +02:00
"properties" : {
2023-11-30 05:52:28 +02:00
"dateTimeOriginal" : {
"type" : "string"
} ,
2023-08-01 18:49:18 +02:00
"description" : {
"type" : "string"
} ,
"isArchived" : {
"type" : "boolean"
} ,
"isFavorite" : {
"type" : "boolean"
2023-11-30 05:52:28 +02:00
} ,
"latitude" : {
"type" : "number"
} ,
"longitude" : {
"type" : "number"
2024-08-09 19:45:52 +02:00
} ,
"rating" : {
"maximum" : 5 ,
"minimum" : 0 ,
"type" : "number"
2023-01-15 07:49:47 +02:00
}
2023-08-01 18:49:18 +02:00
} ,
"type" : "object"
2023-01-15 07:49:47 +02:00
} ,
2023-09-20 13:16:33 +02:00
"UpdateLibraryDto" : {
"properties" : {
"exclusionPatterns" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"importPaths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"name" : {
"type" : "string"
}
} ,
"type" : "object"
} ,
2023-11-11 23:06:19 +02:00
"UpdatePartnerDto" : {
"properties" : {
"inTimeline" : {
"type" : "boolean"
}
} ,
"required" : [
"inTimeline"
] ,
"type" : "object"
} ,
2023-10-22 04:38:07 +02:00
"UpdateStackParentDto" : {
"properties" : {
"newParentId" : {
"format" : "uuid" ,
"type" : "string"
} ,
"oldParentId" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"newParentId" ,
"oldParentId"
2023-10-22 04:38:07 +02:00
] ,
"type" : "object"
} ,
2023-06-10 06:14:18 +02:00
"UpdateTagDto" : {
2023-02-15 23:21:22 +02:00
"properties" : {
2023-06-10 06:14:18 +02:00
"name" : {
"type" : "string"
2023-02-15 23:21:22 +02:00
}
2023-08-01 18:49:18 +02:00
} ,
"type" : "object"
2023-02-15 23:21:22 +02:00
} ,
2023-06-10 06:14:18 +02:00
"UsageByUserDto" : {
2022-12-05 19:56:44 +02:00
"properties" : {
2023-08-01 18:49:18 +02:00
"photos" : {
"type" : "integer"
} ,
2024-01-13 02:43:36 +02:00
"quotaSizeInBytes" : {
"format" : "int64" ,
"nullable" : true ,
"type" : "integer"
} ,
2023-08-01 18:49:18 +02:00
"usage" : {
"format" : "int64" ,
"type" : "integer"
2022-12-05 19:56:44 +02:00
} ,
2023-08-01 18:49:18 +02:00
"userId" : {
2023-06-10 06:14:18 +02:00
"type" : "string"
} ,
2023-11-12 03:03:32 +02:00
"userName" : {
2023-08-01 18:49:18 +02:00
"type" : "string"
2022-12-05 19:56:44 +02:00
} ,
2023-06-10 06:14:18 +02:00
"videos" : {
2022-12-05 19:56:44 +02:00
"type" : "integer"
}
} ,
"required" : [
2023-06-10 06:14:18 +02:00
"photos" ,
2024-01-22 18:49:51 +02:00
"quotaSizeInBytes" ,
2024-01-13 02:43:36 +02:00
"usage" ,
2024-01-22 18:49:51 +02:00
"userId" ,
"userName" ,
"videos"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2022-12-05 19:56:44 +02:00
} ,
2024-05-27 00:15:52 +02:00
"UserAdminCreateDto" : {
2023-11-01 05:13:34 +02:00
"properties" : {
"email" : {
"type" : "string"
} ,
2023-11-12 03:03:32 +02:00
"name" : {
2023-11-01 05:13:34 +02:00
"type" : "string"
} ,
2024-05-27 00:15:52 +02:00
"notify" : {
"type" : "boolean"
} ,
"password" : {
"type" : "string"
} ,
"quotaSizeInBytes" : {
"format" : "int64" ,
"minimum" : 1 ,
"nullable" : true ,
"type" : "integer"
} ,
"shouldChangePassword" : {
"type" : "boolean"
} ,
"storageLabel" : {
"nullable" : true ,
2023-11-01 05:13:34 +02:00
"type" : "string"
}
} ,
"required" : [
2024-01-22 18:49:51 +02:00
"email" ,
2023-11-12 03:03:32 +02:00
"name" ,
2024-05-27 00:15:52 +02:00
"password"
2023-11-01 05:13:34 +02:00
] ,
"type" : "object"
} ,
2024-05-27 00:15:52 +02:00
"UserAdminDeleteDto" : {
"properties" : {
"force" : {
"type" : "boolean"
}
} ,
"type" : "object"
} ,
"UserAdminResponseDto" : {
2023-01-09 22:16:08 +02:00
"properties" : {
2023-11-14 05:10:35 +02:00
"avatarColor" : {
"$ref" : "#/components/schemas/UserAvatarColor"
} ,
2023-08-01 18:49:18 +02:00
"createdAt" : {
"format" : "date-time" ,
"type" : "string"
} ,
"deletedAt" : {
"format" : "date-time" ,
"nullable" : true ,
2023-06-10 06:14:18 +02:00
"type" : "string"
} ,
"email" : {
"type" : "string"
} ,
2023-08-01 18:49:18 +02:00
"id" : {
2023-06-10 06:14:18 +02:00
"type" : "string"
} ,
2023-08-01 18:49:18 +02:00
"isAdmin" : {
"type" : "boolean"
2023-01-09 22:16:08 +02:00
} ,
2024-07-01 19:43:16 +02:00
"license" : {
"allOf" : [
{
"$ref" : "#/components/schemas/UserLicense"
}
] ,
"nullable" : true
} ,
2023-11-12 03:03:32 +02:00
"name" : {
"type" : "string"
} ,
2023-08-01 18:49:18 +02:00
"oauthId" : {
"type" : "string"
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 04:33:20 +02:00
} ,
2023-06-10 06:14:18 +02:00
"profileImagePath" : {
2023-05-30 15:15:56 +02:00
"type" : "string"
2023-01-09 22:16:08 +02:00
} ,
2024-01-13 02:43:36 +02:00
"quotaSizeInBytes" : {
"format" : "int64" ,
"nullable" : true ,
"type" : "integer"
} ,
"quotaUsageInBytes" : {
"format" : "int64" ,
2024-01-17 04:08:31 +02:00
"nullable" : true ,
2024-01-13 02:43:36 +02:00
"type" : "integer"
} ,
2023-06-10 06:14:18 +02:00
"shouldChangePassword" : {
2023-01-09 22:16:08 +02:00
"type" : "boolean"
2023-01-22 06:15:16 +02:00
} ,
2024-03-09 00:49:39 +02:00
"status" : {
"$ref" : "#/components/schemas/UserStatus"
} ,
2023-08-01 18:49:18 +02:00
"storageLabel" : {
"nullable" : true ,
2023-06-10 06:14:18 +02:00
"type" : "string"
2023-01-09 22:16:08 +02:00
} ,
2023-06-10 06:14:18 +02:00
"updatedAt" : {
"format" : "date-time" ,
"type" : "string"
2023-01-09 22:16:08 +02:00
}
} ,
"required" : [
2023-11-14 05:10:35 +02:00
"avatarColor" ,
2023-06-10 06:14:18 +02:00
"createdAt" ,
"deletedAt" ,
2024-01-22 18:49:51 +02:00
"email" ,
2024-01-13 02:43:36 +02:00
"id" ,
2024-01-22 18:49:51 +02:00
"isAdmin" ,
2024-07-01 19:43:16 +02:00
"license" ,
2024-01-13 02:43:36 +02:00
"name" ,
2024-01-22 18:49:51 +02:00
"oauthId" ,
"profileImagePath" ,
"quotaSizeInBytes" ,
"quotaUsageInBytes" ,
"shouldChangePassword" ,
2024-03-09 00:49:39 +02:00
"status" ,
2024-01-22 18:49:51 +02:00
"storageLabel" ,
"updatedAt"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-06-10 06:14:18 +02:00
} ,
2024-05-27 00:15:52 +02:00
"UserAdminUpdateDto" : {
"properties" : {
"email" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"password" : {
"type" : "string"
} ,
"quotaSizeInBytes" : {
"format" : "int64" ,
"minimum" : 1 ,
"nullable" : true ,
"type" : "integer"
} ,
"shouldChangePassword" : {
"type" : "boolean"
} ,
"storageLabel" : {
"nullable" : true ,
"type" : "string"
}
} ,
"type" : "object"
} ,
"UserAvatarColor" : {
"enum" : [
"primary" ,
"pink" ,
"red" ,
"yellow" ,
"blue" ,
"green" ,
"purple" ,
"orange" ,
"gray" ,
"amber"
] ,
"type" : "string"
} ,
2024-07-01 19:43:16 +02:00
"UserLicense" : {
"properties" : {
"activatedAt" : {
"format" : "date-time" ,
"type" : "string"
} ,
"activationKey" : {
"type" : "string"
} ,
"licenseKey" : {
"type" : "string"
}
} ,
"required" : [
"activatedAt" ,
"activationKey" ,
"licenseKey"
] ,
"type" : "object"
} ,
2024-05-28 04:16:53 +02:00
"UserPreferencesResponseDto" : {
"properties" : {
"avatar" : {
"$ref" : "#/components/schemas/AvatarResponse"
} ,
2024-06-14 17:27:12 +02:00
"download" : {
"$ref" : "#/components/schemas/DownloadResponse"
} ,
2024-06-03 23:00:20 +02:00
"emailNotifications" : {
"$ref" : "#/components/schemas/EmailNotificationsResponse"
} ,
2024-05-28 04:16:53 +02:00
"memories" : {
"$ref" : "#/components/schemas/MemoryResponse"
2024-07-26 17:34:35 +02:00
} ,
"purchase" : {
"$ref" : "#/components/schemas/PurchaseResponse"
2024-08-09 19:45:52 +02:00
} ,
"rating" : {
"$ref" : "#/components/schemas/RatingResponse"
2024-05-28 04:16:53 +02:00
}
} ,
"required" : [
"avatar" ,
2024-06-14 17:27:12 +02:00
"download" ,
2024-06-03 23:00:20 +02:00
"emailNotifications" ,
2024-07-26 17:34:35 +02:00
"memories" ,
2024-08-09 19:45:52 +02:00
"purchase" ,
"rating"
2024-05-28 04:16:53 +02:00
] ,
"type" : "object"
} ,
"UserPreferencesUpdateDto" : {
"properties" : {
"avatar" : {
"$ref" : "#/components/schemas/AvatarUpdate"
} ,
2024-06-14 17:27:12 +02:00
"download" : {
"$ref" : "#/components/schemas/DownloadUpdate"
} ,
2024-06-03 23:00:20 +02:00
"emailNotifications" : {
"$ref" : "#/components/schemas/EmailNotificationsUpdate"
} ,
2024-05-28 04:16:53 +02:00
"memories" : {
"$ref" : "#/components/schemas/MemoryUpdate"
2024-07-26 17:34:35 +02:00
} ,
"purchase" : {
"$ref" : "#/components/schemas/PurchaseUpdate"
2024-08-09 19:45:52 +02:00
} ,
"rating" : {
"$ref" : "#/components/schemas/RatingUpdate"
2024-05-28 04:16:53 +02:00
}
} ,
"type" : "object"
} ,
2024-05-27 00:15:52 +02:00
"UserResponseDto" : {
"properties" : {
"avatarColor" : {
"$ref" : "#/components/schemas/UserAvatarColor"
} ,
"email" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"profileImagePath" : {
"type" : "string"
}
} ,
"required" : [
"avatarColor" ,
"email" ,
"id" ,
"name" ,
"profileImagePath"
] ,
"type" : "object"
} ,
2024-03-09 00:49:39 +02:00
"UserStatus" : {
"enum" : [
"active" ,
"removing" ,
"deleted"
] ,
"type" : "string"
} ,
2024-05-27 00:15:52 +02:00
"UserUpdateMeDto" : {
"properties" : {
"email" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"password" : {
"type" : "string"
}
} ,
"type" : "object"
} ,
2023-06-10 06:14:18 +02:00
"ValidateAccessTokenResponseDto" : {
"properties" : {
"authStatus" : {
"type" : "boolean"
}
} ,
"required" : [
"authStatus"
2023-08-01 18:49:18 +02:00
] ,
"type" : "object"
2023-07-09 04:43:11 +02:00
} ,
2024-02-20 17:53:12 +02:00
"ValidateLibraryDto" : {
"properties" : {
"exclusionPatterns" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"importPaths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"type" : "object"
} ,
"ValidateLibraryImportPathResponseDto" : {
"properties" : {
"importPath" : {
"type" : "string"
} ,
"isValid" : {
"default" : false ,
"type" : "boolean"
} ,
"message" : {
"type" : "string"
}
} ,
"required" : [
2024-03-18 22:59:53 +02:00
"importPath" ,
"isValid"
2024-02-20 17:53:12 +02:00
] ,
"type" : "object"
} ,
"ValidateLibraryResponseDto" : {
"properties" : {
"importPaths" : {
"items" : {
"$ref" : "#/components/schemas/ValidateLibraryImportPathResponseDto"
} ,
"type" : "array"
}
} ,
"type" : "object"
} ,
2023-07-09 04:43:11 +02:00
"VideoCodec" : {
"enum" : [
"h264" ,
"hevc" ,
2024-04-11 07:26:27 +02:00
"vp9" ,
"av1"
2023-08-01 18:49:18 +02:00
] ,
"type" : "string"
2024-07-21 23:14:23 +02:00
} ,
"VideoContainer" : {
"enum" : [
"mov" ,
"mp4" ,
"ogg" ,
"webm"
] ,
"type" : "string"
2022-12-05 19:56:44 +02:00
}
}
}
}