2022-12-05 17:56:44 +00:00
{
"openapi" : "3.0.0" ,
"paths" : {
2023-11-01 03:13:34 +00:00
"/activity" : {
"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"
}
} ,
{
"name" : "type" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"$ref" : "#/components/schemas/ReactionType"
}
2023-11-01 15:49:12 +00:00
} ,
2023-11-10 02:32:31 +00:00
{
"name" : "level" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"$ref" : "#/components/schemas/ReactionLevel"
}
} ,
2023-11-01 15:49:12 +00:00
{
"name" : "userId" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
2023-11-01 03:13:34 +00:00
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/ActivityResponseDto"
} ,
"type" : "array"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Activity"
]
} ,
"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" : [
"Activity"
]
}
} ,
"/activity/statistics" : {
"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" : [
"Activity"
]
}
} ,
"/activity/{id}" : {
"delete" : {
"operationId" : "deleteActivity" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"responses" : {
"204" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Activity"
]
}
} ,
2023-03-26 02:46:48 +00:00
"/album" : {
"get" : {
"operationId" : "getAllAlbums" ,
"parameters" : [
{
"name" : "shared" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "assetId" ,
"required" : false ,
"in" : "query" ,
"description" : "Only returns albums that contain the asset\nIgnores the shared parameter\nundefined: get all albums" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/AlbumResponseDto"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-03-26 02:46:48 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-03-26 02:46:48 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-03-26 02:46:48 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Album"
2023-03-26 02:46:48 +00:00
]
} ,
"post" : {
"operationId" : "createAlbum" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateAlbumDto"
}
}
2023-08-01 16:49:18 +00:00
} ,
"required" : true
2023-03-26 02:46:48 +00:00
} ,
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AlbumResponseDto"
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-03-26 02:46:48 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-03-26 02:46:48 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Album"
2023-03-26 02:46:48 +00:00
]
}
} ,
2023-06-16 15:48:48 +00:00
"/album/count" : {
2023-06-10 04:14:18 +00:00
"get" : {
2023-06-16 15:48:48 +00:00
"operationId" : "getAlbumCount" ,
2023-06-10 04:14:18 +00:00
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AlbumCountResponseDto"
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-06-10 04:14:18 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Album"
2023-06-10 04:14:18 +00:00
]
}
} ,
2023-05-25 19:37:19 +00:00
"/album/{id}" : {
2023-08-01 16:49:18 +00:00
"delete" : {
"operationId" : "deleteAlbum" ,
2023-05-25 19:37:19 +00:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
2023-08-01 16:49:18 +00:00
"description" : ""
2023-05-25 19:37:19 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Album"
2023-05-25 19:37:19 +00:00
]
} ,
2023-08-01 16:49:18 +00:00
"get" : {
"operationId" : "getAlbumInfo" ,
2023-05-25 19:37:19 +00:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
2023-08-01 16:49:18 +00:00
} ,
2023-08-11 16:00:51 +00:00
{
"name" : "withoutAssets" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
2023-08-01 16:49:18 +00:00
{
"name" : "key" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
2023-05-25 19:37:19 +00:00
}
] ,
"responses" : {
"200" : {
2023-08-01 16:49:18 +00:00
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AlbumResponseDto"
}
}
} ,
2023-05-26 13:04:09 +00:00
"description" : ""
2023-05-25 19:37:19 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Album"
2023-05-25 19:37:19 +00:00
]
} ,
2023-08-01 16:49:18 +00:00
"patch" : {
"operationId" : "updateAlbumInfo" ,
2023-05-25 19:37:19 +00:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
2023-08-01 16:49:18 +00:00
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateAlbumDto"
}
}
} ,
"required" : true
} ,
2023-05-25 19:37:19 +00:00
"responses" : {
"200" : {
2023-05-26 13:04:09 +00:00
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AlbumResponseDto"
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-05-25 19:37:19 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Album"
2023-05-25 19:37:19 +00:00
]
}
} ,
2023-06-10 04:14:18 +00:00
"/album/{id}/assets" : {
2023-08-01 16:49:18 +00:00
"delete" : {
"operationId" : "removeAssetFromAlbum" ,
2023-06-07 14:37:25 +00:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
2023-08-02 01:29:14 +00:00
"$ref" : "#/components/schemas/BulkIdsDto"
2023-06-07 14:37:25 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"required" : true
2023-06-07 14:37:25 +00:00
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-08-02 01:29:14 +00:00
"items" : {
"$ref" : "#/components/schemas/BulkIdResponseDto"
} ,
"type" : "array"
2023-06-07 14:37:25 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-06-07 14:37:25 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Album"
2023-06-07 14:37:25 +00:00
]
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"put" : {
"operationId" : "addAssetsToAlbum" ,
2023-06-07 14:37:25 +00:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
2023-08-01 16:49:18 +00:00
} ,
{
"name" : "key" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
2023-06-07 14:37:25 +00:00
}
] ,
2023-01-18 14:40:15 +00:00
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
2023-08-02 01:29:14 +00:00
"$ref" : "#/components/schemas/BulkIdsDto"
2023-01-18 14:40:15 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"required" : true
2023-01-18 14:40:15 +00:00
} ,
"responses" : {
2023-06-10 04:14:18 +00:00
"200" : {
2023-01-18 14:40:15 +00:00
"content" : {
"application/json" : {
"schema" : {
2023-08-02 01:29:14 +00:00
"items" : {
"$ref" : "#/components/schemas/BulkIdResponseDto"
} ,
"type" : "array"
2023-01-18 14:40:15 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-01-18 14:40:15 +00:00
}
} ,
2023-02-24 16:01:10 +00:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-02-24 16:01:10 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Album"
2023-01-18 14:40:15 +00:00
]
2023-06-10 04:14:18 +00:00
}
} ,
"/album/{id}/user/{userId}" : {
"delete" : {
"operationId" : "removeUserFromAlbum" ,
2023-01-18 14:40:15 +00:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
2023-04-04 22:24:08 +00:00
"format" : "uuid" ,
2023-02-18 20:58:55 +00:00
"type" : "string"
2023-01-18 14:40:15 +00:00
}
2023-06-10 04:14:18 +00:00
} ,
{
"name" : "userId" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"type" : "string"
}
2023-01-18 14:40:15 +00:00
}
] ,
"responses" : {
"200" : {
2023-06-10 04:14:18 +00:00
"description" : ""
2023-01-18 14:40:15 +00:00
}
} ,
2023-02-24 16:01:10 +00:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-02-24 16:01:10 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Album"
2023-01-18 14:40:15 +00:00
]
2023-06-10 04:14:18 +00:00
}
} ,
"/album/{id}/users" : {
2023-01-18 14:40:15 +00:00
"put" : {
2023-06-10 04:14:18 +00:00
"operationId" : "addUsersToAlbum" ,
2023-01-18 14:40:15 +00:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
2023-04-04 22:24:08 +00:00
"format" : "uuid" ,
2023-02-18 20:58:55 +00:00
"type" : "string"
2023-01-18 14:40:15 +00:00
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/AddUsersDto"
2023-01-18 14:40:15 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"required" : true
2023-01-18 14:40:15 +00:00
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/AlbumResponseDto"
2023-01-18 14:40:15 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-01-18 14:40:15 +00:00
}
} ,
2023-02-24 16:01:10 +00:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-02-24 16:01:10 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Album"
2023-01-18 14:40:15 +00:00
]
2023-06-10 04:14:18 +00:00
}
} ,
"/api-key" : {
2023-08-01 16:49:18 +00:00
"get" : {
2023-11-04 01:33:15 +00:00
"operationId" : "getApiKeys" ,
2023-06-10 04:14:18 +00:00
"parameters" : [ ] ,
2023-01-18 14:40:15 +00:00
"responses" : {
2023-08-01 16:49:18 +00:00
"200" : {
2023-06-10 04:14:18 +00:00
"content" : {
"application/json" : {
"schema" : {
2023-08-01 16:49:18 +00:00
"items" : {
"$ref" : "#/components/schemas/APIKeyResponseDto"
} ,
"type" : "array"
2023-06-10 04:14:18 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-01-18 14:40:15 +00:00
}
} ,
2023-02-24 16:01:10 +00:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-02-24 16:01:10 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"API Key"
2023-01-18 14:40:15 +00:00
]
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"post" : {
2023-11-04 01:33:15 +00:00
"operationId" : "createApiKey" ,
2023-06-10 04:14:18 +00:00
"parameters" : [ ] ,
2023-08-01 16:49:18 +00:00
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/APIKeyCreateDto"
}
}
} ,
"required" : true
} ,
2023-05-21 06:26:06 +00:00
"responses" : {
2023-08-01 16:49:18 +00:00
"201" : {
2023-05-21 06:26:06 +00:00
"content" : {
"application/json" : {
"schema" : {
2023-08-01 16:49:18 +00:00
"$ref" : "#/components/schemas/APIKeyCreateResponseDto"
2023-05-21 06:26:06 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-05-21 06:26:06 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"API Key"
2023-05-21 06:26:06 +00:00
]
}
} ,
2023-06-10 04:14:18 +00:00
"/api-key/{id}" : {
2023-08-01 16:49:18 +00:00
"delete" : {
2023-11-04 01:33:15 +00:00
"operationId" : "deleteApiKey" ,
2023-06-10 04:14:18 +00:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
2023-01-24 04:13:42 +00:00
}
}
2023-06-10 04:14:18 +00:00
] ,
2023-01-21 16:11:55 +00:00
"responses" : {
2023-06-10 04:14:18 +00:00
"200" : {
2023-08-01 16:49:18 +00:00
"description" : ""
2023-01-21 16:11:55 +00:00
}
} ,
2023-06-10 04:14:18 +00:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"API Key"
2023-01-21 16:11:55 +00:00
]
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"get" : {
2023-11-04 01:33:15 +00:00
"operationId" : "getApiKey" ,
2023-06-10 04:14:18 +00:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
2023-04-26 02:19:23 +00:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/APIKeyResponseDto"
2023-04-26 02:19:23 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-04-26 02:19:23 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-04-26 02:19:23 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"API Key"
2023-04-26 02:19:23 +00:00
]
2023-05-09 19:34:17 +00:00
} ,
2023-08-01 16:49:18 +00:00
"put" : {
2023-11-04 01:33:15 +00:00
"operationId" : "updateApiKey" ,
2023-06-10 04:14:18 +00:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
2023-08-01 16:49:18 +00:00
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/APIKeyUpdateDto"
}
}
} ,
"required" : true
} ,
2023-05-09 19:34:17 +00:00
"responses" : {
"200" : {
2023-08-01 16:49:18 +00:00
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/APIKeyResponseDto"
}
}
} ,
2023-05-09 19:34:17 +00:00
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"API Key"
2023-05-09 19:34:17 +00:00
]
2023-04-26 02:19:23 +00:00
}
} ,
2023-06-10 04:14:18 +00:00
"/asset" : {
2023-08-01 16:49:18 +00:00
"delete" : {
2023-10-06 07:01:14 +00:00
"operationId" : "deleteAssets" ,
2023-08-01 16:49:18 +00:00
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
2023-10-06 07:01:14 +00:00
"$ref" : "#/components/schemas/AssetBulkDeleteDto"
2023-08-01 16:49:18 +00:00
}
}
} ,
"required" : true
} ,
"responses" : {
2023-10-06 07:01:14 +00:00
"204" : {
2023-08-01 16:49:18 +00:00
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Asset"
]
} ,
2023-06-10 04:14:18 +00:00
"get" : {
"description" : "Get all AssetEntity belong to the user" ,
2023-08-01 16:49:18 +00:00
"operationId" : "getAllAssets" ,
2023-04-26 02:19:23 +00:00
"parameters" : [
2023-11-06 17:40:43 +00:00
{
"name" : "skip" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "integer"
}
} ,
{
"name" : "take" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "integer"
}
} ,
2023-04-26 02:19:23 +00:00
{
2023-06-10 04:14:18 +00:00
"name" : "userId" ,
"required" : false ,
"in" : "query" ,
2023-04-26 02:19:23 +00:00
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
2023-06-10 04:14:18 +00:00
} ,
{
"name" : "isFavorite" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "isArchived" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
2023-11-06 17:40:43 +00:00
"name" : "updatedAfter" ,
2023-06-10 04:14:18 +00:00
"required" : false ,
"in" : "query" ,
"schema" : {
2023-11-06 17:40:43 +00:00
"format" : "date-time" ,
"type" : "string"
2023-06-10 04:14:18 +00:00
}
} ,
2023-08-24 19:28:50 +00:00
{
2023-11-06 17:40:43 +00:00
"name" : "updatedBefore" ,
2023-08-24 19:28:50 +00:00
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
2023-06-10 04:14:18 +00:00
{
"name" : "if-none-match" ,
"in" : "header" ,
"description" : "ETag of data already cached on the client" ,
"required" : false ,
"schema" : {
"type" : "string"
}
2023-04-26 02:19:23 +00:00
}
] ,
"responses" : {
"200" : {
2023-06-10 04:14:18 +00:00
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/AssetResponseDto"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-06-10 04:14:18 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-04-26 02:19:23 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-04-26 02:19:23 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
2023-01-21 16:11:55 +00:00
"tags" : [
2023-06-10 04:14:18 +00:00
"Asset"
2023-01-21 16:11:55 +00:00
]
2023-08-16 20:04:55 +00: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" : [
"Asset"
]
2023-01-21 16:11:55 +00:00
}
} ,
2023-06-10 04:14:18 +00:00
"/asset/assetById/{id}" : {
"get" : {
"description" : "Get a single asset's information" ,
2023-08-01 16:49:18 +00:00
"operationId" : "getAssetById" ,
2023-06-10 04:14:18 +00:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
{
"name" : "key" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
2023-01-24 04:13:42 +00:00
}
}
2023-06-10 04:14:18 +00:00
] ,
2023-01-21 16:11:55 +00:00
"responses" : {
2023-06-10 04:14:18 +00:00
"200" : {
2023-01-21 16:11:55 +00:00
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/AssetResponseDto"
2023-01-21 16:11:55 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-01-21 16:11:55 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 16:01:10 +00:00
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-01-21 16:11:55 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Asset"
2023-01-21 16:11:55 +00:00
]
}
} ,
2023-06-10 04:14:18 +00:00
"/asset/bulk-upload-check" : {
2023-01-24 04:13:42 +00:00
"post" : {
2023-06-10 04:14:18 +00:00
"description" : "Checks if assets exist by checksums" ,
2023-11-04 01:33:15 +00:00
"operationId" : "checkBulkUpload" ,
2023-01-24 04:13:42 +00:00
"parameters" : [ ] ,
2023-06-10 04:14:18 +00:00
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AssetBulkUploadCheckDto"
2023-01-24 04:13:42 +00:00
}
2022-12-05 17:56:44 +00:00
}
2023-08-01 16:49:18 +00:00
} ,
"required" : true
2023-01-24 04:13:42 +00:00
} ,
2023-03-20 15:55:28 +00:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/AssetBulkUploadCheckResponseDto"
2023-03-20 15:55:28 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-03-20 15:55:28 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-03-20 15:55:28 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Asset"
2023-03-20 15:55:28 +00:00
]
}
} ,
2023-06-10 04:14:18 +00:00
"/asset/curated-locations" : {
"get" : {
"operationId" : "getCuratedLocations" ,
2022-12-05 17:56:44 +00:00
"parameters" : [ ] ,
"responses" : {
2023-06-10 04:14:18 +00:00
"200" : {
2022-12-05 17:56:44 +00:00
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"items" : {
"$ref" : "#/components/schemas/CuratedLocationsResponseDto"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2022-12-05 17:56:44 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2022-12-05 17:56:44 +00:00
}
} ,
2023-02-24 16:01:10 +00:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-02-24 16:01:10 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Asset"
2022-12-05 17:56:44 +00:00
]
}
} ,
2023-06-10 04:14:18 +00:00
"/asset/curated-objects" : {
"get" : {
"operationId" : "getCuratedObjects" ,
2023-01-24 04:13:42 +00:00
"parameters" : [ ] ,
2022-12-05 17:56:44 +00:00
"responses" : {
2023-06-10 04:14:18 +00:00
"200" : {
2022-12-05 17:56:44 +00:00
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"items" : {
"$ref" : "#/components/schemas/CuratedObjectsResponseDto"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2022-12-05 17:56:44 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2022-12-05 17:56:44 +00:00
}
} ,
2023-02-24 16:01:10 +00:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-02-24 16:01:10 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Asset"
2022-12-05 17:56:44 +00:00
]
}
} ,
2023-08-15 15:49:32 +00:00
"/asset/download/archive" : {
"post" : {
"operationId" : "downloadArchive" ,
2023-05-15 17:30:53 +00:00
"parameters" : [
{
2023-06-10 04:14:18 +00:00
"name" : "key" ,
"required" : false ,
2023-05-15 17:30:53 +00:00
"in" : "query" ,
"schema" : {
"type" : "string"
}
}
] ,
2023-08-15 15:49:32 +00:00
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AssetIdsDto"
}
}
} ,
"required" : true
} ,
2023-05-15 17:30:53 +00:00
"responses" : {
"200" : {
"content" : {
2023-08-15 15:49:32 +00:00
"application/octet-stream" : {
2023-05-15 17:30:53 +00:00
"schema" : {
2023-08-15 15:49:32 +00:00
"format" : "binary" ,
"type" : "string"
2023-05-15 17:30:53 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-05-15 17:30:53 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Asset"
2023-05-15 17:30:53 +00:00
]
2023-08-15 15:49:32 +00:00
}
} ,
"/asset/download/info" : {
2023-06-30 16:24:28 +00:00
"post" : {
2023-08-15 15:49:32 +00:00
"operationId" : "getDownloadInfo" ,
2023-06-10 04:14:18 +00:00
"parameters" : [
{
"name" : "key" ,
"required" : false ,
"in" : "query" ,
2023-05-15 17:30:53 +00:00
"schema" : {
"type" : "string"
}
}
] ,
2023-06-30 16:24:28 +00:00
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
2023-08-15 15:49:32 +00:00
"$ref" : "#/components/schemas/DownloadInfoDto"
2023-06-30 16:24:28 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"required" : true
2023-06-30 16:24:28 +00:00
} ,
2023-05-15 17:30:53 +00:00
"responses" : {
2023-08-15 15:49:32 +00:00
"201" : {
2023-05-15 17:30:53 +00:00
"content" : {
2023-08-15 15:49:32 +00:00
"application/json" : {
2023-05-15 17:30:53 +00:00
"schema" : {
2023-08-15 15:49:32 +00:00
"$ref" : "#/components/schemas/DownloadResponseDto"
2023-05-15 17:30:53 +00:00
}
}
2023-06-10 04:14:18 +00:00
} ,
"description" : ""
2023-05-15 17:30:53 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Asset"
2023-05-15 17:30:53 +00:00
]
2023-06-10 04:14:18 +00:00
}
} ,
"/asset/download/{id}" : {
2023-06-30 16:24:28 +00:00
"post" : {
2023-06-10 04:14:18 +00:00
"operationId" : "downloadFile" ,
2023-05-15 17:30:53 +00:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
2023-06-10 04:14:18 +00:00
} ,
{
"name" : "key" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
2023-05-15 17:30:53 +00:00
}
] ,
"responses" : {
"200" : {
2023-06-10 04:14:18 +00:00
"content" : {
"application/octet-stream" : {
"schema" : {
2023-08-01 16:49:18 +00:00
"format" : "binary" ,
"type" : "string"
2023-06-10 04:14:18 +00:00
}
}
} ,
2023-05-15 17:30:53 +00:00
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Asset"
2023-05-15 17:30:53 +00:00
]
}
} ,
2023-06-10 04:14:18 +00:00
"/asset/exist" : {
"post" : {
"description" : "Checks if multiple assets exist on the server and returns all existing - used by background backup" ,
2023-08-01 16:49:18 +00:00
"operationId" : "checkExistingAssets" ,
2023-06-10 04:14:18 +00:00
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CheckExistingAssetsDto"
}
2023-03-20 20:16:32 +00:00
}
2023-08-01 16:49:18 +00:00
} ,
"required" : true
2023-06-10 04:14:18 +00:00
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CheckExistingAssetsResponseDto"
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-06-10 04:14:18 +00:00
}
} ,
"security" : [
2023-03-20 20:16:32 +00:00
{
2023-06-10 04:14:18 +00:00
"bearer" : [ ]
2023-03-20 20:16:32 +00:00
} ,
{
2023-06-10 04:14:18 +00:00
"cookie" : [ ]
2023-03-20 20:16:32 +00:00
} ,
{
2023-06-10 04:14:18 +00:00
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Asset"
2023-06-10 04:14:18 +00:00
]
}
} ,
"/asset/file/{id}" : {
"get" : {
"operationId" : "serveFile" ,
"parameters" : [
2023-04-12 15:37:52 +00:00
{
2023-06-10 04:14:18 +00:00
"name" : "isThumb" ,
2023-04-12 15:37:52 +00:00
"required" : false ,
"in" : "query" ,
"schema" : {
2023-06-10 04:14:18 +00:00
"title" : "Is serve thumbnail (resize) file" ,
2023-04-12 15:37:52 +00:00
"type" : "boolean"
}
} ,
2023-03-20 20:16:32 +00:00
{
2023-06-10 04:14:18 +00:00
"name" : "isWeb" ,
2023-03-20 20:16:32 +00:00
"required" : false ,
"in" : "query" ,
"schema" : {
2023-06-10 04:14:18 +00:00
"title" : "Is request made from web" ,
"type" : "boolean"
2023-03-20 20:16:32 +00:00
}
} ,
{
2023-06-10 04:14:18 +00:00
"name" : "id" ,
"required" : true ,
"in" : "path" ,
2023-03-20 20:16:32 +00:00
"schema" : {
2023-06-10 04:14:18 +00:00
"format" : "uuid" ,
2023-03-20 20:16:32 +00:00
"type" : "string"
}
} ,
{
2023-06-10 04:14:18 +00:00
"name" : "key" ,
2023-03-20 20:16:32 +00:00
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
2023-06-10 04:14:18 +00:00
}
] ,
"responses" : {
"200" : {
2023-07-06 22:25:56 +00:00
"content" : {
"application/octet-stream" : {
"schema" : {
2023-08-01 16:49:18 +00:00
"format" : "binary" ,
"type" : "string"
2023-07-06 22:25:56 +00:00
}
}
} ,
2023-06-10 04:14:18 +00:00
"description" : ""
}
} ,
"security" : [
2023-03-20 20:16:32 +00:00
{
2023-06-10 04:14:18 +00:00
"bearer" : [ ]
2023-03-20 20:16:32 +00:00
} ,
{
2023-06-10 04:14:18 +00:00
"cookie" : [ ]
2023-03-20 20:16:32 +00:00
} ,
{
2023-06-10 04:14:18 +00:00
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Asset"
2023-06-10 04:14:18 +00:00
]
}
} ,
feat(server): support for read-only assets and importing existing items in the filesystem (#2715)
* Added read-only flag for assets, endpoint to trigger file import vs upload
* updated fixtures with new property
* if upload is 'read-only', ensure there is no existing asset at the designated originalPath
* added test for file import as well as detecting existing image at read-only destination location
* Added storage service test for a case where it should not move read-only assets
* upload doesn't need the read-only flag available, just importing
* default isReadOnly on import endpoint to true
* formatting fixes
* create-asset dto needs isReadOnly, so set it to false by default on create, updated api generation
* updated code to reflect changes in MR
* fixed read stream promise return type
* new index for originalPath, check for existing path on import, reglardless of user, to prevent duplicates
* refactor: import asset
* chore: open api
* chore: tests
* Added externalPath support for individual users, updated UI to allow this to be set by admin
* added missing var for externalPath in ui
* chore: open api
* fix: compilation issues
* fix: server test
* built api, fixed user-response dto to include externalPath
* reverted accidental commit
* bad commit of duplicate externalPath in user response dto
* fixed tests to include externalPath on expected result
* fix: unit tests
* centralized supported filetypes, perform file type checking of asset and sidecar during file import process
* centralized supported filetype check method to keep regex DRY
* fixed typo
* combined migrations into one
* update api
* Removed externalPath from shared-link code, added column to admin user page whether external paths / import is enabled or not
* update mimetype
* Fixed detect correct mimetype
* revert asset-upload config
* reverted domain.constant
* refactor
* fix mime-type issue
* fix format
---------
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2023-06-22 02:33:20 +00:00
"/asset/import" : {
"post" : {
"operationId" : "importFile" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ImportAssetDto"
}
}
2023-08-01 16:49:18 +00:00
} ,
"required" : true
feat(server): support for read-only assets and importing existing items in the filesystem (#2715)
* Added read-only flag for assets, endpoint to trigger file import vs upload
* updated fixtures with new property
* if upload is 'read-only', ensure there is no existing asset at the designated originalPath
* added test for file import as well as detecting existing image at read-only destination location
* Added storage service test for a case where it should not move read-only assets
* upload doesn't need the read-only flag available, just importing
* default isReadOnly on import endpoint to true
* formatting fixes
* create-asset dto needs isReadOnly, so set it to false by default on create, updated api generation
* updated code to reflect changes in MR
* fixed read stream promise return type
* new index for originalPath, check for existing path on import, reglardless of user, to prevent duplicates
* refactor: import asset
* chore: open api
* chore: tests
* Added externalPath support for individual users, updated UI to allow this to be set by admin
* added missing var for externalPath in ui
* chore: open api
* fix: compilation issues
* fix: server test
* built api, fixed user-response dto to include externalPath
* reverted accidental commit
* bad commit of duplicate externalPath in user response dto
* fixed tests to include externalPath on expected result
* fix: unit tests
* centralized supported filetypes, perform file type checking of asset and sidecar during file import process
* centralized supported filetype check method to keep regex DRY
* fixed typo
* combined migrations into one
* update api
* Removed externalPath from shared-link code, added column to admin user page whether external paths / import is enabled or not
* update mimetype
* Fixed detect correct mimetype
* revert asset-upload config
* reverted domain.constant
* refactor
* fix mime-type issue
* fix format
---------
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2023-06-22 02:33:20 +00:00
} ,
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AssetFileUploadResponseDto"
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
feat(server): support for read-only assets and importing existing items in the filesystem (#2715)
* Added read-only flag for assets, endpoint to trigger file import vs upload
* updated fixtures with new property
* if upload is 'read-only', ensure there is no existing asset at the designated originalPath
* added test for file import as well as detecting existing image at read-only destination location
* Added storage service test for a case where it should not move read-only assets
* upload doesn't need the read-only flag available, just importing
* default isReadOnly on import endpoint to true
* formatting fixes
* create-asset dto needs isReadOnly, so set it to false by default on create, updated api generation
* updated code to reflect changes in MR
* fixed read stream promise return type
* new index for originalPath, check for existing path on import, reglardless of user, to prevent duplicates
* refactor: import asset
* chore: open api
* chore: tests
* Added externalPath support for individual users, updated UI to allow this to be set by admin
* added missing var for externalPath in ui
* chore: open api
* fix: compilation issues
* fix: server test
* built api, fixed user-response dto to include externalPath
* reverted accidental commit
* bad commit of duplicate externalPath in user response dto
* fixed tests to include externalPath on expected result
* fix: unit tests
* centralized supported filetypes, perform file type checking of asset and sidecar during file import process
* centralized supported filetype check method to keep regex DRY
* fixed typo
* combined migrations into one
* update api
* Removed externalPath from shared-link code, added column to admin user page whether external paths / import is enabled or not
* update mimetype
* Fixed detect correct mimetype
* revert asset-upload config
* reverted domain.constant
* refactor
* fix mime-type issue
* fix format
---------
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2023-06-22 02:33:20 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Asset"
feat(server): support for read-only assets and importing existing items in the filesystem (#2715)
* Added read-only flag for assets, endpoint to trigger file import vs upload
* updated fixtures with new property
* if upload is 'read-only', ensure there is no existing asset at the designated originalPath
* added test for file import as well as detecting existing image at read-only destination location
* Added storage service test for a case where it should not move read-only assets
* upload doesn't need the read-only flag available, just importing
* default isReadOnly on import endpoint to true
* formatting fixes
* create-asset dto needs isReadOnly, so set it to false by default on create, updated api generation
* updated code to reflect changes in MR
* fixed read stream promise return type
* new index for originalPath, check for existing path on import, reglardless of user, to prevent duplicates
* refactor: import asset
* chore: open api
* chore: tests
* Added externalPath support for individual users, updated UI to allow this to be set by admin
* added missing var for externalPath in ui
* chore: open api
* fix: compilation issues
* fix: server test
* built api, fixed user-response dto to include externalPath
* reverted accidental commit
* bad commit of duplicate externalPath in user response dto
* fixed tests to include externalPath on expected result
* fix: unit tests
* centralized supported filetypes, perform file type checking of asset and sidecar during file import process
* centralized supported filetype check method to keep regex DRY
* fixed typo
* combined migrations into one
* update api
* Removed externalPath from shared-link code, added column to admin user page whether external paths / import is enabled or not
* update mimetype
* Fixed detect correct mimetype
* revert asset-upload config
* reverted domain.constant
* refactor
* fix mime-type issue
* fix format
---------
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2023-06-22 02:33:20 +00:00
]
}
} ,
2023-08-18 14:31:48 +00:00
"/asset/jobs" : {
"post" : {
"operationId" : "runAssetJobs" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AssetJobsDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"204" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Asset"
]
}
} ,
2023-06-10 04:14:18 +00:00
"/asset/map-marker" : {
"get" : {
"operationId" : "getMapMarkers" ,
"parameters" : [
2023-10-04 13:51:07 +00:00
{
"name" : "isArchived" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
2023-03-20 20:16:32 +00:00
{
2023-06-10 04:14:18 +00:00
"name" : "isFavorite" ,
2023-03-20 20:16:32 +00:00
"required" : false ,
"in" : "query" ,
"schema" : {
2023-06-10 04:14:18 +00:00
"type" : "boolean"
2023-03-20 20:16:32 +00:00
}
} ,
{
2023-06-10 04:14:18 +00:00
"name" : "fileCreatedAfter" ,
2023-03-20 20:16:32 +00:00
"required" : false ,
"in" : "query" ,
"schema" : {
2023-06-10 04:14:18 +00:00
"format" : "date-time" ,
"type" : "string"
2023-03-20 20:16:32 +00:00
}
} ,
{
2023-06-10 04:14:18 +00:00
"name" : "fileCreatedBefore" ,
2023-03-20 20:16:32 +00:00
"required" : false ,
"in" : "query" ,
"schema" : {
2023-06-10 04:14:18 +00:00
"format" : "date-time" ,
"type" : "string"
2023-03-20 20:16:32 +00:00
}
}
] ,
2023-03-03 02:47:08 +00:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"items" : {
"$ref" : "#/components/schemas/MapMarkerResponseDto"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-03-03 02:47:08 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-03-03 02:47:08 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-03-03 02:47:08 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Asset"
2023-03-03 02:47:08 +00:00
]
}
} ,
2023-06-15 01:47:18 +00:00
"/asset/memory-lane" : {
"get" : {
"operationId" : "getMemoryLane" ,
"parameters" : [
{
2023-10-04 22:11:11 +00:00
"name" : "day" ,
2023-06-15 01:47:18 +00:00
"required" : true ,
"in" : "query" ,
"schema" : {
2023-10-04 22:11:11 +00:00
"type" : "integer"
}
} ,
{
"name" : "month" ,
"required" : true ,
"in" : "query" ,
"schema" : {
"type" : "integer"
2023-06-15 01:47:18 +00:00
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/MemoryLaneResponseDto"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-06-15 01:47:18 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-06-15 01:47:18 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Asset"
2023-06-15 01:47:18 +00:00
]
}
} ,
2023-09-23 15:28:55 +00:00
"/asset/random" : {
"get" : {
"operationId" : "getRandom" ,
"parameters" : [
{
"name" : "count" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "number"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/AssetResponseDto"
} ,
"type" : "array"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Asset"
]
}
} ,
2023-10-06 07:01:14 +00:00
"/asset/restore" : {
"post" : {
"operationId" : "restoreAssets" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BulkIdsDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"204" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Asset"
]
}
} ,
2023-06-10 04:14:18 +00:00
"/asset/search" : {
"post" : {
"operationId" : "searchAsset" ,
2023-03-03 02:47:08 +00:00
"parameters" : [ ] ,
2023-06-10 04:14:18 +00:00
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SearchAssetDto"
}
}
2023-08-01 16:49:18 +00:00
} ,
"required" : true
2023-06-10 04:14:18 +00:00
} ,
"responses" : {
2023-06-20 13:49:36 +00:00
"200" : {
2023-06-10 04:14:18 +00:00
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/AssetResponseDto"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-03-03 02:47:08 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-03-03 02:47:08 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-03-05 20:44:31 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Asset"
2023-03-05 20:44:31 +00:00
]
}
} ,
2023-06-10 04:14:18 +00:00
"/asset/search-terms" : {
2023-03-05 20:44:31 +00:00
"get" : {
2023-06-10 04:14:18 +00:00
"operationId" : "getAssetSearchTerms" ,
2023-03-05 20:44:31 +00:00
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
2023-06-10 04:14:18 +00:00
"type" : "string"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-03-05 20:44:31 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-03-05 20:44:31 +00:00
}
} ,
"security" : [
2023-03-03 02:47:08 +00:00
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-03-03 02:47:08 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Asset"
2023-03-03 02:47:08 +00:00
]
}
} ,
2023-10-22 02:38:07 +00:00
"/asset/stack/parent" : {
"put" : {
"operationId" : "updateStackParent" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateStackParentDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"200" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Asset"
]
}
} ,
2023-07-14 13:30:17 +00:00
"/asset/statistics" : {
2023-01-25 16:35:28 +00:00
"get" : {
2023-11-04 01:33:15 +00:00
"operationId" : "getAssetStatistics" ,
2023-07-14 13:30:17 +00:00
"parameters" : [
{
"name" : "isArchived" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "isFavorite" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
2023-10-06 07:01:14 +00:00
} ,
{
"name" : "isTrashed" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
2023-07-14 13:30:17 +00:00
}
] ,
2023-01-25 16:35:28 +00:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-07-14 13:30:17 +00:00
"$ref" : "#/components/schemas/AssetStatsResponseDto"
2023-01-25 16:35:28 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-01-25 16:35:28 +00:00
}
} ,
2023-02-24 16:01:10 +00:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-02-24 16:01:10 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Asset"
2023-01-25 16:35:28 +00:00
]
}
} ,
2023-06-10 04:14:18 +00:00
"/asset/thumbnail/{id}" : {
2023-01-25 16:35:28 +00:00
"get" : {
2023-06-10 04:14:18 +00:00
"operationId" : "getAssetThumbnail" ,
2023-02-24 16:01:10 +00:00
"parameters" : [
2023-06-10 04:14:18 +00:00
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
{
"name" : "format" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"$ref" : "#/components/schemas/ThumbnailFormat"
}
} ,
2023-02-24 16:01:10 +00:00
{
"name" : "key" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
}
] ,
2023-01-25 16:35:28 +00:00
"responses" : {
"200" : {
2023-07-06 22:25:56 +00:00
"content" : {
2023-07-08 20:07:56 +00:00
"image/jpeg" : {
"schema" : {
2023-08-01 16:49:18 +00:00
"format" : "binary" ,
"type" : "string"
2023-07-08 20:07:56 +00:00
}
} ,
"image/webp" : {
2023-07-06 22:25:56 +00:00
"schema" : {
2023-08-01 16:49:18 +00:00
"format" : "binary" ,
"type" : "string"
2023-07-06 22:25:56 +00:00
}
}
} ,
2023-06-10 04:14:18 +00:00
"description" : ""
2023-01-25 16:35:28 +00:00
}
} ,
2023-02-24 16:01:10 +00:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-02-24 16:01:10 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Asset"
2023-01-25 16:35:28 +00:00
]
}
} ,
2023-06-10 04:14:18 +00:00
"/asset/time-bucket" : {
2023-08-04 21:07:15 +00:00
"get" : {
2023-11-04 01:33:15 +00:00
"operationId" : "getTimeBucket" ,
2023-08-04 21:07:15 +00:00
"parameters" : [
{
"name" : "size" ,
"required" : true ,
"in" : "query" ,
"schema" : {
"$ref" : "#/components/schemas/TimeBucketSize"
2023-01-25 16:35:28 +00:00
}
2023-08-01 16:49:18 +00:00
} ,
2023-08-04 21:07:15 +00:00
{
"name" : "userId" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
{
"name" : "albumId" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
2023-08-05 13:58:52 +00:00
{
"name" : "personId" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
2023-08-04 21:07:15 +00:00
{
"name" : "isArchived" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "isFavorite" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
2023-10-06 07:01:14 +00:00
{
"name" : "isTrashed" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
2023-10-27 20:34:01 +00:00
{
"name" : "withStacked" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
2023-11-11 21:06:19 +00:00
{
"name" : "withPartners" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
2023-08-04 21:07:15 +00:00
{
"name" : "timeBucket" ,
"required" : true ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "key" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
}
] ,
2023-01-25 16:35:28 +00:00
"responses" : {
2023-06-20 13:49:36 +00:00
"200" : {
2023-01-25 16:35:28 +00:00
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"items" : {
"$ref" : "#/components/schemas/AssetResponseDto"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-01-25 16:35:28 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-01-25 16:35:28 +00:00
}
} ,
2023-02-24 16:01:10 +00:00
"security" : [
2023-08-04 21:07:15 +00:00
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
} ,
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Asset"
]
}
} ,
"/asset/time-buckets" : {
"get" : {
"operationId" : "getTimeBuckets" ,
"parameters" : [
{
"name" : "size" ,
"required" : true ,
"in" : "query" ,
"schema" : {
"$ref" : "#/components/schemas/TimeBucketSize"
}
} ,
{
"name" : "userId" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
{
"name" : "albumId" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
2023-08-05 13:58:52 +00:00
{
"name" : "personId" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
2023-08-04 21:07:15 +00:00
{
"name" : "isArchived" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "isFavorite" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
2023-10-06 07:01:14 +00:00
{
"name" : "isTrashed" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
2023-10-27 20:34:01 +00:00
{
"name" : "withStacked" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
2023-11-11 21:06:19 +00:00
{
"name" : "withPartners" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
2023-08-04 21:07:15 +00:00
{
"name" : "key" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/TimeBucketResponseDto"
} ,
"type" : "array"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
} ,
2023-02-24 16:01:10 +00:00
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-02-24 16:01:10 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Asset"
2023-01-25 16:35:28 +00:00
]
2023-06-10 04:14:18 +00:00
}
} ,
2023-10-06 07:01:14 +00:00
"/asset/trash/empty" : {
"post" : {
"operationId" : "emptyTrash" ,
"parameters" : [ ] ,
"responses" : {
"204" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Asset"
]
}
} ,
"/asset/trash/restore" : {
"post" : {
"operationId" : "restoreTrash" ,
"parameters" : [ ] ,
"responses" : {
"204" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Asset"
]
}
} ,
2023-06-10 04:14:18 +00:00
"/asset/upload" : {
"post" : {
"operationId" : "uploadFile" ,
2023-01-25 16:35:28 +00:00
"parameters" : [
{
2023-06-10 04:14:18 +00:00
"name" : "key" ,
"required" : false ,
"in" : "query" ,
2023-01-25 16:35:28 +00:00
"schema" : {
"type" : "string"
}
}
] ,
2023-06-02 02:09:57 +00:00
"requestBody" : {
"content" : {
2023-06-10 04:14:18 +00:00
"multipart/form-data" : {
2023-06-02 02:09:57 +00:00
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/CreateAssetDto"
2023-06-02 02:09:57 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : "Asset Upload Information" ,
"required" : true
2023-06-02 02:09:57 +00:00
} ,
2023-01-25 16:35:28 +00:00
"responses" : {
2023-06-10 04:14:18 +00:00
"201" : {
2023-06-02 02:09:57 +00:00
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/AssetFileUploadResponseDto"
2023-06-02 02:09:57 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-01-25 16:35:28 +00:00
}
} ,
2023-02-24 16:01:10 +00:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-02-24 16:01:10 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Asset"
2023-01-25 16:35:28 +00:00
]
2023-06-10 04:14:18 +00:00
}
} ,
"/asset/{deviceId}" : {
"get" : {
"description" : "Get all asset of a device that are in the database, ID only." ,
2023-08-01 16:49:18 +00:00
"operationId" : "getUserAssetsByDeviceId" ,
2023-01-25 16:35:28 +00:00
"parameters" : [
{
2023-06-10 04:14:18 +00:00
"name" : "deviceId" ,
2023-01-25 16:35:28 +00:00
"required" : true ,
"in" : "path" ,
"schema" : {
2023-04-04 22:24:08 +00:00
"format" : "uuid" ,
2023-01-25 16:35:28 +00:00
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
2023-06-10 04:14:18 +00:00
"content" : {
"application/json" : {
"schema" : {
"items" : {
"type" : "string"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-06-10 04:14:18 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-06-10 04:14:18 +00:00
}
} ,
2023-02-24 16:01:10 +00:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-02-24 16:01:10 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Asset"
2023-01-25 16:35:28 +00:00
]
}
} ,
2023-06-10 04:14:18 +00:00
"/asset/{id}" : {
"put" : {
2023-08-01 16:49:18 +00:00
"operationId" : "updateAsset" ,
2023-06-10 04:14:18 +00:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateAssetDto"
}
}
2023-08-01 16:49:18 +00:00
} ,
"required" : true
2023-06-10 04:14:18 +00:00
} ,
2022-12-05 17:56:44 +00:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/AssetResponseDto"
2022-12-05 17:56:44 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2022-12-05 17:56:44 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 16:01:10 +00:00
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2022-12-05 17:56:44 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Asset"
2022-12-05 17:56:44 +00:00
]
2023-06-10 04:14:18 +00:00
}
} ,
2023-11-14 22:47:15 +00:00
"/assets" : {
"get" : {
"operationId" : "searchAssets" ,
"parameters" : [
{
"name" : "id" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
{
"name" : "libraryId" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
{
"name" : "type" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"$ref" : "#/components/schemas/AssetTypeEnum"
}
} ,
{
"name" : "order" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"$ref" : "#/components/schemas/AssetOrder"
}
} ,
{
"name" : "deviceAssetId" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "deviceId" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "checksum" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "isArchived" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "isEncoded" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "isExternal" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "isFavorite" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "isMotion" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "isOffline" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "isReadOnly" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "isVisible" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "withDeleted" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "withStacked" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "withExif" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "withPeople" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "createdBefore" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
{
"name" : "createdAfter" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
{
"name" : "updatedBefore" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
{
"name" : "updatedAfter" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
{
"name" : "trashedBefore" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
{
"name" : "trashedAfter" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
{
"name" : "takenBefore" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
{
"name" : "takenAfter" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
{
"name" : "originalFileName" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "originalPath" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "resizePath" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "webpPath" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "encodedVideoPath" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "city" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "state" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "country" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "make" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "model" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "lensModel" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "page" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "number"
}
} ,
{
"name" : "size" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "number"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/AssetResponseDto"
} ,
"type" : "array"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Asset"
]
}
} ,
2023-08-24 19:28:50 +00:00
"/audit/deletes" : {
"get" : {
"operationId" : "getAuditDeletes" ,
"parameters" : [
{
"name" : "entityType" ,
"required" : true ,
"in" : "query" ,
"schema" : {
"$ref" : "#/components/schemas/EntityType"
}
} ,
{
"name" : "userId" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
{
"name" : "after" ,
"required" : true ,
"in" : "query" ,
"schema" : {
"format" : "date-time" ,
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AuditDeletesResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Audit"
]
}
} ,
2023-10-14 17:12:59 +00:00
"/audit/file-report" : {
"get" : {
"operationId" : "getAuditFiles" ,
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FileReportDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Audit"
]
}
} ,
"/audit/file-report/checksum" : {
"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" : [
"Audit"
]
}
} ,
"/audit/file-report/fix" : {
"post" : {
"operationId" : "fixAuditFiles" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FileReportFixDto"
}
}
} ,
"required" : true
} ,
"responses" : {
"201" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Audit"
]
}
} ,
2023-06-10 04:14:18 +00:00
"/auth/admin-sign-up" : {
"post" : {
2023-11-04 01:33:15 +00:00
"operationId" : "signUpAdmin" ,
2023-01-24 04:13:42 +00:00
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/SignUpDto"
2023-01-24 04:13:42 +00:00
}
2022-12-09 20:53:11 +00:00
}
2023-08-01 16:49:18 +00:00
} ,
"required" : true
2023-01-24 04:13:42 +00:00
} ,
2022-12-05 17:56:44 +00:00
"responses" : {
2023-06-10 04:14:18 +00:00
"201" : {
2022-12-05 17:56:44 +00:00
"content" : {
"application/json" : {
"schema" : {
2023-11-09 15:14:15 +00:00
"$ref" : "#/components/schemas/UserResponseDto"
2023-06-10 04:14:18 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-06-10 04:14:18 +00:00
}
} ,
"tags" : [
"Authentication"
]
}
} ,
"/auth/change-password" : {
"post" : {
"operationId" : "changePassword" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ChangePasswordDto"
}
}
2023-08-01 16:49:18 +00:00
} ,
"required" : true
2023-06-10 04:14:18 +00:00
} ,
"responses" : {
2023-08-01 16:49:18 +00:00
"200" : {
2023-06-10 04:14:18 +00:00
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UserResponseDto"
2022-12-05 17:56:44 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2022-12-05 17:56:44 +00:00
}
} ,
2023-01-24 04:13:42 +00:00
"security" : [
2022-12-05 17:56:44 +00:00
{
2023-01-24 04:13:42 +00:00
"bearer" : [ ]
2023-02-24 16:01:10 +00:00
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-01-24 04:13:42 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Authentication"
2023-01-24 04:13:42 +00:00
]
}
} ,
2023-06-10 04:14:18 +00:00
"/auth/devices" : {
2023-08-01 16:49:18 +00:00
"delete" : {
"operationId" : "logoutAuthDevices" ,
2023-01-24 04:13:42 +00:00
"parameters" : [ ] ,
"responses" : {
2023-08-01 16:49:18 +00:00
"204" : {
"description" : ""
2022-12-05 17:56:44 +00:00
}
2023-01-24 04:13:42 +00:00
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 16:01:10 +00:00
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-01-24 04:13:42 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Authentication"
2023-01-24 04:13:42 +00:00
]
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"get" : {
"operationId" : "getAuthDevices" ,
2023-01-24 04:13:42 +00:00
"parameters" : [ ] ,
2022-12-05 17:56:44 +00:00
"responses" : {
"200" : {
2023-08-01 16:49:18 +00:00
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/AuthDeviceResponseDto"
} ,
"type" : "array"
}
}
} ,
2023-06-10 04:14:18 +00:00
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Authentication"
2023-06-10 04:14:18 +00:00
]
}
} ,
"/auth/devices/{id}" : {
"delete" : {
"operationId" : "logoutAuthDevice" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
2022-12-05 17:56:44 +00:00
}
}
2023-06-10 04:14:18 +00:00
] ,
"responses" : {
2023-08-01 16:49:18 +00:00
"204" : {
2023-06-10 04:14:18 +00:00
"description" : ""
}
2022-12-05 17:56:44 +00:00
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 16:01:10 +00:00
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2022-12-05 17:56:44 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Authentication"
2022-12-05 17:56:44 +00:00
]
}
} ,
2023-06-10 04:14:18 +00:00
"/auth/login" : {
2023-06-01 01:51:28 +00:00
"post" : {
2023-06-10 04:14:18 +00:00
"operationId" : "login" ,
2023-06-01 01:51:28 +00:00
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/LoginCredentialDto"
2023-06-01 01:51:28 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"required" : true
2023-06-01 01:51:28 +00:00
} ,
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/LoginResponseDto"
2023-06-01 01:51:28 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-06-01 01:51:28 +00:00
}
} ,
"tags" : [
2023-06-10 04:14:18 +00:00
"Authentication"
]
}
} ,
"/auth/logout" : {
"post" : {
"operationId" : "logout" ,
"parameters" : [ ] ,
"responses" : {
2023-08-01 16:49:18 +00:00
"200" : {
2023-06-10 04:14:18 +00:00
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LogoutResponseDto"
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-06-10 04:14:18 +00:00
}
} ,
2023-06-01 01:51:28 +00:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Authentication"
2023-06-01 01:51:28 +00:00
]
2023-06-10 04:14:18 +00:00
}
} ,
"/auth/validateToken" : {
"post" : {
"operationId" : "validateAccessToken" ,
2023-06-01 01:51:28 +00:00
"parameters" : [ ] ,
"responses" : {
2023-08-01 16:49:18 +00:00
"200" : {
2023-06-01 01:51:28 +00:00
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/ValidateAccessTokenResponseDto"
2023-06-01 01:51:28 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-06-01 01:51:28 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Authentication"
2023-06-01 01:51:28 +00:00
]
}
} ,
2023-06-10 04:14:18 +00:00
"/jobs" : {
2023-06-01 01:51:28 +00:00
"get" : {
2023-06-10 04:14:18 +00:00
"operationId" : "getAllJobsStatus" ,
"parameters" : [ ] ,
2023-06-01 01:51:28 +00:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/AllJobStatusResponseDto"
2023-06-01 01:51:28 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-06-01 01:51:28 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Job"
2023-06-01 01:51:28 +00:00
]
2023-06-10 04:14:18 +00:00
}
} ,
2023-06-16 19:36:07 +00:00
"/jobs/{id}" : {
2023-06-10 04:14:18 +00:00
"put" : {
"operationId" : "sendJobCommand" ,
2023-06-01 01:51:28 +00:00
"parameters" : [
{
2023-06-16 19:36:07 +00:00
"name" : "id" ,
2023-06-01 01:51:28 +00:00
"required" : true ,
"in" : "path" ,
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/JobName"
2023-06-01 01:51:28 +00:00
}
}
] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/JobCommandDto"
2023-06-01 01:51:28 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"required" : true
2023-06-01 01:51:28 +00:00
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/JobStatusDto"
2023-06-01 01:51:28 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-06-01 01:51:28 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Job"
2023-06-01 01:51:28 +00:00
]
2023-06-10 04:14:18 +00:00
}
} ,
2023-09-20 11:16:33 +00:00
"/library" : {
"get" : {
2023-11-04 01:33:15 +00:00
"operationId" : "getLibraries" ,
2023-09-20 11:16:33 +00:00
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/LibraryResponseDto"
} ,
"type" : "array"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Library"
]
} ,
"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" : [
"Library"
]
}
} ,
"/library/{id}" : {
"delete" : {
"operationId" : "deleteLibrary" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Library"
]
} ,
"get" : {
"operationId" : "getLibraryInfo" ,
"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" : [
"Library"
]
} ,
"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" : [
"Library"
]
}
} ,
"/library/{id}/removeOffline" : {
"post" : {
"operationId" : "removeOfflineFiles" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"responses" : {
"201" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Library"
]
}
} ,
"/library/{id}/scan" : {
"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" : {
"201" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Library"
]
}
} ,
"/library/{id}/statistics" : {
"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" : [
"Library"
]
}
} ,
2023-09-01 11:08:42 +00:00
"/oauth/authorize" : {
"post" : {
2023-11-04 01:33:15 +00:00
"operationId" : "startOAuth" ,
2023-09-01 11:08:42 +00: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 04:14:18 +00:00
"/oauth/callback" : {
"post" : {
2023-11-04 01:33:15 +00:00
"operationId" : "finishOAuth" ,
2023-06-10 04:14:18 +00:00
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/OAuthCallbackDto"
}
}
2023-08-01 16:49:18 +00:00
} ,
"required" : true
2023-06-10 04:14:18 +00:00
} ,
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LoginResponseDto"
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-06-10 04:14:18 +00:00
}
} ,
"tags" : [
"OAuth"
]
}
} ,
"/oauth/config" : {
"post" : {
2023-09-01 11:08:42 +00:00
"deprecated" : true ,
"description" : "@deprecated use feature flags and /oauth/authorize" ,
2023-11-04 01:33:15 +00:00
"operationId" : "generateOAuthConfig" ,
2023-06-10 04:14:18 +00:00
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/OAuthConfigDto"
}
}
2023-08-01 16:49:18 +00:00
} ,
"required" : true
2023-06-10 04:14:18 +00:00
} ,
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/OAuthConfigResponseDto"
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-06-10 04:14:18 +00:00
}
} ,
"tags" : [
"OAuth"
]
}
} ,
"/oauth/link" : {
"post" : {
2023-11-04 01:33:15 +00:00
"operationId" : "linkOAuthAccount" ,
2023-06-10 04:14:18 +00:00
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/OAuthCallbackDto"
}
}
2023-08-01 16:49:18 +00:00
} ,
"required" : true
2023-06-10 04:14:18 +00:00
} ,
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UserResponseDto"
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-06-01 01:51:28 +00:00
}
2023-06-10 04:14:18 +00:00
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"OAuth"
2023-06-10 04:14:18 +00:00
]
}
} ,
"/oauth/mobile-redirect" : {
"get" : {
2023-11-04 01:33:15 +00:00
"operationId" : "redirectOAuthToMobile" ,
2023-06-10 04:14:18 +00:00
"parameters" : [ ] ,
2023-06-01 01:51:28 +00:00
"responses" : {
"200" : {
"description" : ""
}
} ,
"tags" : [
2023-06-10 04:14:18 +00:00
"OAuth"
]
}
} ,
"/oauth/unlink" : {
"post" : {
2023-11-04 01:33:15 +00:00
"operationId" : "unlinkOAuthAccount" ,
2023-06-10 04:14:18 +00:00
"parameters" : [ ] ,
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UserResponseDto"
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-06-10 04:14:18 +00:00
}
} ,
2023-06-01 01:51:28 +00:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"OAuth"
2023-06-01 01:51:28 +00:00
]
}
} ,
2023-06-10 04:14:18 +00:00
"/partner" : {
2023-06-01 01:51:28 +00:00
"get" : {
2023-06-10 04:14:18 +00:00
"operationId" : "getPartners" ,
2023-06-01 01:51:28 +00:00
"parameters" : [
{
2023-06-10 04:14:18 +00:00
"name" : "direction" ,
2023-06-01 01:51:28 +00:00
"required" : true ,
2023-06-10 04:14:18 +00:00
"in" : "query" ,
2023-06-01 01:51:28 +00:00
"schema" : {
2023-06-10 04:14:18 +00:00
"enum" : [
"shared-by" ,
"shared-with"
] ,
2023-06-01 01:51:28 +00:00
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
2023-11-11 21:06:19 +00:00
"$ref" : "#/components/schemas/PartnerResponseDto"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-06-01 01:51:28 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-06-01 01:51:28 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Partner"
2023-06-01 01:51:28 +00:00
]
2023-06-10 04:14:18 +00:00
}
} ,
"/partner/{id}" : {
2023-08-01 16:49:18 +00:00
"delete" : {
"operationId" : "removePartner" ,
2023-06-01 01:51:28 +00:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"responses" : {
2023-08-01 16:49:18 +00:00
"200" : {
"description" : ""
2023-06-01 01:51:28 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Partner"
2023-06-01 01:51:28 +00:00
]
} ,
2023-08-01 16:49:18 +00:00
"post" : {
"operationId" : "createPartner" ,
2023-06-01 01:51:28 +00:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
2023-06-10 04:14:18 +00:00
"responses" : {
2023-08-01 16:49:18 +00:00
"201" : {
"content" : {
"application/json" : {
"schema" : {
2023-11-11 21:06:19 +00:00
"$ref" : "#/components/schemas/PartnerResponseDto"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Partner"
]
} ,
"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 16:49:18 +00:00
}
}
} ,
2023-06-10 04:14:18 +00:00
"description" : ""
2023-06-01 01:51:28 +00:00
}
} ,
2023-06-10 04:14:18 +00:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Partner"
2023-06-10 04:14:18 +00:00
]
}
} ,
"/person" : {
"get" : {
"operationId" : "getAllPeople" ,
2023-07-18 18:09:43 +00:00
"parameters" : [
{
"name" : "withHidden" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"default" : false ,
"type" : "boolean"
}
}
] ,
2023-06-01 01:51:28 +00:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-07-18 18:09:43 +00:00
"$ref" : "#/components/schemas/PeopleResponseDto"
2023-06-01 01:51:28 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-06-01 01:51:28 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Person"
2023-06-01 01:51:28 +00:00
]
2023-07-23 03:00:43 +00:00
} ,
"put" : {
"operationId" : "updatePeople" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PeopleUpdateDto"
}
}
2023-08-01 16:49:18 +00:00
} ,
"required" : true
2023-07-23 03:00:43 +00:00
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/BulkIdResponseDto"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-07-23 03:00:43 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-07-23 03:00:43 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Person"
2023-07-23 03:00:43 +00:00
]
2023-06-01 01:51:28 +00:00
}
} ,
2023-06-10 04:14:18 +00:00
"/person/{id}" : {
2023-01-24 04:13:42 +00:00
"get" : {
2023-06-10 04:14:18 +00:00
"operationId" : "getPerson" ,
2022-12-05 17:56:44 +00:00
"parameters" : [
{
2023-06-10 04:14:18 +00:00
"name" : "id" ,
2022-12-05 17:56:44 +00:00
"required" : true ,
2023-06-10 04:14:18 +00:00
"in" : "path" ,
2022-12-05 17:56:44 +00:00
"schema" : {
2023-06-10 04:14:18 +00:00
"format" : "uuid" ,
"type" : "string"
2022-12-05 17:56:44 +00:00
}
}
] ,
"responses" : {
2023-01-24 04:13:42 +00:00
"200" : {
2022-12-05 17:56:44 +00:00
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/PersonResponseDto"
2022-12-05 17:56:44 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2022-12-05 17:56:44 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 16:01:10 +00:00
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2022-12-05 17:56:44 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Person"
2022-12-05 17:56:44 +00:00
]
2023-01-24 04:13:42 +00:00
} ,
2023-06-10 04:14:18 +00:00
"put" : {
"operationId" : "updatePerson" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
2022-12-05 17:56:44 +00:00
"requestBody" : {
"content" : {
2023-01-24 04:13:42 +00:00
"application/json" : {
2022-12-05 17:56:44 +00:00
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/PersonUpdateDto"
2022-12-05 17:56:44 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"required" : true
2022-12-05 17:56:44 +00:00
} ,
"responses" : {
2023-06-10 04:14:18 +00:00
"200" : {
2022-12-05 17:56:44 +00:00
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/PersonResponseDto"
2022-12-05 17:56:44 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2022-12-05 17:56:44 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 16:01:10 +00:00
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2022-12-05 17:56:44 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Person"
2022-12-05 17:56:44 +00:00
]
2023-06-10 04:14:18 +00:00
}
} ,
"/person/{id}/assets" : {
"get" : {
"operationId" : "getPersonAssets" ,
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
2022-12-05 17:56:44 +00:00
}
}
2023-06-10 04:14:18 +00:00
] ,
2022-12-05 17:56:44 +00:00
"responses" : {
2023-01-24 04:13:42 +00:00
"200" : {
2022-12-05 17:56:44 +00:00
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"items" : {
"$ref" : "#/components/schemas/AssetResponseDto"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2022-12-05 17:56:44 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2022-12-05 17:56:44 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 16:01:10 +00:00
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2022-12-05 17:56:44 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Person"
2022-12-05 17:56:44 +00:00
]
}
} ,
2023-07-11 21:52:41 +00:00
"/person/{id}/merge" : {
"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 16:49:18 +00:00
} ,
"required" : true
2023-07-11 21:52:41 +00:00
} ,
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/BulkIdResponseDto"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-07-11 21:52:41 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-07-11 21:52:41 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Person"
2023-07-11 21:52:41 +00:00
]
}
} ,
2023-10-24 15:53:49 +00:00
"/person/{id}/statistics" : {
"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" : [
"Person"
]
}
} ,
2023-06-10 04:14:18 +00:00
"/person/{id}/thumbnail" : {
2022-12-05 17:56:44 +00:00
"get" : {
2023-06-10 04:14:18 +00:00
"operationId" : "getPersonThumbnail" ,
2022-12-05 17:56:44 +00:00
"parameters" : [
{
2023-06-10 04:14:18 +00:00
"name" : "id" ,
2022-12-05 17:56:44 +00:00
"required" : true ,
"in" : "path" ,
"schema" : {
2023-04-04 22:24:08 +00:00
"format" : "uuid" ,
2022-12-05 17:56:44 +00:00
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
2023-07-06 22:25:56 +00:00
"content" : {
2023-07-08 20:07:56 +00:00
"image/jpeg" : {
2023-07-06 22:25:56 +00:00
"schema" : {
2023-08-01 16:49:18 +00:00
"format" : "binary" ,
"type" : "string"
2023-07-06 22:25:56 +00:00
}
}
} ,
2023-06-10 04:14:18 +00:00
"description" : ""
2022-12-05 17:56:44 +00:00
}
} ,
2023-03-27 14:38:54 +00:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-03-27 14:38:54 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Person"
2022-12-05 17:56:44 +00:00
]
}
} ,
2023-06-10 04:14:18 +00:00
"/search" : {
2023-01-24 04:13:42 +00:00
"get" : {
2023-06-10 04:14:18 +00:00
"operationId" : "search" ,
"parameters" : [
{
"name" : "q" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
2023-01-09 20:16:08 +00:00
}
2023-06-10 04:14:18 +00:00
} ,
2023-01-09 20:16:08 +00:00
{
2023-06-10 04:14:18 +00:00
"name" : "query" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
2023-02-24 16:01:10 +00:00
} ,
{
2023-06-10 04:14:18 +00:00
"name" : "clip" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
2023-05-04 16:41:29 +00:00
} ,
{
2023-06-10 04:14:18 +00:00
"name" : "type" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"enum" : [
"IMAGE" ,
"VIDEO" ,
"AUDIO" ,
"OTHER"
] ,
"type" : "string"
}
} ,
2022-12-05 17:56:44 +00:00
{
2023-06-10 04:14:18 +00:00
"name" : "isFavorite" ,
2022-12-05 17:56:44 +00:00
"required" : false ,
"in" : "query" ,
"schema" : {
2023-01-24 04:13:42 +00:00
"type" : "boolean"
2022-12-05 17:56:44 +00:00
}
2023-06-10 04:14:18 +00:00
} ,
{
"name" : "isArchived" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
2022-12-05 17:56:44 +00:00
}
2023-06-10 04:14:18 +00:00
} ,
2022-12-05 17:56:44 +00:00
{
2023-06-10 04:14:18 +00:00
"name" : "exifInfo.city" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "exifInfo.state" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "exifInfo.country" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "exifInfo.make" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "exifInfo.model" ,
"required" : false ,
"in" : "query" ,
2022-12-05 17:56:44 +00:00
"schema" : {
"type" : "string"
}
2023-06-10 04:14:18 +00:00
} ,
2023-07-31 01:31:57 +00:00
{
"name" : "exifInfo.projectionType" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
2023-06-10 04:14:18 +00:00
{
"name" : "smartInfo.objects" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
}
} ,
{
"name" : "smartInfo.tags" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
}
} ,
{
"name" : "recent" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
} ,
{
"name" : "motion" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
2022-12-05 17:56:44 +00:00
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/SearchResponseDto"
2022-12-05 17:56:44 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2022-12-05 17:56:44 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 16:01:10 +00:00
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2022-12-05 17:56:44 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Search"
2022-12-05 17:56:44 +00:00
]
}
} ,
2023-06-10 04:14:18 +00:00
"/search/explore" : {
"get" : {
"operationId" : "getExploreData" ,
2022-12-05 17:56:44 +00:00
"parameters" : [ ] ,
"responses" : {
2023-06-10 04:14:18 +00:00
"200" : {
2022-12-05 17:56:44 +00:00
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"items" : {
"$ref" : "#/components/schemas/SearchExploreResponseDto"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2022-12-05 17:56:44 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2022-12-05 17:56:44 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-10-10 14:34:25 +00:00
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"Search"
]
}
} ,
"/search/person" : {
"get" : {
"operationId" : "searchPerson" ,
"parameters" : [
{
"name" : "name" ,
"required" : true ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
2023-10-24 15:53:49 +00:00
} ,
{
"name" : "withHidden" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
}
2023-10-10 14:34:25 +00:00
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/PersonResponseDto"
} ,
"type" : "array"
}
}
} ,
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 16:01:10 +00:00
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2022-12-05 17:56:44 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Search"
2022-12-05 17:56:44 +00:00
]
}
} ,
2023-06-10 04:14:18 +00:00
"/server-info" : {
2022-12-05 17:56:44 +00:00
"get" : {
2023-06-10 04:14:18 +00:00
"operationId" : "getServerInfo" ,
"parameters" : [ ] ,
2022-12-05 17:56:44 +00:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/ServerInfoResponseDto"
2022-12-05 17:56:44 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2022-12-05 17:56:44 +00:00
}
} ,
2023-03-27 14:38:54 +00:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-03-27 14:38:54 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Server Info"
2022-12-05 17:56:44 +00:00
]
}
} ,
2023-09-09 02:51:46 +00:00
"/server-info/config" : {
"get" : {
"operationId" : "getServerConfig" ,
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServerConfigDto"
}
}
} ,
"description" : ""
}
} ,
"tags" : [
"Server Info"
]
}
} ,
2023-08-18 04:55:26 +00:00
"/server-info/features" : {
"get" : {
"operationId" : "getServerFeatures" ,
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServerFeaturesDto"
}
}
} ,
"description" : ""
}
} ,
"tags" : [
"Server Info"
]
}
} ,
2023-07-16 01:24:46 +00:00
"/server-info/media-types" : {
"get" : {
"operationId" : "getSupportedMediaTypes" ,
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServerMediaTypesResponseDto"
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-07-16 01:24:46 +00:00
}
} ,
"tags" : [
"Server Info"
]
}
} ,
2023-06-10 04:14:18 +00:00
"/server-info/ping" : {
2023-05-17 17:07:17 +00:00
"get" : {
2023-06-10 04:14:18 +00:00
"operationId" : "pingServer" ,
2023-05-17 17:07:17 +00:00
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/ServerPingResponse"
2023-05-17 17:07:17 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-05-17 17:07:17 +00:00
}
} ,
"tags" : [
2023-06-10 04:14:18 +00:00
"Server Info"
2023-05-17 17:07:17 +00:00
]
}
} ,
2023-11-04 01:33:15 +00:00
"/server-info/statistics" : {
2023-05-17 17:07:17 +00:00
"get" : {
2023-11-04 01:33:15 +00:00
"operationId" : "getServerStatistics" ,
2023-06-10 04:14:18 +00:00
"parameters" : [ ] ,
2023-05-17 17:07:17 +00:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/ServerStatsResponseDto"
2023-05-17 17:07:17 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-05-17 17:07:17 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Server Info"
2023-05-17 17:07:17 +00:00
]
2023-06-10 04:14:18 +00:00
}
} ,
2023-10-25 22:13:05 +00:00
"/server-info/theme" : {
"get" : {
"operationId" : "getTheme" ,
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServerThemeDto"
}
}
} ,
"description" : ""
}
} ,
"tags" : [
"Server Info"
]
}
} ,
2023-06-10 04:14:18 +00:00
"/server-info/version" : {
"get" : {
"operationId" : "getServerVersion" ,
"parameters" : [ ] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-08-18 04:55:26 +00:00
"$ref" : "#/components/schemas/ServerVersionResponseDto"
2023-06-10 04:14:18 +00:00
}
2023-05-17 17:07:17 +00:00
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-05-17 17:07:17 +00:00
}
} ,
2023-06-10 04:14:18 +00:00
"tags" : [
"Server Info"
]
}
} ,
2023-06-21 01:08:43 +00:00
"/shared-link" : {
2023-06-10 04:14:18 +00:00
"get" : {
"operationId" : "getAllSharedLinks" ,
"parameters" : [ ] ,
2023-05-17 17:07:17 +00:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"items" : {
"$ref" : "#/components/schemas/SharedLinkResponseDto"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-05-17 17:07:17 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-05-17 17:07:17 +00:00
}
} ,
2023-06-21 01:08:43 +00:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Shared Link"
2023-06-21 01:08:43 +00:00
]
} ,
"post" : {
"operationId" : "createSharedLink" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SharedLinkCreateDto"
}
}
2023-08-01 16:49:18 +00:00
} ,
"required" : true
2023-06-21 01:08:43 +00:00
} ,
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SharedLinkResponseDto"
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-06-21 01:08:43 +00:00
}
} ,
2023-05-17 17:07:17 +00:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Shared Link"
2023-05-17 17:07:17 +00:00
]
}
} ,
2023-06-21 01:08:43 +00:00
"/shared-link/me" : {
2023-05-17 17:07:17 +00:00
"get" : {
2023-06-10 04:14:18 +00:00
"operationId" : "getMySharedLink" ,
2023-05-17 17:07:17 +00:00
"parameters" : [
2023-10-29 01:35:38 +00:00
{
"name" : "password" ,
"required" : false ,
"in" : "query" ,
"example" : "password" ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "token" ,
"required" : false ,
"in" : "query" ,
"schema" : {
"type" : "string"
}
} ,
2023-05-17 17:07:17 +00:00
{
2023-06-10 04:14:18 +00:00
"name" : "key" ,
"required" : false ,
"in" : "query" ,
2023-05-17 17:07:17 +00:00
"schema" : {
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
"content" : {
2023-06-10 04:14:18 +00:00
"application/json" : {
2023-05-17 17:07:17 +00:00
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/SharedLinkResponseDto"
2023-05-17 17:07:17 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-05-17 17:07:17 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Shared Link"
2023-05-17 17:07:17 +00:00
]
}
} ,
2023-06-21 01:08:43 +00:00
"/shared-link/{id}" : {
2023-08-01 16:49:18 +00:00
"delete" : {
"operationId" : "removeSharedLink" ,
2023-05-17 17:07:17 +00:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
2023-08-01 16:49:18 +00:00
"description" : ""
2023-05-17 17:07:17 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Shared Link"
2023-05-17 17:07:17 +00:00
]
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"get" : {
"operationId" : "getSharedLinkById" ,
2023-02-24 16:01:10 +00:00
"parameters" : [
{
2023-06-10 04:14:18 +00:00
"name" : "id" ,
"required" : true ,
"in" : "path" ,
2023-02-24 16:01:10 +00:00
"schema" : {
2023-06-10 04:14:18 +00:00
"format" : "uuid" ,
2023-02-24 16:01:10 +00:00
"type" : "string"
}
}
] ,
2022-12-05 17:56:44 +00:00
"responses" : {
2023-06-10 04:14:18 +00:00
"200" : {
2022-12-05 17:56:44 +00:00
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/SharedLinkResponseDto"
2022-12-05 17:56:44 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2022-12-05 17:56:44 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 16:01:10 +00:00
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2022-12-05 17:56:44 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Shared Link"
2022-12-05 17:56:44 +00:00
]
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"patch" : {
"operationId" : "updateSharedLink" ,
2023-01-24 04:13:42 +00:00
"parameters" : [
{
2023-06-02 02:19:25 +00:00
"name" : "id" ,
2023-01-24 04:13:42 +00:00
"required" : true ,
"in" : "path" ,
"schema" : {
2023-04-04 22:24:08 +00:00
"format" : "uuid" ,
2023-01-24 04:13:42 +00:00
"type" : "string"
2022-12-05 17:56:44 +00:00
}
}
2023-01-24 04:13:42 +00:00
] ,
2023-08-01 16:49:18 +00:00
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SharedLinkEditDto"
}
}
} ,
"required" : true
} ,
2022-12-05 17:56:44 +00:00
"responses" : {
2023-01-24 04:13:42 +00:00
"200" : {
2023-08-01 16:49:18 +00:00
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SharedLinkResponseDto"
}
}
} ,
2023-02-24 16:01:10 +00:00
"description" : ""
2022-12-05 17:56:44 +00:00
}
} ,
2023-06-21 01:08:43 +00:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Shared Link"
2023-06-21 01:08:43 +00:00
]
}
} ,
"/shared-link/{id}/assets" : {
2023-08-01 16:49:18 +00:00
"delete" : {
"operationId" : "removeSharedLinkAssets" ,
2023-06-21 01:08:43 +00: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 16:49:18 +00:00
} ,
"required" : true
2023-06-21 01:08:43 +00:00
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/AssetIdsResponseDto"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-06-21 01:08:43 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-06-21 01:08:43 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Shared Link"
]
2023-06-21 01:08:43 +00:00
} ,
2023-08-01 16:49:18 +00:00
"put" : {
"operationId" : "addSharedLinkAssets" ,
2023-06-21 01:08:43 +00: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 16:49:18 +00:00
} ,
"required" : true
2023-06-21 01:08:43 +00:00
} ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"items" : {
"$ref" : "#/components/schemas/AssetIdsResponseDto"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-06-21 01:08:43 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-06-21 01:08:43 +00:00
}
} ,
2022-12-05 17:56:44 +00:00
"security" : [
{
"bearer" : [ ]
2023-02-24 16:01:10 +00:00
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2022-12-05 17:56:44 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Shared Link"
2022-12-05 17:56:44 +00:00
]
}
} ,
2023-06-10 04:14:18 +00:00
"/system-config" : {
"get" : {
"operationId" : "getConfig" ,
"parameters" : [ ] ,
2022-12-05 17:56:44 +00:00
"responses" : {
2023-02-24 16:01:10 +00:00
"200" : {
2022-12-05 17:56:44 +00:00
"content" : {
2023-06-10 04:14:18 +00:00
"application/json" : {
2022-12-05 17:56:44 +00:00
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/SystemConfigDto"
2022-12-05 17:56:44 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2022-12-05 17:56:44 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 16:01:10 +00:00
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2022-12-05 17:56:44 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"System Config"
2022-12-05 17:56:44 +00:00
]
2023-06-10 04:14:18 +00:00
} ,
"put" : {
"operationId" : "updateConfig" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SystemConfigDto"
}
2023-02-24 16:01:10 +00:00
}
2023-08-01 16:49:18 +00:00
} ,
"required" : true
2023-06-10 04:14:18 +00:00
} ,
2022-12-05 17:56:44 +00:00
"responses" : {
"200" : {
"content" : {
2023-06-10 04:14:18 +00:00
"application/json" : {
2022-12-05 17:56:44 +00:00
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/SystemConfigDto"
2022-12-05 17:56:44 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2022-12-05 17:56:44 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 16:01:10 +00:00
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2022-12-05 17:56:44 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"System Config"
2022-12-05 17:56:44 +00:00
]
}
} ,
2023-06-10 04:14:18 +00:00
"/system-config/defaults" : {
2022-12-05 17:56:44 +00:00
"get" : {
2023-11-04 01:33:15 +00:00
"operationId" : "getConfigDefaults" ,
2023-06-10 04:14:18 +00:00
"parameters" : [ ] ,
2022-12-05 17:56:44 +00:00
"responses" : {
"200" : {
"content" : {
2023-06-10 04:14:18 +00:00
"application/json" : {
2022-12-05 17:56:44 +00:00
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/SystemConfigDto"
2022-12-05 17:56:44 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2022-12-05 17:56:44 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 16:01:10 +00:00
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2022-12-05 17:56:44 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"System Config"
2022-12-05 17:56:44 +00:00
]
2023-01-24 04:13:42 +00:00
}
} ,
2023-11-09 16:10:56 +00:00
"/system-config/map/style.json" : {
"get" : {
"operationId" : "getMapStyle" ,
"parameters" : [
{
"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" : [
"System Config"
]
}
} ,
2023-06-10 04:14:18 +00:00
"/system-config/storage-template-options" : {
2023-01-24 04:13:42 +00:00
"get" : {
2023-06-10 04:14:18 +00:00
"operationId" : "getStorageTemplateOptions" ,
"parameters" : [ ] ,
2022-12-05 17:56:44 +00:00
"responses" : {
"200" : {
"content" : {
2023-06-10 04:14:18 +00:00
"application/json" : {
2022-12-05 17:56:44 +00:00
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/SystemConfigTemplateStorageOptionDto"
2022-12-05 17:56:44 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2022-12-05 17:56:44 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 16:01:10 +00:00
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2022-12-05 17:56:44 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"System Config"
2022-12-05 17:56:44 +00:00
]
}
} ,
2023-06-10 04:14:18 +00:00
"/tag" : {
2023-08-01 16:49:18 +00:00
"get" : {
"operationId" : "getAllTags" ,
2022-12-05 17:56:44 +00:00
"parameters" : [ ] ,
"responses" : {
2023-08-01 16:49:18 +00:00
"200" : {
2022-12-05 17:56:44 +00:00
"content" : {
"application/json" : {
"schema" : {
2023-08-01 16:49:18 +00:00
"items" : {
"$ref" : "#/components/schemas/TagResponseDto"
} ,
"type" : "array"
2022-12-05 17:56:44 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2022-12-05 17:56:44 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 16:01:10 +00:00
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2022-12-05 17:56:44 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Tag"
2022-12-05 17:56:44 +00:00
]
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"post" : {
"operationId" : "createTag" ,
2023-01-24 04:13:42 +00:00
"parameters" : [ ] ,
2023-08-01 16:49:18 +00:00
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateTagDto"
}
}
} ,
"required" : true
} ,
2022-12-05 17:56:44 +00:00
"responses" : {
2023-08-01 16:49:18 +00:00
"201" : {
2022-12-05 17:56:44 +00:00
"content" : {
"application/json" : {
"schema" : {
2023-08-01 16:49:18 +00:00
"$ref" : "#/components/schemas/TagResponseDto"
2022-12-05 17:56:44 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2022-12-05 17:56:44 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 16:01:10 +00:00
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2022-12-05 17:56:44 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Tag"
2022-12-05 17:56:44 +00:00
]
}
} ,
2023-06-10 04:14:18 +00:00
"/tag/{id}" : {
2023-08-01 16:49:18 +00:00
"delete" : {
"operationId" : "deleteTag" ,
2023-06-10 04:14:18 +00:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
2022-12-05 17:56:44 +00:00
"responses" : {
"200" : {
2023-08-01 16:49:18 +00:00
"description" : ""
2022-12-05 17:56:44 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 16:01:10 +00:00
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2022-12-05 17:56:44 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Tag"
2022-12-05 17:56:44 +00:00
]
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"get" : {
"operationId" : "getTagById" ,
2023-06-10 04:14:18 +00:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
2022-12-05 17:56:44 +00:00
"responses" : {
2023-06-10 04:14:18 +00:00
"200" : {
2022-12-05 17:56:44 +00:00
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/TagResponseDto"
2022-12-05 17:56:44 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2022-12-05 17:56:44 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 16:01:10 +00:00
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2022-12-05 17:56:44 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Tag"
2022-12-05 17:56:44 +00:00
]
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"patch" : {
"operationId" : "updateTag" ,
2023-06-10 04:14:18 +00:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
2022-12-05 17:56:44 +00:00
}
}
2023-06-10 04:14:18 +00:00
] ,
2023-08-01 16:49:18 +00:00
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateTagDto"
}
}
} ,
"required" : true
} ,
2022-12-05 17:56:44 +00:00
"responses" : {
2023-06-10 04:14:18 +00:00
"200" : {
2023-08-01 16:49:18 +00:00
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TagResponseDto"
}
}
} ,
2023-06-10 04:14:18 +00:00
"description" : ""
2022-12-05 17:56:44 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 16:01:10 +00:00
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2022-12-05 17:56:44 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Tag"
2022-12-05 17:56:44 +00:00
]
}
} ,
2023-06-10 04:14:18 +00:00
"/tag/{id}/assets" : {
2023-08-01 16:49:18 +00:00
"delete" : {
"operationId" : "untagAssets" ,
2023-06-10 04:14:18 +00:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
2023-08-01 16:49:18 +00:00
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AssetIdsDto"
}
}
} ,
"required" : true
} ,
2022-12-05 17:56:44 +00:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"items" : {
2023-08-01 16:49:18 +00:00
"$ref" : "#/components/schemas/AssetIdsResponseDto"
} ,
"type" : "array"
2022-12-05 17:56:44 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2022-12-05 17:56:44 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 16:01:10 +00:00
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2022-12-05 17:56:44 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Tag"
2022-12-05 17:56:44 +00:00
]
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"get" : {
"operationId" : "getTagAssets" ,
2023-06-10 04:14:18 +00:00
"parameters" : [
{
"name" : "id" ,
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
}
] ,
2023-04-12 15:37:52 +00:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"items" : {
2023-08-01 16:49:18 +00:00
"$ref" : "#/components/schemas/AssetResponseDto"
} ,
"type" : "array"
2023-04-12 15:37:52 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-04-12 15:37:52 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-04-12 15:37:52 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Tag"
2023-04-12 15:37:52 +00:00
]
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"put" : {
"operationId" : "tagAssets" ,
2023-01-24 04:13:42 +00:00
"parameters" : [
2023-05-25 03:52:43 +00:00
{
2023-06-10 04:14:18 +00:00
"name" : "id" ,
"required" : true ,
"in" : "path" ,
2023-05-25 03:52:43 +00:00
"schema" : {
"format" : "uuid" ,
"type" : "string"
}
2023-01-15 05:49:47 +00:00
}
2023-01-24 04:13:42 +00:00
] ,
2023-06-10 04:14:18 +00:00
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AssetIdsDto"
}
}
2023-08-01 16:49:18 +00:00
} ,
"required" : true
2023-06-10 04:14:18 +00:00
} ,
2023-01-15 05:49:47 +00:00
"responses" : {
2023-01-24 04:13:42 +00:00
"200" : {
2023-01-15 05:49:47 +00:00
"content" : {
"application/json" : {
"schema" : {
2023-01-24 04:13:42 +00:00
"items" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/AssetIdsResponseDto"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-01-15 05:49:47 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-01-15 05:49:47 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 16:01:10 +00:00
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-01-15 05:49:47 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"Tag"
2023-01-15 05:49:47 +00:00
]
2023-06-10 04:14:18 +00:00
}
} ,
"/user" : {
"get" : {
"operationId" : "getAllUsers" ,
"parameters" : [
{
"name" : "isAll" ,
"required" : true ,
"in" : "query" ,
"schema" : {
"type" : "boolean"
2023-01-15 05:49:47 +00:00
}
}
2023-06-10 04:14:18 +00:00
] ,
2023-01-15 05:49:47 +00:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-01-24 04:13:42 +00:00
"items" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/UserResponseDto"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-01-15 05:49:47 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-01-15 05:49:47 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 16:01:10 +00:00
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-01-15 05:49:47 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"User"
2023-01-15 05:49:47 +00:00
]
2023-06-10 04:14:18 +00:00
} ,
2023-01-24 04:13:42 +00:00
"post" : {
2023-06-10 04:14:18 +00:00
"operationId" : "createUser" ,
2022-12-05 17:56:44 +00:00
"parameters" : [ ] ,
2023-01-24 04:13:42 +00:00
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/CreateUserDto"
2022-12-05 17:56:44 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"required" : true
2022-12-05 17:56:44 +00:00
} ,
"responses" : {
2023-01-24 04:13:42 +00:00
"201" : {
2022-12-05 17:56:44 +00:00
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/UserResponseDto"
2022-12-05 17:56:44 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2022-12-05 17:56:44 +00:00
}
} ,
2023-01-24 04:13:42 +00:00
"security" : [
{
"bearer" : [ ]
2023-02-24 16:01:10 +00:00
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-01-24 04:13:42 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"User"
2022-12-05 17:56:44 +00:00
]
2023-06-10 04:14:18 +00:00
} ,
"put" : {
"operationId" : "updateUser" ,
"parameters" : [ ] ,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateUserDto"
}
2022-12-05 17:56:44 +00:00
}
2023-08-01 16:49:18 +00:00
} ,
"required" : true
2023-06-10 04:14:18 +00:00
} ,
2022-12-05 17:56:44 +00:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/UserResponseDto"
2022-12-05 17:56:44 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2022-12-05 17:56:44 +00:00
}
} ,
2023-01-24 04:13:42 +00:00
"security" : [
{
"bearer" : [ ]
2023-02-24 16:01:10 +00:00
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-01-24 04:13:42 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"User"
2022-12-05 17:56:44 +00:00
]
2023-01-24 04:13:42 +00:00
}
} ,
2023-08-03 18:17:38 +00:00
"/user/info/{id}" : {
2023-06-10 04:14:18 +00:00
"get" : {
"operationId" : "getUserById" ,
2023-02-24 16:01:10 +00:00
"parameters" : [
{
2023-08-03 18:17:38 +00:00
"name" : "id" ,
2023-06-01 01:51:28 +00:00
"required" : true ,
"in" : "path" ,
2023-02-24 16:01:10 +00:00
"schema" : {
2023-06-01 01:51:28 +00:00
"format" : "uuid" ,
2023-02-24 16:01:10 +00:00
"type" : "string"
}
}
] ,
2023-01-24 04:13:42 +00:00
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/UserResponseDto"
2023-01-24 04:13:42 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-01-24 04:13:42 +00:00
}
} ,
"security" : [
{
"bearer" : [ ]
2023-02-24 16:01:10 +00:00
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-01-24 04:13:42 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"User"
2023-01-24 04:13:42 +00:00
]
}
} ,
2023-06-10 04:14:18 +00:00
"/user/me" : {
"get" : {
"operationId" : "getMyUserInfo" ,
2023-01-24 04:13:42 +00:00
"parameters" : [ ] ,
"responses" : {
2023-06-01 01:51:28 +00:00
"200" : {
2023-01-15 20:01:10 +00:00
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/UserResponseDto"
2023-01-15 20:01:10 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-01-15 20:01:10 +00:00
}
} ,
2023-02-24 16:01:10 +00:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-02-24 16:01:10 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"User"
2023-01-15 20:01:10 +00:00
]
2023-06-01 01:51:28 +00:00
}
} ,
2023-06-10 04:14:18 +00:00
"/user/profile-image" : {
2023-11-14 03:10:35 +00:00
"delete" : {
"operationId" : "deleteProfileImage" ,
"parameters" : [ ] ,
"responses" : {
"204" : {
"description" : ""
}
} ,
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
} ,
{
"api_key" : [ ]
}
] ,
"tags" : [
"User"
]
} ,
2023-06-01 01:51:28 +00:00
"post" : {
2023-06-10 04:14:18 +00:00
"operationId" : "createProfileImage" ,
2023-01-15 20:01:10 +00:00
"parameters" : [ ] ,
2023-06-01 01:51:28 +00:00
"requestBody" : {
"content" : {
2023-06-10 04:14:18 +00:00
"multipart/form-data" : {
2023-06-01 01:51:28 +00:00
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/CreateProfileImageDto"
2023-06-01 01:51:28 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : "A new avatar for the user" ,
"required" : true
2023-06-01 01:51:28 +00:00
} ,
2023-01-15 20:01:10 +00:00
"responses" : {
2023-06-10 04:14:18 +00:00
"201" : {
2023-01-15 20:01:10 +00:00
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/CreateProfileImageResponseDto"
2023-01-15 20:01:10 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-01-15 20:01:10 +00:00
}
} ,
2023-02-24 16:01:10 +00:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-02-24 16:01:10 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"User"
2023-01-15 20:01:10 +00:00
]
}
} ,
2023-08-03 18:17:38 +00:00
"/user/profile-image/{id}" : {
2023-06-10 04:14:18 +00:00
"get" : {
"operationId" : "getProfileImage" ,
"parameters" : [
{
2023-08-03 18:17:38 +00:00
"name" : "id" ,
2023-06-10 04:14:18 +00:00
"required" : true ,
"in" : "path" ,
"schema" : {
"format" : "uuid" ,
"type" : "string"
2023-01-15 20:01:10 +00:00
}
}
2023-06-10 04:14:18 +00:00
] ,
2023-01-15 20:01:10 +00:00
"responses" : {
2023-06-10 04:14:18 +00:00
"200" : {
2023-01-15 20:01:10 +00:00
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"type" : "object"
2023-01-15 20:01:10 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-01-15 20:01:10 +00:00
}
} ,
2023-02-24 16:01:10 +00:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-02-24 16:01:10 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"User"
2023-01-15 20:01:10 +00:00
]
2023-06-01 01:51:28 +00:00
}
} ,
2023-08-03 18:17:38 +00:00
"/user/{id}" : {
2023-06-10 04:14:18 +00:00
"delete" : {
"operationId" : "deleteUser" ,
2023-01-15 20:01:10 +00:00
"parameters" : [
{
2023-08-03 18:17:38 +00:00
"name" : "id" ,
2023-06-10 04:14:18 +00:00
"required" : true ,
"in" : "path" ,
2023-01-15 20:01:10 +00:00
"schema" : {
2023-06-10 04:14:18 +00:00
"format" : "uuid" ,
2023-01-15 20:01:10 +00:00
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/UserResponseDto"
2023-01-15 20:01:10 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-01-15 20:01:10 +00:00
}
} ,
2023-02-24 16:01:10 +00:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-02-24 16:01:10 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"User"
2023-01-15 20:01:10 +00:00
]
2023-06-01 01:51:28 +00:00
}
} ,
2023-08-03 18:17:38 +00:00
"/user/{id}/restore" : {
2023-06-10 04:14:18 +00:00
"post" : {
"operationId" : "restoreUser" ,
2023-01-15 20:01:10 +00:00
"parameters" : [
{
2023-08-03 18:17:38 +00:00
"name" : "id" ,
2023-06-10 04:14:18 +00:00
"required" : true ,
"in" : "path" ,
2023-01-15 20:01:10 +00:00
"schema" : {
2023-06-10 04:14:18 +00:00
"format" : "uuid" ,
2023-01-15 20:01:10 +00:00
"type" : "string"
}
}
] ,
"responses" : {
2023-06-10 04:14:18 +00:00
"201" : {
2023-06-01 01:51:28 +00:00
"content" : {
"application/json" : {
"schema" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/UserResponseDto"
2023-06-01 01:51:28 +00:00
}
}
2023-08-01 16:49:18 +00:00
} ,
"description" : ""
2023-01-15 20:01:10 +00:00
}
} ,
2023-02-24 16:01:10 +00:00
"security" : [
{
"bearer" : [ ]
} ,
{
"cookie" : [ ]
2023-05-04 16:41:29 +00:00
} ,
{
"api_key" : [ ]
2023-02-24 16:01:10 +00:00
}
2023-08-01 16:49:18 +00:00
] ,
"tags" : [
"User"
2023-01-15 20:01:10 +00:00
]
}
2023-06-10 04:14:18 +00:00
}
} ,
"info" : {
"title" : "Immich" ,
"description" : "Immich API" ,
2023-11-14 04:08:18 +00:00
"version" : "1.86.0" ,
2023-06-10 04:14:18 +00: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 20:01:10 +00:00
} ,
2023-06-10 04:14:18 +00:00
"schemas" : {
"APIKeyCreateDto" : {
2023-05-25 02:10:45 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"name" : {
2023-05-25 02:10:45 +00:00
"type" : "string"
}
2023-08-01 16:49:18 +00:00
} ,
"type" : "object"
2023-05-25 02:10:45 +00:00
} ,
2023-06-10 04:14:18 +00:00
"APIKeyCreateResponseDto" : {
2023-05-25 19:37:19 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"apiKey" : {
"$ref" : "#/components/schemas/APIKeyResponseDto"
2023-08-01 16:49:18 +00:00
} ,
"secret" : {
"type" : "string"
2023-06-07 14:37:25 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"secret" ,
"apiKey"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-06-07 14:37:25 +00:00
} ,
2023-03-26 02:46:48 +00:00
"APIKeyResponseDto" : {
2023-03-20 15:55:28 +00:00
"properties" : {
2023-08-01 16:49:18 +00:00
"createdAt" : {
"format" : "date-time" ,
2023-03-26 02:46:48 +00:00
"type" : "string"
2023-03-20 15:55:28 +00:00
} ,
2023-08-01 16:49:18 +00:00
"id" : {
2023-03-26 02:46:48 +00:00
"type" : "string"
2023-03-20 15:55:28 +00:00
} ,
2023-08-01 16:49:18 +00:00
"name" : {
2023-03-26 02:46:48 +00:00
"type" : "string"
2023-03-20 15:55:28 +00:00
} ,
2023-03-26 02:46:48 +00:00
"updatedAt" : {
2023-05-30 13:15:56 +00:00
"format" : "date-time" ,
2023-03-26 02:46:48 +00:00
"type" : "string"
2023-03-20 15:55:28 +00:00
}
} ,
"required" : [
2023-03-26 02:46:48 +00:00
"id" ,
"name" ,
"createdAt" ,
"updatedAt"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-03-20 15:55:28 +00:00
} ,
2023-03-26 02:46:48 +00:00
"APIKeyUpdateDto" : {
2023-01-24 04:13:42 +00:00
"properties" : {
2023-03-26 02:46:48 +00:00
"name" : {
2023-01-24 04:13:42 +00:00
"type" : "string"
}
} ,
"required" : [
2023-03-26 02:46:48 +00:00
"name"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-01-24 04:13:42 +00:00
} ,
2023-11-01 03:13:34 +00: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" : {
"enum" : [
"comment" ,
"like"
] ,
"type" : "string"
} ,
"user" : {
"$ref" : "#/components/schemas/UserDto"
}
} ,
"required" : [
"id" ,
"createdAt" ,
"type" ,
"user" ,
"assetId"
] ,
"type" : "object"
} ,
"ActivityStatisticsResponseDto" : {
"properties" : {
"comments" : {
"type" : "integer"
}
} ,
"required" : [
"comments"
] ,
"type" : "object"
} ,
2023-06-10 04:14:18 +00:00
"AddUsersDto" : {
2023-03-26 02:46:48 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"sharedUserIds" : {
"items" : {
2023-08-01 16:49:18 +00:00
"format" : "uuid" ,
"type" : "string"
} ,
"type" : "array"
2023-03-26 02:46:48 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"sharedUserIds"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-03-26 02:46:48 +00:00
} ,
2023-06-10 04:14:18 +00:00
"AlbumCountResponseDto" : {
"properties" : {
2023-08-01 16:49:18 +00:00
"notShared" : {
2023-06-10 04:14:18 +00:00
"type" : "integer"
} ,
2023-08-01 16:49:18 +00:00
"owned" : {
2023-06-10 04:14:18 +00:00
"type" : "integer"
} ,
2023-08-01 16:49:18 +00:00
"shared" : {
2023-06-10 04:14:18 +00:00
"type" : "integer"
}
} ,
"required" : [
"owned" ,
"shared" ,
2023-06-16 15:48:48 +00:00
"notShared"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-06-10 04:14:18 +00:00
} ,
"AlbumResponseDto" : {
2023-04-26 02:19:23 +00:00
"properties" : {
2023-08-01 16:49:18 +00:00
"albumName" : {
2023-04-26 02:19:23 +00:00
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"albumThumbnailAssetId" : {
"nullable" : true ,
2023-06-10 04:14:18 +00:00
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"assetCount" : {
"type" : "integer"
} ,
"assets" : {
"items" : {
"$ref" : "#/components/schemas/AssetResponseDto"
} ,
"type" : "array"
2023-06-10 04:14:18 +00:00
} ,
2023-04-26 02:19:23 +00:00
"createdAt" : {
2023-06-10 04:14:18 +00:00
"format" : "date-time" ,
2023-04-26 02:19:23 +00:00
"type" : "string"
} ,
2023-08-06 02:43:26 +00:00
"description" : {
"type" : "string"
} ,
2023-08-11 16:00:51 +00:00
"endDate" : {
"format" : "date-time" ,
"type" : "string"
} ,
"hasSharedLink" : {
"type" : "boolean"
} ,
2023-08-01 16:49:18 +00:00
"id" : {
"type" : "string"
} ,
2023-11-07 04:37:21 +00:00
"isActivityEnabled" : {
"type" : "boolean"
} ,
2023-08-01 16:49:18 +00:00
"lastModifiedAssetTimestamp" : {
2023-06-10 04:14:18 +00:00
"format" : "date-time" ,
2023-04-26 02:19:23 +00:00
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"owner" : {
"$ref" : "#/components/schemas/UserResponseDto"
} ,
"ownerId" : {
"type" : "string"
2023-06-10 04:14:18 +00:00
} ,
"shared" : {
2023-04-26 02:19:23 +00:00
"type" : "boolean"
} ,
2023-06-10 04:14:18 +00:00
"sharedUsers" : {
"items" : {
"$ref" : "#/components/schemas/UserResponseDto"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-06-21 01:00:59 +00:00
} ,
2023-08-11 16:00:51 +00:00
"startDate" : {
"format" : "date-time" ,
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"updatedAt" : {
2023-06-21 01:00:59 +00:00
"format" : "date-time" ,
"type" : "string"
2023-04-26 02:19:23 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"assetCount" ,
2023-04-26 02:19:23 +00:00
"id" ,
2023-06-10 04:14:18 +00:00
"ownerId" ,
"albumName" ,
2023-08-06 02:43:26 +00:00
"description" ,
2023-04-26 02:19:23 +00:00
"createdAt" ,
"updatedAt" ,
2023-06-10 04:14:18 +00:00
"albumThumbnailAssetId" ,
"shared" ,
"sharedUsers" ,
2023-08-11 16:00:51 +00:00
"hasSharedLink" ,
2023-06-10 04:14:18 +00:00
"assets" ,
2023-11-07 04:37:21 +00:00
"owner" ,
"isActivityEnabled"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-04-26 02:19:23 +00:00
} ,
2023-06-10 04:14:18 +00:00
"AllJobStatusResponseDto" : {
2023-03-26 02:46:48 +00:00
"properties" : {
2023-08-01 16:49:18 +00:00
"backgroundTask" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/JobStatusDto"
} ,
2023-08-01 16:49:18 +00:00
"clipEncoding" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/JobStatusDto"
} ,
2023-09-20 11:16:33 +00:00
"library" : {
"$ref" : "#/components/schemas/JobStatusDto"
} ,
2023-08-01 16:49:18 +00:00
"metadataExtraction" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/JobStatusDto"
} ,
2023-09-25 15:07:21 +00:00
"migration" : {
"$ref" : "#/components/schemas/JobStatusDto"
} ,
2023-06-10 04:14:18 +00:00
"objectTagging" : {
"$ref" : "#/components/schemas/JobStatusDto"
} ,
2023-08-01 16:49:18 +00:00
"recognizeFaces" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/JobStatusDto"
} ,
2023-08-01 16:49:18 +00:00
"search" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/JobStatusDto"
} ,
2023-08-01 16:49:18 +00:00
"sidecar" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/JobStatusDto"
} ,
2023-08-01 16:49:18 +00:00
"storageTemplateMigration" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/JobStatusDto"
} ,
2023-08-01 16:49:18 +00:00
"thumbnailGeneration" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/JobStatusDto"
} ,
2023-08-01 16:49:18 +00:00
"videoConversion" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/JobStatusDto"
}
} ,
"required" : [
"thumbnailGeneration" ,
"metadataExtraction" ,
"videoConversion" ,
"objectTagging" ,
"clipEncoding" ,
"storageTemplateMigration" ,
2023-09-25 15:07:21 +00:00
"migration" ,
2023-06-10 04:14:18 +00:00
"backgroundTask" ,
"search" ,
"recognizeFaces" ,
2023-09-20 11:16:33 +00:00
"sidecar" ,
"library"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-06-10 04:14:18 +00:00
} ,
2023-10-06 07:01:14 +00:00
"AssetBulkDeleteDto" : {
"properties" : {
"force" : {
"type" : "boolean"
} ,
"ids" : {
"items" : {
"format" : "uuid" ,
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"ids"
] ,
"type" : "object"
} ,
2023-08-16 20:04:55 +00:00
"AssetBulkUpdateDto" : {
"properties" : {
"ids" : {
"items" : {
"format" : "uuid" ,
"type" : "string"
} ,
"type" : "array"
} ,
"isArchived" : {
"type" : "boolean"
} ,
"isFavorite" : {
"type" : "boolean"
2023-10-22 02:38:07 +00:00
} ,
"removeParent" : {
"type" : "boolean"
} ,
"stackParentId" : {
"format" : "uuid" ,
"type" : "string"
2023-08-16 20:04:55 +00:00
}
} ,
"required" : [
"ids"
] ,
"type" : "object"
} ,
2023-06-10 04:14:18 +00:00
"AssetBulkUploadCheckDto" : {
"properties" : {
"assets" : {
"items" : {
"$ref" : "#/components/schemas/AssetBulkUploadCheckItem"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-06-10 04:14:18 +00:00
}
} ,
"required" : [
"assets"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-06-10 04:14:18 +00:00
} ,
"AssetBulkUploadCheckItem" : {
"properties" : {
2023-08-01 16:49:18 +00:00
"checksum" : {
"description" : "base64 or hex encoded sha1 hash" ,
2023-06-10 04:14:18 +00:00
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"id" : {
"type" : "string"
2023-06-10 04:14:18 +00:00
}
} ,
"required" : [
"id" ,
"checksum"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-06-10 04:14:18 +00:00
} ,
"AssetBulkUploadCheckResponseDto" : {
"properties" : {
"results" : {
"items" : {
"$ref" : "#/components/schemas/AssetBulkUploadCheckResult"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-06-10 04:14:18 +00:00
}
} ,
"required" : [
"results"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-06-10 04:14:18 +00:00
} ,
"AssetBulkUploadCheckResult" : {
"properties" : {
"action" : {
"enum" : [
"accept" ,
"reject"
2023-08-01 16:49:18 +00:00
] ,
"type" : "string"
} ,
"assetId" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
2023-06-10 04:14:18 +00:00
} ,
"reason" : {
"enum" : [
"duplicate" ,
"unsupported-format"
2023-08-01 16:49:18 +00:00
] ,
2023-06-10 04:14:18 +00:00
"type" : "string"
2023-03-26 02:46:48 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"id" ,
"action"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-03-26 02:46:48 +00:00
} ,
2023-06-10 04:14:18 +00:00
"AssetFileUploadResponseDto" : {
2023-04-01 20:46:07 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"duplicate" : {
2023-04-01 20:46:07 +00:00
"type" : "boolean"
2023-08-01 16:49:18 +00:00
} ,
"id" : {
"type" : "string"
2023-04-01 20:46:07 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"id" ,
"duplicate"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-04-01 20:46:07 +00:00
} ,
2023-06-10 04:14:18 +00:00
"AssetIdsDto" : {
2023-04-01 20:46:07 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"assetIds" : {
"items" : {
2023-08-01 16:49:18 +00:00
"format" : "uuid" ,
"type" : "string"
} ,
"type" : "array"
2023-06-10 04:14:18 +00:00
}
} ,
"required" : [
"assetIds"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-06-10 04:14:18 +00:00
} ,
"AssetIdsResponseDto" : {
"properties" : {
"assetId" : {
"type" : "string"
2023-04-01 20:46:07 +00:00
} ,
2023-06-10 04:14:18 +00:00
"error" : {
"enum" : [
"duplicate" ,
"no_permission" ,
"not_found"
] ,
"type" : "string"
2023-08-01 16:49:18 +00:00
} ,
"success" : {
"type" : "boolean"
2023-04-01 20:46:07 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"assetId" ,
"success"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-04-01 20:46:07 +00:00
} ,
2023-08-18 14:31:48 +00: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"
} ,
2023-11-14 22:47:15 +00:00
"AssetOrder" : {
"enum" : [
"asc" ,
"desc"
] ,
"type" : "string"
} ,
2023-06-10 04:14:18 +00:00
"AssetResponseDto" : {
2023-03-26 02:46:48 +00:00
"properties" : {
2023-08-01 16:49:18 +00:00
"checksum" : {
"description" : "base64 encoded sha1 hash" ,
2023-06-10 04:14:18 +00:00
"type" : "string"
2023-01-25 16:35:28 +00:00
} ,
2023-06-10 04:14:18 +00:00
"deviceAssetId" : {
"type" : "string"
2023-01-25 16:35:28 +00:00
} ,
2023-06-10 04:14:18 +00:00
"deviceId" : {
"type" : "string"
2023-01-25 16:35:28 +00:00
} ,
2023-08-01 16:49:18 +00:00
"duration" : {
2023-06-10 04:14:18 +00:00
"type" : "string"
2023-01-25 16:35:28 +00:00
} ,
2023-08-01 16:49:18 +00:00
"exifInfo" : {
"$ref" : "#/components/schemas/ExifResponseDto"
2023-06-18 03:22:31 +00:00
} ,
2023-06-10 04:14:18 +00: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 01:59:30 +00:00
} ,
2023-06-10 04:14:18 +00:00
"fileModifiedAt" : {
"format" : "date-time" ,
"type" : "string"
} ,
2023-10-14 01:46:30 +00:00
"hasMetadata" : {
"type" : "boolean"
} ,
2023-08-01 16:49:18 +00:00
"id" : {
2023-06-10 04:14:18 +00:00
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"isArchived" : {
2023-06-10 04:14:18 +00:00
"type" : "boolean"
} ,
2023-09-20 11:16:33 +00:00
"isExternal" : {
"type" : "boolean"
} ,
2023-08-01 16:49:18 +00:00
"isFavorite" : {
2023-06-10 04:14:18 +00:00
"type" : "boolean"
} ,
2023-09-20 11:16:33 +00:00
"isOffline" : {
"type" : "boolean"
} ,
"isReadOnly" : {
"type" : "boolean"
} ,
2023-10-06 07:01:14 +00:00
"isTrashed" : {
"type" : "boolean"
} ,
2023-09-20 11:16:33 +00:00
"libraryId" : {
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"livePhotoVideoId" : {
"nullable" : true ,
2023-06-10 04:14:18 +00:00
"type" : "string"
} ,
2023-10-04 22:11:11 +00:00
"localDateTime" : {
"format" : "date-time" ,
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"originalFileName" : {
"type" : "string"
} ,
"originalPath" : {
"type" : "string"
} ,
2023-09-06 03:14:44 +00:00
"owner" : {
"$ref" : "#/components/schemas/UserResponseDto"
} ,
2023-08-01 16:49:18 +00:00
"ownerId" : {
"type" : "string"
} ,
"people" : {
"items" : {
"$ref" : "#/components/schemas/PersonResponseDto"
} ,
"type" : "array"
} ,
"resized" : {
"type" : "boolean"
2023-06-10 04:14:18 +00:00
} ,
"smartInfo" : {
"$ref" : "#/components/schemas/SmartInfoResponseDto"
} ,
2023-10-22 02:38:07 +00:00
"stack" : {
"items" : {
"$ref" : "#/components/schemas/AssetResponseDto"
} ,
"type" : "array"
} ,
"stackCount" : {
2023-10-26 14:19:06 +00:00
"nullable" : true ,
2023-10-22 02:38:07 +00:00
"type" : "integer"
} ,
"stackParentId" : {
"nullable" : true ,
"type" : "string"
} ,
2023-06-10 04:14:18 +00:00
"tags" : {
"items" : {
"$ref" : "#/components/schemas/TagResponseDto"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"thumbhash" : {
"nullable" : true ,
"type" : "string"
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"type" : {
"$ref" : "#/components/schemas/AssetTypeEnum"
} ,
"updatedAt" : {
"format" : "date-time" ,
"type" : "string"
2023-01-25 16:35:28 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"type" ,
2023-10-22 02:38:07 +00:00
"stackCount" ,
2023-06-10 04:14:18 +00:00
"deviceAssetId" ,
"deviceId" ,
2023-09-06 03:14:44 +00:00
"ownerId" ,
2023-09-20 11:16:33 +00:00
"libraryId" ,
2023-06-10 04:14:18 +00:00
"originalPath" ,
"originalFileName" ,
"resized" ,
"fileCreatedAt" ,
"fileModifiedAt" ,
"updatedAt" ,
"isFavorite" ,
"isArchived" ,
2023-10-06 07:01:14 +00:00
"isTrashed" ,
2023-09-20 11:16:33 +00:00
"isOffline" ,
"isExternal" ,
"isReadOnly" ,
2023-10-14 01:46:30 +00:00
"checksum" ,
"id" ,
"thumbhash" ,
"localDateTime" ,
2023-06-10 04:14:18 +00:00
"duration" ,
2023-10-14 01:46:30 +00:00
"hasMetadata"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-03-26 02:46:48 +00:00
} ,
2023-07-14 13:30:17 +00:00
"AssetStatsResponseDto" : {
"properties" : {
"images" : {
"type" : "integer"
} ,
2023-08-02 21:10:55 +00:00
"total" : {
2023-07-14 13:30:17 +00:00
"type" : "integer"
} ,
2023-08-02 21:10:55 +00:00
"videos" : {
2023-07-14 13:30:17 +00:00
"type" : "integer"
}
} ,
"required" : [
"images" ,
"videos" ,
"total"
2023-08-02 21:10:55 +00:00
] ,
"type" : "object"
2023-07-14 13:30:17 +00:00
} ,
2023-06-10 04:14:18 +00:00
"AssetTypeEnum" : {
2023-03-26 02:46:48 +00:00
"enum" : [
2023-06-10 04:14:18 +00:00
"IMAGE" ,
"VIDEO" ,
"AUDIO" ,
"OTHER"
2023-08-01 16:49:18 +00:00
] ,
"type" : "string"
2023-03-26 02:46:48 +00:00
} ,
2023-07-09 02:43:11 +00:00
"AudioCodec" : {
"enum" : [
"mp3" ,
"aac" ,
2023-09-16 00:52:45 +00:00
"libopus"
2023-08-01 16:49:18 +00:00
] ,
"type" : "string"
2023-07-09 02:43:11 +00:00
} ,
2023-08-24 19:28:50 +00:00
"AuditDeletesResponseDto" : {
"properties" : {
"ids" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"needsFullSync" : {
"type" : "boolean"
}
} ,
"required" : [
"needsFullSync" ,
"ids"
] ,
"type" : "object"
} ,
2023-06-10 04:14:18 +00:00
"AuthDeviceResponseDto" : {
2023-01-25 16:35:28 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"createdAt" : {
"type" : "string"
} ,
"current" : {
2023-03-26 02:46:48 +00:00
"type" : "boolean"
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"deviceOS" : {
"type" : "string"
} ,
2023-06-10 04:14:18 +00:00
"deviceType" : {
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"id" : {
"type" : "string"
} ,
"updatedAt" : {
2023-06-10 04:14:18 +00:00
"type" : "string"
2023-03-26 02:46:48 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"id" ,
"createdAt" ,
"updatedAt" ,
"current" ,
"deviceType" ,
"deviceOS"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-03-26 02:46:48 +00:00
} ,
2023-07-11 21:52:41 +00:00
"BulkIdResponseDto" : {
"properties" : {
"error" : {
"enum" : [
"duplicate" ,
"no_permission" ,
"not_found" ,
"unknown"
2023-07-23 03:00:43 +00:00
] ,
"type" : "string"
2023-08-01 16:49:18 +00:00
} ,
"id" : {
"type" : "string"
} ,
"success" : {
"type" : "boolean"
2023-07-11 21:52:41 +00:00
}
} ,
"required" : [
"id" ,
"success"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-07-11 21:52:41 +00:00
} ,
2023-08-02 01:29:14 +00:00
"BulkIdsDto" : {
"properties" : {
"ids" : {
"items" : {
"format" : "uuid" ,
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"ids"
] ,
"type" : "object"
} ,
2023-08-29 13:58:00 +00:00
"CLIPConfig" : {
"properties" : {
"enabled" : {
"type" : "boolean"
} ,
"mode" : {
"$ref" : "#/components/schemas/CLIPMode"
} ,
"modelName" : {
"type" : "string"
} ,
"modelType" : {
"$ref" : "#/components/schemas/ModelType"
}
} ,
"required" : [
"enabled" ,
"modelName"
] ,
"type" : "object"
} ,
"CLIPMode" : {
"enum" : [
"vision" ,
"text"
] ,
"type" : "string"
} ,
2023-09-03 01:22:42 +00:00
"CQMode" : {
"enum" : [
"auto" ,
"cqp" ,
"icq"
] ,
"type" : "string"
} ,
2023-06-10 04:14:18 +00:00
"ChangePasswordDto" : {
2023-03-26 02:46:48 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"newPassword" : {
2023-08-01 16:49:18 +00:00
"example" : "password" ,
"type" : "string"
} ,
"password" : {
"example" : "password" ,
"type" : "string"
2023-03-26 02:46:48 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"password" ,
"newPassword"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-03-26 02:46:48 +00:00
} ,
2023-06-10 04:14:18 +00:00
"CheckExistingAssetsDto" : {
2023-03-03 02:47:08 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"deviceAssetIds" : {
"items" : {
"type" : "string"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-03-03 02:47:08 +00:00
} ,
2023-06-10 04:14:18 +00:00
"deviceId" : {
2023-03-03 02:47:08 +00:00
"type" : "string"
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"deviceAssetIds" ,
"deviceId"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-03-03 02:47:08 +00:00
} ,
2023-06-10 04:14:18 +00:00
"CheckExistingAssetsResponseDto" : {
2023-03-03 02:47:08 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"existingIds" : {
2023-03-03 02:47:08 +00:00
"items" : {
2023-06-10 04:14:18 +00:00
"type" : "string"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-03-03 02:47:08 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"existingIds"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-03-03 02:47:08 +00:00
} ,
2023-09-26 07:03:57 +00:00
"CitiesFile" : {
"enum" : [
"cities15000" ,
"cities5000" ,
"cities1000" ,
"cities500"
] ,
"type" : "string"
} ,
2023-08-29 13:58:00 +00:00
"ClassificationConfig" : {
"properties" : {
"enabled" : {
"type" : "boolean"
} ,
"minScore" : {
"type" : "integer"
} ,
"modelName" : {
"type" : "string"
} ,
"modelType" : {
"$ref" : "#/components/schemas/ModelType"
}
} ,
"required" : [
"minScore" ,
"enabled" ,
"modelName"
] ,
"type" : "object"
} ,
2023-09-03 06:21:51 +00:00
"Colorspace" : {
"enum" : [
"srgb" ,
"p3"
] ,
"type" : "string"
} ,
2023-06-10 04:14:18 +00:00
"CreateAlbumDto" : {
2023-03-03 02:47:08 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"albumName" : {
"type" : "string"
2023-03-03 02:47:08 +00:00
} ,
2023-08-01 16:49:18 +00:00
"assetIds" : {
2023-03-03 02:47:08 +00:00
"items" : {
2023-08-01 16:49:18 +00:00
"format" : "uuid" ,
"type" : "string"
} ,
"type" : "array"
2023-03-03 02:47:08 +00:00
} ,
2023-08-06 02:43:26 +00:00
"description" : {
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"sharedWithUserIds" : {
2023-03-03 02:47:08 +00:00
"items" : {
2023-08-01 16:49:18 +00:00
"format" : "uuid" ,
"type" : "string"
} ,
"type" : "array"
2023-03-03 02:47:08 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"albumName"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-03-03 02:47:08 +00:00
} ,
2023-06-10 04:14:18 +00:00
"CreateAssetDto" : {
2023-03-03 02:47:08 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"assetData" : {
2023-08-01 16:49:18 +00:00
"format" : "binary" ,
"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 02:33:20 +00:00
} ,
2023-06-10 04:14:18 +00:00
"deviceAssetId" : {
"type" : "string"
} ,
"deviceId" : {
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"duration" : {
"type" : "string"
} ,
2023-06-10 04:14:18 +00:00
"fileCreatedAt" : {
"format" : "date-time" ,
"type" : "string"
} ,
"fileModifiedAt" : {
"format" : "date-time" ,
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"isArchived" : {
"type" : "boolean"
} ,
2023-09-20 11:16:33 +00:00
"isExternal" : {
"type" : "boolean"
} ,
2023-06-10 04:14:18 +00:00
"isFavorite" : {
"type" : "boolean"
} ,
2023-09-20 11:16:33 +00:00
"isOffline" : {
"type" : "boolean"
} ,
2023-08-01 16:49:18 +00:00
"isReadOnly" : {
2023-06-10 04:14:18 +00:00
"type" : "boolean"
} ,
"isVisible" : {
"type" : "boolean"
} ,
2023-09-20 11:16:33 +00:00
"libraryId" : {
"format" : "uuid" ,
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"livePhotoData" : {
"format" : "binary" ,
"type" : "string"
} ,
"sidecarData" : {
"format" : "binary" ,
2023-06-10 04:14:18 +00:00
"type" : "string"
}
} ,
"required" : [
"assetData" ,
"deviceAssetId" ,
"deviceId" ,
"fileCreatedAt" ,
2023-11-06 14:04:39 +00:00
"fileModifiedAt"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-06-10 04:14:18 +00:00
} ,
2023-09-20 11:16:33 +00:00
"CreateLibraryDto" : {
"properties" : {
"exclusionPatterns" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"importPaths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"isVisible" : {
"type" : "boolean"
} ,
"name" : {
"type" : "string"
} ,
"type" : {
"$ref" : "#/components/schemas/LibraryType"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} ,
2023-06-10 04:14:18 +00:00
"CreateProfileImageDto" : {
2023-03-03 02:47:08 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"file" : {
2023-08-01 16:49:18 +00:00
"format" : "binary" ,
"type" : "string"
2023-03-03 02:47:08 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"file"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-03-03 02:47:08 +00:00
} ,
2023-06-10 04:14:18 +00:00
"CreateProfileImageResponseDto" : {
2023-03-05 20:44:31 +00:00
"properties" : {
2023-08-01 16:49:18 +00:00
"profileImagePath" : {
2023-03-05 20:44:31 +00:00
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"userId" : {
2023-06-10 04:14:18 +00:00
"type" : "string"
2023-03-05 20:44:31 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"userId" ,
"profileImagePath"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-03-05 20:44:31 +00:00
} ,
2023-06-10 04:14:18 +00:00
"CreateTagDto" : {
2023-03-05 20:44:31 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"name" : {
"type" : "string"
2023-08-01 16:49:18 +00:00
} ,
"type" : {
"$ref" : "#/components/schemas/TagTypeEnum"
2023-03-05 20:44:31 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"type" ,
"name"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-03-05 20:44:31 +00:00
} ,
2023-06-10 04:14:18 +00:00
"CreateUserDto" : {
2023-03-22 02:49:19 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"email" : {
"type" : "string"
2023-03-22 02:49:19 +00:00
} ,
2023-08-01 16:49:18 +00:00
"externalPath" : {
"nullable" : true ,
2023-03-22 02:49:19 +00:00
"type" : "string"
} ,
2023-08-10 02:01:16 +00:00
"memoriesEnabled" : {
"type" : "boolean"
} ,
2023-11-12 01:03:32 +00:00
"name" : {
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"password" : {
"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 02:33:20 +00:00
} ,
2023-08-01 16:49:18 +00:00
"storageLabel" : {
"nullable" : true ,
"type" : "string"
2023-03-22 02:49:19 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"email" ,
"password" ,
2023-11-12 01:03:32 +00:00
"name"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-03-22 02:49:19 +00:00
} ,
2023-06-10 04:14:18 +00:00
"CuratedLocationsResponseDto" : {
2023-03-22 02:49:19 +00:00
"properties" : {
2023-08-01 16:49:18 +00:00
"city" : {
2023-06-10 04:14:18 +00:00
"type" : "string"
2023-03-22 02:49:19 +00:00
} ,
2023-08-01 16:49:18 +00:00
"deviceAssetId" : {
2023-06-10 04:14:18 +00:00
"type" : "string"
2023-03-22 02:49:19 +00:00
} ,
2023-08-01 16:49:18 +00:00
"deviceId" : {
2023-06-10 04:14:18 +00:00
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"id" : {
2023-06-10 04:14:18 +00:00
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"resizePath" : {
2023-06-10 04:14:18 +00:00
"type" : "string"
2023-03-22 02:49:19 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"id" ,
"city" ,
"resizePath" ,
"deviceAssetId" ,
"deviceId"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-03-22 02:49:19 +00:00
} ,
2023-06-10 04:14:18 +00:00
"CuratedObjectsResponseDto" : {
2023-03-22 02:49:19 +00:00
"properties" : {
2023-08-01 16:49:18 +00:00
"deviceAssetId" : {
2023-03-22 02:49:19 +00:00
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"deviceId" : {
2023-03-22 02:49:19 +00:00
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"id" : {
2023-03-22 02:49:19 +00:00
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"object" : {
2023-06-10 04:14:18 +00:00
"type" : "string"
2023-03-22 02:49:19 +00:00
} ,
2023-08-01 16:49:18 +00:00
"resizePath" : {
2023-06-10 04:14:18 +00:00
"type" : "string"
2023-03-22 02:49:19 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"id" ,
"object" ,
"resizePath" ,
"deviceAssetId" ,
"deviceId"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-03-22 02:49:19 +00:00
} ,
2023-06-30 16:24:28 +00:00
"DownloadArchiveInfo" : {
2023-01-25 16:35:28 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"assetIds" : {
"items" : {
"type" : "string"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
} ,
"size" : {
"type" : "integer"
2023-01-25 16:35:28 +00:00
}
} ,
"required" : [
2023-06-30 16:24:28 +00:00
"size" ,
2023-06-10 04:14:18 +00:00
"assetIds"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-01-25 16:35:28 +00:00
} ,
2023-08-15 15:49:32 +00:00
"DownloadInfoDto" : {
"properties" : {
"albumId" : {
"format" : "uuid" ,
"type" : "string"
} ,
"archiveSize" : {
"type" : "integer"
} ,
"assetIds" : {
"items" : {
"format" : "uuid" ,
"type" : "string"
} ,
"type" : "array"
} ,
"userId" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
"type" : "object"
} ,
2023-06-30 16:24:28 +00:00
"DownloadResponseDto" : {
"properties" : {
"archives" : {
"items" : {
"$ref" : "#/components/schemas/DownloadArchiveInfo"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
} ,
"totalSize" : {
"type" : "integer"
2023-06-30 16:24:28 +00:00
}
} ,
"required" : [
"totalSize" ,
"archives"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-06-30 16:24:28 +00:00
} ,
2023-08-24 19:28:50 +00:00
"EntityType" : {
"enum" : [
"ASSET" ,
"ALBUM"
] ,
"type" : "string"
} ,
2023-06-10 04:14:18 +00:00
"ExifResponseDto" : {
2023-01-25 16:35:28 +00:00
"properties" : {
2023-08-01 16:49:18 +00:00
"city" : {
2023-06-10 04:14:18 +00:00
"default" : null ,
"nullable" : true ,
2023-08-01 16:49:18 +00:00
"type" : "string"
2023-01-25 16:35:28 +00:00
} ,
2023-08-01 16:49:18 +00:00
"country" : {
"default" : null ,
2023-06-10 04:14:18 +00:00
"nullable" : true ,
2023-08-01 16:49:18 +00:00
"type" : "string"
2023-01-25 16:35:28 +00:00
} ,
2023-08-01 16:49:18 +00:00
"dateTimeOriginal" : {
"default" : null ,
"format" : "date-time" ,
2023-06-10 04:14:18 +00:00
"nullable" : true ,
2023-08-01 16:49:18 +00:00
"type" : "string"
2023-01-25 16:35:28 +00:00
} ,
2023-08-01 16:49:18 +00:00
"description" : {
"default" : null ,
2023-06-10 04:14:18 +00:00
"nullable" : true ,
2023-08-01 16:49:18 +00:00
"type" : "string"
2023-01-25 16:35:28 +00:00
} ,
2023-08-01 16:49:18 +00:00
"exifImageHeight" : {
"default" : null ,
2023-06-10 04:14:18 +00:00
"nullable" : true ,
2023-08-01 16:49:18 +00:00
"type" : "number"
2023-05-22 18:07:43 +00:00
} ,
2023-08-01 16:49:18 +00:00
"exifImageWidth" : {
"default" : null ,
2023-06-10 04:14:18 +00:00
"nullable" : true ,
2023-08-01 16:49:18 +00:00
"type" : "number"
2023-05-22 18:07:43 +00:00
} ,
2023-08-01 16:49:18 +00:00
"exposureTime" : {
"default" : null ,
2023-06-10 04:14:18 +00:00
"nullable" : true ,
2023-08-01 16:49:18 +00:00
"type" : "string"
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"fNumber" : {
"default" : null ,
2023-06-10 04:14:18 +00:00
"nullable" : true ,
2023-08-01 16:49:18 +00:00
"type" : "number"
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"fileSizeInByte" : {
"default" : null ,
"format" : "int64" ,
2023-06-10 04:14:18 +00:00
"nullable" : true ,
2023-08-01 16:49:18 +00:00
"type" : "integer"
2023-06-10 04:14:18 +00:00
} ,
"focalLength" : {
2023-08-01 16:49:18 +00:00
"default" : null ,
2023-06-10 04:14:18 +00:00
"nullable" : true ,
2023-08-01 16:49:18 +00:00
"type" : "number"
2023-06-10 04:14:18 +00:00
} ,
"iso" : {
2023-08-01 16:49:18 +00:00
"default" : null ,
2023-06-10 04:14:18 +00:00
"nullable" : true ,
2023-08-01 16:49:18 +00:00
"type" : "number"
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"latitude" : {
"default" : null ,
2023-06-10 04:14:18 +00:00
"nullable" : true ,
2023-08-01 16:49:18 +00:00
"type" : "number"
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"lensModel" : {
"default" : null ,
2023-06-10 04:14:18 +00:00
"nullable" : true ,
2023-08-01 16:49:18 +00:00
"type" : "string"
2023-06-10 04:14:18 +00:00
} ,
"longitude" : {
2023-08-01 16:49:18 +00:00
"default" : null ,
2023-06-10 04:14:18 +00:00
"nullable" : true ,
2023-08-01 16:49:18 +00:00
"type" : "number"
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"make" : {
"default" : null ,
2023-06-10 04:14:18 +00:00
"nullable" : true ,
2023-08-01 16:49:18 +00:00
"type" : "string"
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"model" : {
"default" : null ,
2023-06-10 04:14:18 +00:00
"nullable" : true ,
2023-08-01 16:49:18 +00:00
"type" : "string"
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"modifyDate" : {
"default" : null ,
"format" : "date-time" ,
2023-06-10 04:14:18 +00:00
"nullable" : true ,
2023-08-01 16:49:18 +00:00
"type" : "string"
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"orientation" : {
"default" : null ,
2023-06-10 04:14:18 +00:00
"nullable" : true ,
2023-08-01 16:49:18 +00:00
"type" : "string"
2023-07-28 04:29:09 +00:00
} ,
"projectionType" : {
2023-08-01 16:49:18 +00:00
"default" : null ,
"nullable" : true ,
"type" : "string"
} ,
"state" : {
"default" : null ,
"nullable" : true ,
"type" : "string"
} ,
"timeZone" : {
"default" : null ,
2023-07-28 04:29:09 +00:00
"nullable" : true ,
2023-08-01 16:49:18 +00:00
"type" : "string"
2023-06-10 04:14:18 +00:00
}
2023-08-01 16:49:18 +00:00
} ,
"type" : "object"
2023-06-10 04:14:18 +00:00
} ,
2023-10-14 17:12:59 +00:00
"FileChecksumDto" : {
"properties" : {
"filenames" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"filenames"
] ,
"type" : "object"
} ,
"FileChecksumResponseDto" : {
"properties" : {
"checksum" : {
"type" : "string"
} ,
"filename" : {
"type" : "string"
}
} ,
"required" : [
"filename" ,
"checksum"
] ,
"type" : "object"
} ,
"FileReportDto" : {
"properties" : {
"extras" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"orphans" : {
"items" : {
"$ref" : "#/components/schemas/FileReportItemDto"
} ,
"type" : "array"
}
} ,
"required" : [
"orphans" ,
"extras"
] ,
"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"
} ,
feat(server): support for read-only assets and importing existing items in the filesystem (#2715)
* Added read-only flag for assets, endpoint to trigger file import vs upload
* updated fixtures with new property
* if upload is 'read-only', ensure there is no existing asset at the designated originalPath
* added test for file import as well as detecting existing image at read-only destination location
* Added storage service test for a case where it should not move read-only assets
* upload doesn't need the read-only flag available, just importing
* default isReadOnly on import endpoint to true
* formatting fixes
* create-asset dto needs isReadOnly, so set it to false by default on create, updated api generation
* updated code to reflect changes in MR
* fixed read stream promise return type
* new index for originalPath, check for existing path on import, reglardless of user, to prevent duplicates
* refactor: import asset
* chore: open api
* chore: tests
* Added externalPath support for individual users, updated UI to allow this to be set by admin
* added missing var for externalPath in ui
* chore: open api
* fix: compilation issues
* fix: server test
* built api, fixed user-response dto to include externalPath
* reverted accidental commit
* bad commit of duplicate externalPath in user response dto
* fixed tests to include externalPath on expected result
* fix: unit tests
* centralized supported filetypes, perform file type checking of asset and sidecar during file import process
* centralized supported filetype check method to keep regex DRY
* fixed typo
* combined migrations into one
* update api
* Removed externalPath from shared-link code, added column to admin user page whether external paths / import is enabled or not
* update mimetype
* Fixed detect correct mimetype
* revert asset-upload config
* reverted domain.constant
* refactor
* fix mime-type issue
* fix format
---------
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2023-06-22 02:33:20 +00:00
"ImportAssetDto" : {
"properties" : {
"assetPath" : {
"type" : "string"
} ,
"deviceAssetId" : {
"type" : "string"
} ,
"deviceId" : {
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"duration" : {
"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 02:33:20 +00:00
"fileCreatedAt" : {
"format" : "date-time" ,
"type" : "string"
} ,
"fileModifiedAt" : {
"format" : "date-time" ,
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"isArchived" : {
"type" : "boolean"
} ,
2023-09-20 11:16:33 +00:00
"isExternal" : {
"type" : "boolean"
} ,
feat(server): support for read-only assets and importing existing items in the filesystem (#2715)
* Added read-only flag for assets, endpoint to trigger file import vs upload
* updated fixtures with new property
* if upload is 'read-only', ensure there is no existing asset at the designated originalPath
* added test for file import as well as detecting existing image at read-only destination location
* Added storage service test for a case where it should not move read-only assets
* upload doesn't need the read-only flag available, just importing
* default isReadOnly on import endpoint to true
* formatting fixes
* create-asset dto needs isReadOnly, so set it to false by default on create, updated api generation
* updated code to reflect changes in MR
* fixed read stream promise return type
* new index for originalPath, check for existing path on import, reglardless of user, to prevent duplicates
* refactor: import asset
* chore: open api
* chore: tests
* Added externalPath support for individual users, updated UI to allow this to be set by admin
* added missing var for externalPath in ui
* chore: open api
* fix: compilation issues
* fix: server test
* built api, fixed user-response dto to include externalPath
* reverted accidental commit
* bad commit of duplicate externalPath in user response dto
* fixed tests to include externalPath on expected result
* fix: unit tests
* centralized supported filetypes, perform file type checking of asset and sidecar during file import process
* centralized supported filetype check method to keep regex DRY
* fixed typo
* combined migrations into one
* update api
* Removed externalPath from shared-link code, added column to admin user page whether external paths / import is enabled or not
* update mimetype
* Fixed detect correct mimetype
* revert asset-upload config
* reverted domain.constant
* refactor
* fix mime-type issue
* fix format
---------
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2023-06-22 02:33:20 +00:00
"isFavorite" : {
"type" : "boolean"
} ,
2023-09-20 11:16:33 +00:00
"isOffline" : {
"type" : "boolean"
} ,
2023-08-01 16:49:18 +00:00
"isReadOnly" : {
"default" : true ,
feat(server): support for read-only assets and importing existing items in the filesystem (#2715)
* Added read-only flag for assets, endpoint to trigger file import vs upload
* updated fixtures with new property
* if upload is 'read-only', ensure there is no existing asset at the designated originalPath
* added test for file import as well as detecting existing image at read-only destination location
* Added storage service test for a case where it should not move read-only assets
* upload doesn't need the read-only flag available, just importing
* default isReadOnly on import endpoint to true
* formatting fixes
* create-asset dto needs isReadOnly, so set it to false by default on create, updated api generation
* updated code to reflect changes in MR
* fixed read stream promise return type
* new index for originalPath, check for existing path on import, reglardless of user, to prevent duplicates
* refactor: import asset
* chore: open api
* chore: tests
* Added externalPath support for individual users, updated UI to allow this to be set by admin
* added missing var for externalPath in ui
* chore: open api
* fix: compilation issues
* fix: server test
* built api, fixed user-response dto to include externalPath
* reverted accidental commit
* bad commit of duplicate externalPath in user response dto
* fixed tests to include externalPath on expected result
* fix: unit tests
* centralized supported filetypes, perform file type checking of asset and sidecar during file import process
* centralized supported filetype check method to keep regex DRY
* fixed typo
* combined migrations into one
* update api
* Removed externalPath from shared-link code, added column to admin user page whether external paths / import is enabled or not
* update mimetype
* Fixed detect correct mimetype
* revert asset-upload config
* reverted domain.constant
* refactor
* fix mime-type issue
* fix format
---------
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2023-06-22 02:33:20 +00:00
"type" : "boolean"
} ,
"isVisible" : {
"type" : "boolean"
} ,
2023-09-20 11:16:33 +00:00
"libraryId" : {
"format" : "uuid" ,
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"sidecarPath" : {
feat(server): support for read-only assets and importing existing items in the filesystem (#2715)
* Added read-only flag for assets, endpoint to trigger file import vs upload
* updated fixtures with new property
* if upload is 'read-only', ensure there is no existing asset at the designated originalPath
* added test for file import as well as detecting existing image at read-only destination location
* Added storage service test for a case where it should not move read-only assets
* upload doesn't need the read-only flag available, just importing
* default isReadOnly on import endpoint to true
* formatting fixes
* create-asset dto needs isReadOnly, so set it to false by default on create, updated api generation
* updated code to reflect changes in MR
* fixed read stream promise return type
* new index for originalPath, check for existing path on import, reglardless of user, to prevent duplicates
* refactor: import asset
* chore: open api
* chore: tests
* Added externalPath support for individual users, updated UI to allow this to be set by admin
* added missing var for externalPath in ui
* chore: open api
* fix: compilation issues
* fix: server test
* built api, fixed user-response dto to include externalPath
* reverted accidental commit
* bad commit of duplicate externalPath in user response dto
* fixed tests to include externalPath on expected result
* fix: unit tests
* centralized supported filetypes, perform file type checking of asset and sidecar during file import process
* centralized supported filetype check method to keep regex DRY
* fixed typo
* combined migrations into one
* update api
* Removed externalPath from shared-link code, added column to admin user page whether external paths / import is enabled or not
* update mimetype
* Fixed detect correct mimetype
* revert asset-upload config
* reverted domain.constant
* refactor
* fix mime-type issue
* fix format
---------
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2023-06-22 02:33:20 +00:00
"type" : "string"
}
} ,
"required" : [
"assetPath" ,
"deviceAssetId" ,
"deviceId" ,
"fileCreatedAt" ,
2023-11-06 14:04:39 +00:00
"fileModifiedAt"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
feat(server): support for read-only assets and importing existing items in the filesystem (#2715)
* Added read-only flag for assets, endpoint to trigger file import vs upload
* updated fixtures with new property
* if upload is 'read-only', ensure there is no existing asset at the designated originalPath
* added test for file import as well as detecting existing image at read-only destination location
* Added storage service test for a case where it should not move read-only assets
* upload doesn't need the read-only flag available, just importing
* default isReadOnly on import endpoint to true
* formatting fixes
* create-asset dto needs isReadOnly, so set it to false by default on create, updated api generation
* updated code to reflect changes in MR
* fixed read stream promise return type
* new index for originalPath, check for existing path on import, reglardless of user, to prevent duplicates
* refactor: import asset
* chore: open api
* chore: tests
* Added externalPath support for individual users, updated UI to allow this to be set by admin
* added missing var for externalPath in ui
* chore: open api
* fix: compilation issues
* fix: server test
* built api, fixed user-response dto to include externalPath
* reverted accidental commit
* bad commit of duplicate externalPath in user response dto
* fixed tests to include externalPath on expected result
* fix: unit tests
* centralized supported filetypes, perform file type checking of asset and sidecar during file import process
* centralized supported filetype check method to keep regex DRY
* fixed typo
* combined migrations into one
* update api
* Removed externalPath from shared-link code, added column to admin user page whether external paths / import is enabled or not
* update mimetype
* Fixed detect correct mimetype
* revert asset-upload config
* reverted domain.constant
* refactor
* fix mime-type issue
* fix format
---------
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2023-06-22 02:33:20 +00:00
} ,
2023-06-10 04:14:18 +00:00
"JobCommand" : {
"enum" : [
"start" ,
"pause" ,
"resume" ,
"empty"
2023-08-01 16:49:18 +00:00
] ,
"type" : "string"
2023-06-10 04:14:18 +00:00
} ,
"JobCommandDto" : {
"properties" : {
"command" : {
"$ref" : "#/components/schemas/JobCommand"
2023-01-25 16:35:28 +00:00
} ,
2023-06-10 04:14:18 +00:00
"force" : {
"type" : "boolean"
}
} ,
"required" : [
"command" ,
"force"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-06-10 04:14:18 +00:00
} ,
"JobCountsDto" : {
"properties" : {
"active" : {
"type" : "integer"
2023-01-25 16:35:28 +00:00
} ,
2023-06-10 04:14:18 +00:00
"completed" : {
"type" : "integer"
2023-01-25 16:35:28 +00:00
} ,
2023-06-10 04:14:18 +00:00
"delayed" : {
"type" : "integer"
2023-01-21 16:11:55 +00:00
} ,
2023-08-01 16:49:18 +00:00
"failed" : {
2023-06-10 04:14:18 +00:00
"type" : "integer"
2023-01-21 16:11:55 +00:00
} ,
2023-06-10 04:14:18 +00:00
"paused" : {
"type" : "integer"
2023-08-01 16:49:18 +00:00
} ,
"waiting" : {
"type" : "integer"
2023-06-10 04:14:18 +00:00
}
} ,
"required" : [
"active" ,
"completed" ,
"failed" ,
"delayed" ,
"waiting" ,
"paused"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-01-21 16:11:55 +00:00
} ,
2023-06-10 04:14:18 +00:00
"JobName" : {
"enum" : [
"thumbnailGeneration" ,
"metadataExtraction" ,
"videoConversion" ,
"objectTagging" ,
"recognizeFaces" ,
"clipEncoding" ,
"backgroundTask" ,
"storageTemplateMigration" ,
2023-09-25 15:07:21 +00:00
"migration" ,
2023-06-10 04:14:18 +00:00
"search" ,
2023-09-20 11:16:33 +00:00
"sidecar" ,
"library"
2023-08-01 16:49:18 +00:00
] ,
"type" : "string"
2023-06-10 04:14:18 +00:00
} ,
"JobSettingsDto" : {
2023-01-21 16:11:55 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"concurrency" : {
"type" : "integer"
2023-01-21 16:11:55 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"concurrency"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-01-21 16:11:55 +00:00
} ,
2023-06-10 04:14:18 +00:00
"JobStatusDto" : {
2023-01-21 16:11:55 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"jobCounts" : {
"$ref" : "#/components/schemas/JobCountsDto"
} ,
"queueStatus" : {
"$ref" : "#/components/schemas/QueueStatusDto"
2023-01-21 16:11:55 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"jobCounts" ,
"queueStatus"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-01-21 16:11:55 +00:00
} ,
2023-09-20 11:16:33 +00: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"
} ,
"type" : {
"$ref" : "#/components/schemas/LibraryType"
} ,
"updatedAt" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"type" ,
"assetCount" ,
"id" ,
"ownerId" ,
"name" ,
"importPaths" ,
"exclusionPatterns" ,
"createdAt" ,
"updatedAt" ,
"refreshedAt"
] ,
"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" ,
"videos" ,
"total" ,
"usage"
] ,
"type" : "object"
} ,
"LibraryType" : {
"enum" : [
"UPLOAD" ,
"EXTERNAL"
] ,
"type" : "string"
} ,
2023-06-10 04:14:18 +00:00
"LoginCredentialDto" : {
2023-06-01 10:32:51 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"email" : {
2023-08-01 16:49:18 +00:00
"example" : "testuser@email.com" ,
"type" : "string"
2023-06-10 04:14:18 +00:00
} ,
"password" : {
2023-08-01 16:49:18 +00:00
"example" : "password" ,
"type" : "string"
2023-06-01 10:32:51 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"email" ,
"password"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-06-01 10:32:51 +00:00
} ,
2023-06-10 04:14:18 +00:00
"LoginResponseDto" : {
2023-06-01 10:32:51 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"accessToken" : {
2023-08-01 16:49:18 +00:00
"type" : "string"
2023-06-01 10:32:51 +00:00
} ,
2023-08-01 16:49:18 +00:00
"isAdmin" : {
"type" : "boolean"
2023-06-01 10:32:51 +00:00
} ,
2023-11-12 01:03:32 +00:00
"name" : {
2023-08-01 16:49:18 +00:00
"type" : "string"
2023-06-01 10:32:51 +00:00
} ,
2023-06-10 04:14:18 +00:00
"profileImagePath" : {
2023-08-01 16:49:18 +00:00
"type" : "string"
2023-06-01 10:32:51 +00:00
} ,
2023-06-10 04:14:18 +00:00
"shouldChangePassword" : {
2023-08-01 16:49:18 +00:00
"type" : "boolean"
} ,
"userEmail" : {
"type" : "string"
} ,
"userId" : {
"type" : "string"
2023-06-01 10:32:51 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"accessToken" ,
"userId" ,
"userEmail" ,
2023-11-12 01:03:32 +00:00
"name" ,
2023-06-10 04:14:18 +00:00
"profileImagePath" ,
"isAdmin" ,
"shouldChangePassword"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-06-01 10:32:51 +00:00
} ,
2023-06-10 04:14:18 +00:00
"LogoutResponseDto" : {
2023-01-21 16:11:55 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"redirectUri" : {
"type" : "string"
2023-08-01 16:49:18 +00:00
} ,
"successful" : {
"type" : "boolean"
2023-01-21 16:11:55 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"successful" ,
"redirectUri"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-01-21 16:11:55 +00:00
} ,
2023-06-10 04:14:18 +00:00
"MapMarkerResponseDto" : {
2023-01-21 16:11:55 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"id" : {
"type" : "string"
2023-01-21 16:11:55 +00:00
} ,
2023-06-10 04:14:18 +00:00
"lat" : {
2023-08-01 16:49:18 +00:00
"format" : "double" ,
"type" : "number"
2022-12-26 15:35:52 +00:00
} ,
2023-06-10 04:14:18 +00:00
"lon" : {
2023-08-01 16:49:18 +00:00
"format" : "double" ,
"type" : "number"
2022-12-05 17:56:44 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"id" ,
"lat" ,
"lon"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2022-12-05 17:56:44 +00:00
} ,
2023-11-09 16:10:56 +00:00
"MapTheme" : {
"enum" : [
"light" ,
"dark"
] ,
"type" : "string"
} ,
2023-06-15 01:47:18 +00:00
"MemoryLaneResponseDto" : {
"properties" : {
"assets" : {
"items" : {
"$ref" : "#/components/schemas/AssetResponseDto"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
} ,
"title" : {
"type" : "string"
2023-06-15 01:47:18 +00:00
}
} ,
"required" : [
"title" ,
"assets"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-06-15 01:47:18 +00:00
} ,
2023-07-11 21:52:41 +00:00
"MergePersonDto" : {
"properties" : {
"ids" : {
"items" : {
2023-08-01 16:49:18 +00:00
"format" : "uuid" ,
"type" : "string"
} ,
"type" : "array"
2023-07-11 21:52:41 +00:00
}
} ,
"required" : [
"ids"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-07-11 21:52:41 +00:00
} ,
2023-08-29 13:58:00 +00:00
"ModelType" : {
"enum" : [
"image-classification" ,
"facial-recognition" ,
"clip"
] ,
"type" : "string"
} ,
2023-09-01 11:08:42 +00:00
"OAuthAuthorizeResponseDto" : {
"properties" : {
"url" : {
"type" : "string"
}
} ,
"required" : [
"url"
] ,
"type" : "object"
} ,
2023-06-10 04:14:18 +00:00
"OAuthCallbackDto" : {
2023-06-01 01:51:28 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"url" : {
2023-06-01 01:51:28 +00:00
"type" : "string"
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"url"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-06-01 01:51:28 +00:00
} ,
2023-06-10 04:14:18 +00:00
"OAuthConfigDto" : {
2023-06-01 01:51:28 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"redirectUri" : {
2023-06-01 01:51:28 +00:00
"type" : "string"
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"redirectUri"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-06-01 01:51:28 +00:00
} ,
2023-06-10 04:14:18 +00:00
"OAuthConfigResponseDto" : {
2023-06-01 01:51:28 +00:00
"properties" : {
2023-08-01 16:49:18 +00:00
"autoLaunch" : {
"type" : "boolean"
} ,
"buttonText" : {
"type" : "string"
} ,
2023-06-10 04:14:18 +00:00
"enabled" : {
"type" : "boolean"
2023-06-01 01:51:28 +00:00
} ,
2023-06-10 04:14:18 +00:00
"passwordLoginEnabled" : {
2023-06-01 01:51:28 +00:00
"type" : "boolean"
} ,
2023-06-10 04:14:18 +00:00
"url" : {
"type" : "string"
2023-06-01 01:51:28 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"enabled" ,
"passwordLoginEnabled"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-06-01 01:51:28 +00:00
} ,
2023-11-11 21:06:19 +00:00
"PartnerResponseDto" : {
"properties" : {
2023-11-14 03:10:35 +00:00
"avatarColor" : {
"$ref" : "#/components/schemas/UserAvatarColor"
} ,
2023-11-11 21:06:19 +00:00
"createdAt" : {
"format" : "date-time" ,
"type" : "string"
} ,
"deletedAt" : {
"format" : "date-time" ,
"nullable" : true ,
"type" : "string"
} ,
"email" : {
"type" : "string"
} ,
"externalPath" : {
"nullable" : true ,
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"inTimeline" : {
"type" : "boolean"
} ,
"isAdmin" : {
"type" : "boolean"
} ,
"memoriesEnabled" : {
"type" : "boolean"
} ,
2023-11-12 01:03:32 +00:00
"name" : {
"type" : "string"
} ,
2023-11-11 21:06:19 +00:00
"oauthId" : {
"type" : "string"
} ,
"profileImagePath" : {
"type" : "string"
} ,
"shouldChangePassword" : {
"type" : "boolean"
} ,
"storageLabel" : {
"nullable" : true ,
"type" : "string"
} ,
"updatedAt" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
2023-11-14 03:10:35 +00:00
"avatarColor" ,
2023-11-11 21:06:19 +00:00
"id" ,
2023-11-12 01:03:32 +00:00
"name" ,
2023-11-11 21:06:19 +00:00
"email" ,
"profileImagePath" ,
"storageLabel" ,
"externalPath" ,
"shouldChangePassword" ,
"isAdmin" ,
"createdAt" ,
"deletedAt" ,
"updatedAt" ,
"oauthId"
] ,
"type" : "object"
} ,
2023-10-14 17:12:59 +00:00
"PathEntityType" : {
"enum" : [
"asset" ,
"person" ,
"user"
] ,
"type" : "string"
} ,
"PathType" : {
"enum" : [
"original" ,
"jpeg_thumbnail" ,
"webp_thumbnail" ,
"encoded_video" ,
"sidecar" ,
"face" ,
"profile"
] ,
"type" : "string"
} ,
2023-07-18 18:09:43 +00:00
"PeopleResponseDto" : {
"properties" : {
2023-08-01 16:49:18 +00:00
"people" : {
"items" : {
"$ref" : "#/components/schemas/PersonResponseDto"
} ,
"type" : "array"
} ,
2023-07-18 18:09:43 +00:00
"total" : {
2023-08-06 20:55:14 +00:00
"type" : "integer"
2023-07-18 18:09:43 +00:00
} ,
"visible" : {
2023-08-06 20:55:14 +00:00
"type" : "integer"
2023-07-18 18:09:43 +00:00
}
} ,
"required" : [
"total" ,
"visible" ,
"people"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-07-18 18:09:43 +00:00
} ,
2023-07-23 03:00:43 +00:00
"PeopleUpdateDto" : {
"properties" : {
"people" : {
"items" : {
"$ref" : "#/components/schemas/PeopleUpdateItem"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-07-23 03:00:43 +00:00
}
} ,
"required" : [
"people"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-07-23 03:00:43 +00:00
} ,
"PeopleUpdateItem" : {
"properties" : {
2023-08-18 20:10:29 +00:00
"birthDate" : {
2023-09-01 16:40:00 +00:00
"description" : "Person date of birth.\nNote: the mobile app cannot currently set the birth date to null." ,
2023-08-18 20:10:29 +00:00
"format" : "date" ,
"nullable" : true ,
"type" : "string"
} ,
2023-07-23 03:00:43 +00:00
"featureFaceAssetId" : {
2023-08-01 16:49:18 +00:00
"description" : "Asset is used to get the feature face thumbnail." ,
"type" : "string"
} ,
"id" : {
"description" : "Person id." ,
"type" : "string"
2023-07-23 03:00:43 +00:00
} ,
"isHidden" : {
2023-08-01 16:49:18 +00:00
"description" : "Person visibility" ,
"type" : "boolean"
} ,
"name" : {
"description" : "Person name." ,
"type" : "string"
2023-07-23 03:00:43 +00:00
}
} ,
"required" : [
"id"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-07-23 03:00:43 +00:00
} ,
2023-06-10 04:14:18 +00:00
"PersonResponseDto" : {
2022-12-05 17:56:44 +00:00
"properties" : {
2023-08-18 20:10:29 +00:00
"birthDate" : {
"format" : "date" ,
"nullable" : true ,
"type" : "string"
} ,
2023-06-10 04:14:18 +00:00
"id" : {
2023-05-22 03:18:10 +00:00
"type" : "string"
2022-12-05 17:56:44 +00:00
} ,
2023-08-01 16:49:18 +00:00
"isHidden" : {
"type" : "boolean"
} ,
2023-06-10 04:14:18 +00:00
"name" : {
2023-05-22 03:18:10 +00:00
"type" : "string"
2022-12-05 17:56:44 +00:00
} ,
2023-06-10 04:14:18 +00:00
"thumbnailPath" : {
2023-05-22 03:18:10 +00:00
"type" : "string"
2022-12-05 17:56:44 +00:00
}
} ,
"required" : [
2023-08-18 20:10:29 +00:00
"birthDate" ,
2023-06-10 04:14:18 +00:00
"id" ,
"name" ,
2023-07-18 18:09:43 +00:00
"thumbnailPath" ,
"isHidden"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2022-12-05 17:56:44 +00:00
} ,
2023-10-24 15:53:49 +00:00
"PersonStatisticsResponseDto" : {
"properties" : {
"assets" : {
"type" : "integer"
}
} ,
"required" : [
"assets"
] ,
"type" : "object"
} ,
2023-06-10 04:14:18 +00:00
"PersonUpdateDto" : {
2022-12-05 17:56:44 +00:00
"properties" : {
2023-08-18 20:10:29 +00:00
"birthDate" : {
2023-09-01 16:40:00 +00:00
"description" : "Person date of birth.\nNote: the mobile app cannot currently set the birth date to null." ,
2023-08-18 20:10:29 +00:00
"format" : "date" ,
"nullable" : true ,
"type" : "string"
} ,
2023-07-02 22:46:20 +00:00
"featureFaceAssetId" : {
2023-08-01 16:49:18 +00:00
"description" : "Asset is used to get the feature face thumbnail." ,
"type" : "string"
2023-07-18 18:09:43 +00:00
} ,
"isHidden" : {
2023-08-01 16:49:18 +00:00
"description" : "Person visibility" ,
"type" : "boolean"
} ,
"name" : {
"description" : "Person name." ,
"type" : "string"
2022-12-05 17:56:44 +00:00
}
2023-08-01 16:49:18 +00:00
} ,
"type" : "object"
2022-12-05 17:56:44 +00:00
} ,
2023-06-10 04:14:18 +00:00
"QueueStatusDto" : {
2022-12-05 17:56:44 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"isActive" : {
2022-12-05 17:56:44 +00:00
"type" : "boolean"
} ,
2023-06-10 04:14:18 +00:00
"isPaused" : {
2022-12-05 17:56:44 +00:00
"type" : "boolean"
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"isActive" ,
"isPaused"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2022-12-05 17:56:44 +00:00
} ,
2023-11-10 02:32:31 +00:00
"ReactionLevel" : {
"enum" : [
"album" ,
"asset"
] ,
"type" : "string"
} ,
2023-11-01 03:13:34 +00:00
"ReactionType" : {
"enum" : [
"comment" ,
"like"
] ,
"type" : "string"
} ,
2023-08-29 13:58:00 +00:00
"RecognitionConfig" : {
"properties" : {
"enabled" : {
"type" : "boolean"
} ,
"maxDistance" : {
"type" : "integer"
} ,
2023-09-18 04:05:35 +00:00
"minFaces" : {
"type" : "integer"
} ,
2023-08-29 13:58:00 +00:00
"minScore" : {
"type" : "integer"
} ,
"modelName" : {
"type" : "string"
} ,
"modelType" : {
"$ref" : "#/components/schemas/ModelType"
}
} ,
"required" : [
"minScore" ,
"maxDistance" ,
2023-09-18 04:05:35 +00:00
"minFaces" ,
2023-08-29 13:58:00 +00:00
"enabled" ,
"modelName"
] ,
"type" : "object"
} ,
2023-09-20 11:16:33 +00:00
"ScanLibraryDto" : {
"properties" : {
"refreshAllFiles" : {
"default" : false ,
"type" : "boolean"
} ,
"refreshModifiedFiles" : {
"type" : "boolean"
}
} ,
"type" : "object"
} ,
2023-06-10 04:14:18 +00:00
"SearchAlbumResponseDto" : {
2022-12-05 17:56:44 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"count" : {
"type" : "integer"
} ,
2023-08-01 16:49:18 +00:00
"facets" : {
"items" : {
"$ref" : "#/components/schemas/SearchFacetResponseDto"
} ,
"type" : "array"
} ,
2023-06-10 04:14:18 +00:00
"items" : {
"items" : {
"$ref" : "#/components/schemas/AlbumResponseDto"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"total" : {
"type" : "integer"
2022-12-05 17:56:44 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"total" ,
"count" ,
"items" ,
"facets"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2022-12-05 17:56:44 +00:00
} ,
2023-06-10 04:14:18 +00:00
"SearchAssetDto" : {
2023-05-17 17:07:17 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"searchTerm" : {
2023-05-17 17:07:17 +00:00
"type" : "string"
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"searchTerm"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-05-17 17:07:17 +00:00
} ,
2023-06-10 04:14:18 +00:00
"SearchAssetResponseDto" : {
2023-01-12 02:34:36 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"count" : {
"type" : "integer"
2023-02-12 05:54:07 +00:00
} ,
2023-08-01 16:49:18 +00:00
"facets" : {
"items" : {
"$ref" : "#/components/schemas/SearchFacetResponseDto"
} ,
"type" : "array"
} ,
2023-06-10 04:14:18 +00:00
"items" : {
"items" : {
"$ref" : "#/components/schemas/AssetResponseDto"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-02-12 05:54:07 +00:00
} ,
2023-08-01 16:49:18 +00:00
"total" : {
"type" : "integer"
2023-01-12 02:34:36 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"total" ,
"count" ,
"items" ,
"facets"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2022-12-05 17:56:44 +00:00
} ,
2023-06-10 04:14:18 +00:00
"SearchExploreItem" : {
2023-01-25 16:35:28 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"data" : {
"$ref" : "#/components/schemas/AssetResponseDto"
2023-08-01 16:49:18 +00:00
} ,
"value" : {
"type" : "string"
2022-12-05 17:56:44 +00:00
}
2023-01-25 16:35:28 +00:00
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"value" ,
"data"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2022-12-05 17:56:44 +00:00
} ,
2023-06-10 04:14:18 +00:00
"SearchExploreResponseDto" : {
2022-12-05 17:56:44 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"fieldName" : {
2022-12-06 21:46:13 +00:00
"type" : "string"
} ,
2023-06-10 04:14:18 +00:00
"items" : {
"items" : {
"$ref" : "#/components/schemas/SearchExploreItem"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2022-12-05 17:56:44 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"fieldName" ,
"items"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2022-12-05 17:56:44 +00:00
} ,
2023-06-10 04:14:18 +00:00
"SearchFacetCountResponseDto" : {
2022-12-05 17:56:44 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"count" : {
"type" : "integer"
2022-12-05 17:56:44 +00:00
} ,
2023-06-10 04:14:18 +00:00
"value" : {
2022-12-05 17:56:44 +00:00
"type" : "string"
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"count" ,
"value"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-01-25 16:35:28 +00:00
} ,
2023-06-10 04:14:18 +00:00
"SearchFacetResponseDto" : {
2023-01-25 16:35:28 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"counts" : {
"items" : {
"$ref" : "#/components/schemas/SearchFacetCountResponseDto"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
} ,
"fieldName" : {
"type" : "string"
2023-01-25 16:35:28 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"fieldName" ,
"counts"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2022-12-05 17:56:44 +00:00
} ,
2023-06-10 04:14:18 +00:00
"SearchResponseDto" : {
2022-12-05 17:56:44 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"albums" : {
"$ref" : "#/components/schemas/SearchAlbumResponseDto"
2023-06-04 02:41:27 +00:00
} ,
2023-06-10 04:14:18 +00:00
"assets" : {
"$ref" : "#/components/schemas/SearchAssetResponseDto"
2022-12-05 17:56:44 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"albums" ,
"assets"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2022-12-05 17:56:44 +00:00
} ,
2023-09-09 02:51:46 +00:00
"ServerConfigDto" : {
"properties" : {
2023-10-11 02:37:13 +00:00
"isInitialized" : {
"type" : "boolean"
} ,
2023-09-09 02:51:46 +00:00
"loginPageMessage" : {
"type" : "string"
} ,
"oauthButtonText" : {
"type" : "string"
2023-10-06 07:01:14 +00:00
} ,
"trashDays" : {
"type" : "integer"
2023-09-09 02:51:46 +00:00
}
} ,
"required" : [
2023-10-06 07:01:14 +00:00
"trashDays" ,
2023-09-09 02:51:46 +00:00
"oauthButtonText" ,
"loginPageMessage" ,
2023-10-11 02:37:13 +00:00
"isInitialized"
2023-09-09 02:51:46 +00:00
] ,
"type" : "object"
} ,
2023-08-18 04:55:26 +00:00
"ServerFeaturesDto" : {
"properties" : {
2023-08-25 04:15:03 +00:00
"clipEncode" : {
"type" : "boolean"
} ,
2023-08-25 17:44:52 +00:00
"configFile" : {
"type" : "boolean"
} ,
2023-08-25 04:15:03 +00:00
"facialRecognition" : {
2023-08-18 04:55:26 +00:00
"type" : "boolean"
} ,
2023-09-09 02:51:46 +00:00
"map" : {
"type" : "boolean"
} ,
2023-08-18 04:55:26 +00:00
"oauth" : {
"type" : "boolean"
} ,
"oauthAutoLaunch" : {
"type" : "boolean"
} ,
"passwordLogin" : {
"type" : "boolean"
} ,
2023-09-26 07:03:57 +00:00
"reverseGeocoding" : {
"type" : "boolean"
} ,
2023-08-18 04:55:26 +00:00
"search" : {
"type" : "boolean"
2023-08-25 04:15:03 +00:00
} ,
"sidecar" : {
"type" : "boolean"
} ,
"tagImage" : {
"type" : "boolean"
2023-10-06 07:01:14 +00:00
} ,
"trash" : {
"type" : "boolean"
2023-08-18 04:55:26 +00:00
}
} ,
"required" : [
2023-08-25 04:15:03 +00:00
"clipEncode" ,
2023-09-09 02:51:46 +00:00
"configFile" ,
2023-08-25 04:15:03 +00:00
"facialRecognition" ,
2023-09-09 02:51:46 +00:00
"map" ,
2023-10-06 07:01:14 +00:00
"trash" ,
2023-09-26 07:03:57 +00:00
"reverseGeocoding" ,
2023-08-18 04:55:26 +00:00
"oauth" ,
"oauthAutoLaunch" ,
2023-09-09 02:51:46 +00:00
"passwordLogin" ,
"sidecar" ,
"search" ,
"tagImage"
2023-08-18 04:55:26 +00:00
] ,
"type" : "object"
} ,
2023-06-10 04:14:18 +00:00
"ServerInfoResponseDto" : {
2022-12-05 17:56:44 +00:00
"properties" : {
2023-08-01 16:49:18 +00:00
"diskAvailable" : {
"type" : "string"
2023-06-10 04:14:18 +00:00
} ,
"diskAvailableRaw" : {
2023-08-01 16:49:18 +00:00
"format" : "int64" ,
"type" : "integer"
2023-06-10 04:14:18 +00:00
} ,
"diskSize" : {
2022-12-05 17:56:44 +00:00
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"diskSizeRaw" : {
"format" : "int64" ,
"type" : "integer"
} ,
"diskUsagePercentage" : {
"format" : "float" ,
"type" : "number"
} ,
2023-06-10 04:14:18 +00:00
"diskUse" : {
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"diskUseRaw" : {
"format" : "int64" ,
"type" : "integer"
2022-12-05 17:56:44 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"diskSizeRaw" ,
"diskUseRaw" ,
"diskAvailableRaw" ,
"diskUsagePercentage" ,
"diskSize" ,
"diskUse" ,
"diskAvailable"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2022-12-05 17:56:44 +00:00
} ,
2023-07-16 01:24:46 +00:00
"ServerMediaTypesResponseDto" : {
"properties" : {
2023-08-01 16:49:18 +00:00
"image" : {
2023-07-16 01:24:46 +00:00
"items" : {
"type" : "string"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-07-16 01:24:46 +00:00
} ,
2023-08-01 16:49:18 +00:00
"sidecar" : {
2023-07-16 01:24:46 +00:00
"items" : {
"type" : "string"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-07-16 01:24:46 +00:00
} ,
2023-08-01 16:49:18 +00:00
"video" : {
2023-07-16 01:24:46 +00:00
"items" : {
"type" : "string"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-07-16 01:24:46 +00:00
}
} ,
"required" : [
"video" ,
"image" ,
"sidecar"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-07-16 01:24:46 +00:00
} ,
2023-06-10 04:14:18 +00:00
"ServerPingResponse" : {
2022-12-05 17:56:44 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"res" : {
2023-08-01 16:49:18 +00:00
"example" : "pong" ,
2023-06-10 04:14:18 +00:00
"readOnly" : true ,
2023-08-01 16:49:18 +00:00
"type" : "string"
2022-12-05 17:56:44 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"res"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2022-12-05 17:56:44 +00:00
} ,
2023-06-10 04:14:18 +00:00
"ServerStatsResponseDto" : {
2022-12-05 17:56:44 +00:00
"properties" : {
"photos" : {
2023-08-01 16:49:18 +00:00
"default" : 0 ,
"type" : "integer"
2022-12-05 17:56:44 +00:00
} ,
2023-06-10 04:14:18 +00:00
"usage" : {
"default" : 0 ,
2023-08-01 16:49:18 +00:00
"format" : "int64" ,
"type" : "integer"
2022-12-05 17:56:44 +00:00
} ,
2023-06-10 04:14:18 +00:00
"usageByUser" : {
"default" : [ ] ,
"example" : [
{
"photos" : 1 ,
"videos" : 1 ,
"diskUsageRaw" : 1
}
] ,
"items" : {
"$ref" : "#/components/schemas/UsageByUserDto"
2023-08-01 16:49:18 +00:00
} ,
"title" : "Array of usage for each user" ,
"type" : "array"
} ,
"videos" : {
"default" : 0 ,
"type" : "integer"
2022-12-05 17:56:44 +00:00
}
} ,
"required" : [
"photos" ,
"videos" ,
2023-06-10 04:14:18 +00:00
"usage" ,
"usageByUser"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2022-12-05 17:56:44 +00:00
} ,
2023-10-25 22:13:05 +00:00
"ServerThemeDto" : {
"properties" : {
2023-10-27 02:32:33 +00:00
"customCss" : {
"type" : "string"
2023-10-25 22:13:05 +00:00
}
} ,
"required" : [
2023-10-27 02:32:33 +00:00
"customCss"
2023-10-25 22:13:05 +00:00
] ,
"type" : "object"
} ,
2023-08-18 04:55:26 +00:00
"ServerVersionResponseDto" : {
2022-12-05 17:56:44 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"major" : {
"type" : "integer"
2023-05-15 17:30:53 +00:00
} ,
2023-06-10 04:14:18 +00:00
"minor" : {
"type" : "integer"
2023-05-25 02:13:02 +00:00
} ,
2023-06-10 04:14:18 +00:00
"patch" : {
"type" : "integer"
2022-12-05 17:56:44 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"major" ,
"minor" ,
"patch"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2022-12-05 17:56:44 +00:00
} ,
2023-06-21 01:08:43 +00:00
"SharedLinkCreateDto" : {
"properties" : {
2023-08-01 16:49:18 +00:00
"albumId" : {
"format" : "uuid" ,
"type" : "string"
} ,
"allowDownload" : {
"default" : true ,
"type" : "boolean"
} ,
"allowUpload" : {
"default" : false ,
"type" : "boolean"
2023-06-21 01:08:43 +00:00
} ,
"assetIds" : {
"items" : {
2023-08-01 16:49:18 +00:00
"format" : "uuid" ,
"type" : "string"
} ,
"type" : "array"
2023-06-21 01:08:43 +00:00
} ,
"description" : {
"type" : "string"
} ,
"expiresAt" : {
2023-08-01 16:49:18 +00:00
"default" : null ,
2023-06-21 01:08:43 +00:00
"format" : "date-time" ,
"nullable" : true ,
2023-08-01 16:49:18 +00:00
"type" : "string"
2023-06-21 01:08:43 +00:00
} ,
2023-10-29 01:35:38 +00:00
"password" : {
"type" : "string"
} ,
2023-10-14 01:46:30 +00:00
"showMetadata" : {
2023-08-01 16:49:18 +00:00
"default" : true ,
"type" : "boolean"
} ,
"type" : {
"$ref" : "#/components/schemas/SharedLinkType"
2023-06-21 01:08:43 +00:00
}
} ,
"required" : [
"type"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-06-21 01:08:43 +00:00
} ,
"SharedLinkEditDto" : {
"properties" : {
2023-08-01 16:49:18 +00:00
"allowDownload" : {
"type" : "boolean"
} ,
"allowUpload" : {
"type" : "boolean"
} ,
2023-10-22 15:05:10 +00: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 01:08:43 +00:00
"description" : {
"type" : "string"
} ,
"expiresAt" : {
"format" : "date-time" ,
2023-08-01 16:49:18 +00:00
"nullable" : true ,
"type" : "string"
2023-06-21 01:08:43 +00:00
} ,
2023-10-29 01:35:38 +00:00
"password" : {
"type" : "string"
} ,
2023-10-14 01:46:30 +00:00
"showMetadata" : {
2023-06-21 01:08:43 +00:00
"type" : "boolean"
}
2023-08-01 16:49:18 +00:00
} ,
"type" : "object"
2023-06-21 01:08:43 +00:00
} ,
2023-06-10 04:14:18 +00:00
"SharedLinkResponseDto" : {
2022-12-05 17:56:44 +00:00
"properties" : {
2023-08-01 16:49:18 +00:00
"album" : {
"$ref" : "#/components/schemas/AlbumResponseDto"
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"allowDownload" : {
"type" : "boolean"
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"allowUpload" : {
"type" : "boolean"
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"assets" : {
"items" : {
"$ref" : "#/components/schemas/AssetResponseDto"
} ,
"type" : "array"
2023-06-10 04:14:18 +00:00
} ,
"createdAt" : {
"format" : "date-time" ,
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"description" : {
"nullable" : true ,
"type" : "string"
} ,
2023-06-10 04:14:18 +00:00
"expiresAt" : {
"format" : "date-time" ,
2023-08-01 16:49:18 +00:00
"nullable" : true ,
"type" : "string"
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"id" : {
"type" : "string"
2022-12-05 17:56:44 +00:00
} ,
2023-08-01 16:49:18 +00:00
"key" : {
"type" : "string"
2023-06-10 04:14:18 +00:00
} ,
2023-10-29 01:35:38 +00:00
"password" : {
"nullable" : true ,
"type" : "string"
} ,
2023-10-14 01:46:30 +00:00
"showMetadata" : {
2022-12-05 17:56:44 +00:00
"type" : "boolean"
2023-04-12 15:37:52 +00:00
} ,
2023-10-29 01:35:38 +00:00
"token" : {
"nullable" : true ,
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"type" : {
"$ref" : "#/components/schemas/SharedLinkType"
2023-04-13 15:22:06 +00:00
} ,
2023-08-01 16:49:18 +00:00
"userId" : {
"type" : "string"
2022-12-05 17:56:44 +00:00
}
2023-06-10 04:14:18 +00:00
} ,
"required" : [
"type" ,
"id" ,
2023-06-21 01:08:43 +00:00
"description" ,
2023-10-29 01:35:38 +00:00
"password" ,
2023-06-10 04:14:18 +00:00
"userId" ,
"key" ,
"createdAt" ,
"expiresAt" ,
"assets" ,
"allowUpload" ,
"allowDownload" ,
2023-10-14 01:46:30 +00:00
"showMetadata"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-06-10 04:14:18 +00:00
} ,
"SharedLinkType" : {
"enum" : [
"ALBUM" ,
"INDIVIDUAL"
2023-08-01 16:49:18 +00:00
] ,
"type" : "string"
2023-06-10 04:14:18 +00:00
} ,
"SignUpDto" : {
"properties" : {
"email" : {
2023-08-01 16:49:18 +00:00
"example" : "testuser@email.com" ,
"type" : "string"
2023-06-10 04:14:18 +00:00
} ,
2023-11-12 01:03:32 +00:00
"name" : {
2023-08-01 16:49:18 +00:00
"example" : "Admin" ,
"type" : "string"
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"password" : {
"example" : "password" ,
"type" : "string"
2023-06-10 04:14:18 +00:00
}
} ,
"required" : [
"email" ,
"password" ,
2023-11-12 01:03:32 +00:00
"name"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2022-12-05 17:56:44 +00:00
} ,
2023-06-10 04:14:18 +00:00
"SmartInfoResponseDto" : {
2022-12-05 17:56:44 +00:00
"properties" : {
2023-08-01 16:49:18 +00:00
"objects" : {
2023-06-10 04:14:18 +00:00
"items" : {
"type" : "string"
2023-08-01 16:49:18 +00:00
} ,
2023-06-10 04:14:18 +00:00
"nullable" : true ,
2023-08-01 16:49:18 +00:00
"type" : "array"
} ,
"tags" : {
2022-12-05 17:56:44 +00:00
"items" : {
"type" : "string"
2023-08-01 16:49:18 +00:00
} ,
"nullable" : true ,
"type" : "array"
2022-12-05 17:56:44 +00:00
}
2023-08-01 16:49:18 +00:00
} ,
"type" : "object"
2022-12-05 17:56:44 +00:00
} ,
2023-06-10 04:14:18 +00:00
"SystemConfigDto" : {
2022-12-05 17:56:44 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"ffmpeg" : {
"$ref" : "#/components/schemas/SystemConfigFFmpegDto"
2022-12-05 17:56:44 +00:00
} ,
2023-08-01 16:49:18 +00:00
"job" : {
"$ref" : "#/components/schemas/SystemConfigJobDto"
} ,
2023-10-31 20:19:12 +00:00
"library" : {
"$ref" : "#/components/schemas/SystemConfigLibraryDto"
} ,
2023-08-25 04:15:03 +00:00
"machineLearning" : {
"$ref" : "#/components/schemas/SystemConfigMachineLearningDto"
} ,
2023-09-09 02:51:46 +00:00
"map" : {
"$ref" : "#/components/schemas/SystemConfigMapDto"
} ,
2023-10-24 15:05:42 +00:00
"newVersionCheck" : {
"$ref" : "#/components/schemas/SystemConfigNewVersionCheckDto"
} ,
2023-06-10 04:14:18 +00:00
"oauth" : {
"$ref" : "#/components/schemas/SystemConfigOAuthDto"
} ,
"passwordLogin" : {
"$ref" : "#/components/schemas/SystemConfigPasswordLoginDto"
} ,
2023-09-26 07:03:57 +00:00
"reverseGeocoding" : {
"$ref" : "#/components/schemas/SystemConfigReverseGeocodingDto"
} ,
2023-06-10 04:14:18 +00:00
"storageTemplate" : {
"$ref" : "#/components/schemas/SystemConfigStorageTemplateDto"
2023-08-08 14:39:51 +00:00
} ,
2023-10-23 18:38:41 +00:00
"theme" : {
"$ref" : "#/components/schemas/SystemConfigThemeDto"
} ,
2023-08-08 14:39:51 +00:00
"thumbnail" : {
"$ref" : "#/components/schemas/SystemConfigThumbnailDto"
2023-10-06 07:01:14 +00:00
} ,
"trash" : {
"$ref" : "#/components/schemas/SystemConfigTrashDto"
2022-12-05 17:56:44 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"ffmpeg" ,
2023-08-25 04:15:03 +00:00
"machineLearning" ,
2023-09-09 02:51:46 +00:00
"map" ,
2023-10-24 15:05:42 +00:00
"newVersionCheck" ,
2023-06-10 04:14:18 +00:00
"oauth" ,
"passwordLogin" ,
2023-09-26 07:03:57 +00:00
"reverseGeocoding" ,
2023-06-10 04:14:18 +00:00
"storageTemplate" ,
2023-08-08 14:39:51 +00:00
"job" ,
2023-10-06 07:01:14 +00:00
"thumbnail" ,
2023-10-23 18:38:41 +00:00
"trash" ,
2023-10-31 20:19:12 +00:00
"theme" ,
"library"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2022-12-05 17:56:44 +00:00
} ,
2023-06-10 04:14:18 +00:00
"SystemConfigFFmpegDto" : {
2022-12-05 17:56:44 +00:00
"properties" : {
2023-08-02 01:56:10 +00:00
"accel" : {
"$ref" : "#/components/schemas/TranscodeHWAccel"
} ,
2023-09-03 01:22:42 +00:00
"bframes" : {
"type" : "integer"
} ,
"cqMode" : {
"$ref" : "#/components/schemas/CQMode"
} ,
2023-06-10 04:14:18 +00:00
"crf" : {
"type" : "integer"
} ,
2023-09-03 01:22:42 +00:00
"gopSize" : {
"type" : "integer"
} ,
2023-08-01 16:49:18 +00:00
"maxBitrate" : {
"type" : "string"
2023-06-10 04:14:18 +00:00
} ,
2023-09-03 01:22:42 +00:00
"npl" : {
"type" : "integer"
} ,
2023-08-01 16:49:18 +00:00
"preset" : {
"type" : "string"
2023-06-10 04:14:18 +00:00
} ,
2023-09-03 01:22:42 +00:00
"refs" : {
"type" : "integer"
} ,
2023-06-10 04:14:18 +00:00
"targetAudioCodec" : {
2023-07-09 02:43:11 +00:00
"$ref" : "#/components/schemas/AudioCodec"
} ,
2023-06-10 04:14:18 +00:00
"targetResolution" : {
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"targetVideoCodec" : {
"$ref" : "#/components/schemas/VideoCodec"
} ,
2023-09-03 01:22:42 +00:00
"temporalAQ" : {
"type" : "boolean"
} ,
2023-08-01 16:49:18 +00:00
"threads" : {
"type" : "integer"
} ,
2023-08-07 20:35:25 +00:00
"tonemap" : {
"$ref" : "#/components/schemas/ToneMapping"
} ,
2023-08-01 16:49:18 +00:00
"transcode" : {
"$ref" : "#/components/schemas/TranscodePolicy"
2023-06-10 04:14:18 +00:00
} ,
"twoPass" : {
"type" : "boolean"
2022-12-05 17:56:44 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"crf" ,
"threads" ,
"targetVideoCodec" ,
"targetAudioCodec" ,
2023-09-03 01:22:42 +00:00
"bframes" ,
"refs" ,
"gopSize" ,
"npl" ,
"cqMode" ,
2023-07-09 02:43:11 +00:00
"transcode" ,
2023-08-02 01:56:10 +00:00
"accel" ,
2023-08-07 20:35:25 +00:00
"tonemap" ,
2023-07-09 02:43:11 +00:00
"preset" ,
2023-06-10 04:14:18 +00:00
"targetResolution" ,
"maxBitrate" ,
2023-09-03 01:22:42 +00:00
"temporalAQ" ,
2023-07-09 02:43:11 +00:00
"twoPass"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2022-12-05 17:56:44 +00:00
} ,
2023-06-10 04:14:18 +00:00
"SystemConfigJobDto" : {
2022-12-05 17:56:44 +00:00
"properties" : {
2023-08-01 16:49:18 +00:00
"backgroundTask" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/JobSettingsDto"
2022-12-05 17:56:44 +00:00
} ,
2023-08-01 16:49:18 +00:00
"clipEncoding" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/JobSettingsDto"
} ,
2023-09-20 11:16:33 +00:00
"library" : {
"$ref" : "#/components/schemas/JobSettingsDto"
} ,
2023-08-01 16:49:18 +00:00
"metadataExtraction" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/JobSettingsDto"
} ,
2023-09-25 15:07:21 +00:00
"migration" : {
"$ref" : "#/components/schemas/JobSettingsDto"
} ,
2023-06-10 04:14:18 +00:00
"objectTagging" : {
"$ref" : "#/components/schemas/JobSettingsDto"
} ,
2023-08-01 16:49:18 +00:00
"recognizeFaces" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/JobSettingsDto"
} ,
2023-08-01 16:49:18 +00:00
"search" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/JobSettingsDto"
} ,
2023-08-01 16:49:18 +00:00
"sidecar" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/JobSettingsDto"
} ,
2023-08-01 16:49:18 +00:00
"storageTemplateMigration" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/JobSettingsDto"
} ,
2023-08-01 16:49:18 +00:00
"thumbnailGeneration" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/JobSettingsDto"
} ,
2023-08-01 16:49:18 +00:00
"videoConversion" : {
2023-06-10 04:14:18 +00:00
"$ref" : "#/components/schemas/JobSettingsDto"
2022-12-05 17:56:44 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"thumbnailGeneration" ,
"metadataExtraction" ,
"videoConversion" ,
"objectTagging" ,
"clipEncoding" ,
"storageTemplateMigration" ,
2023-09-25 15:07:21 +00:00
"migration" ,
2023-06-10 04:14:18 +00:00
"backgroundTask" ,
"search" ,
"recognizeFaces" ,
2023-09-20 11:16:33 +00:00
"sidecar" ,
"library"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2022-12-05 17:56:44 +00:00
} ,
2023-10-31 20:19:12 +00:00
"SystemConfigLibraryDto" : {
"properties" : {
"scan" : {
"$ref" : "#/components/schemas/SystemConfigLibraryScanDto"
}
} ,
"required" : [
"scan"
] ,
"type" : "object"
} ,
"SystemConfigLibraryScanDto" : {
"properties" : {
"cronExpression" : {
"type" : "string"
} ,
"enabled" : {
"type" : "boolean"
}
} ,
"required" : [
"enabled" ,
"cronExpression"
] ,
"type" : "object"
} ,
2023-08-25 04:15:03 +00:00
"SystemConfigMachineLearningDto" : {
"properties" : {
2023-08-29 13:58:00 +00:00
"classification" : {
"$ref" : "#/components/schemas/ClassificationConfig"
2023-08-25 04:15:03 +00:00
} ,
2023-08-29 13:58:00 +00:00
"clip" : {
"$ref" : "#/components/schemas/CLIPConfig"
2023-08-25 04:15:03 +00:00
} ,
2023-08-29 13:58:00 +00:00
"enabled" : {
2023-08-25 04:15:03 +00:00
"type" : "boolean"
} ,
2023-08-29 13:58:00 +00:00
"facialRecognition" : {
"$ref" : "#/components/schemas/RecognitionConfig"
2023-08-25 04:15:03 +00:00
} ,
"url" : {
"type" : "string"
}
} ,
"required" : [
"enabled" ,
"url" ,
2023-08-29 13:58:00 +00:00
"classification" ,
"clip" ,
"facialRecognition"
2023-08-25 04:15:03 +00:00
] ,
"type" : "object"
} ,
2023-09-09 02:51:46 +00:00
"SystemConfigMapDto" : {
"properties" : {
2023-11-09 16:10:56 +00:00
"darkStyle" : {
"type" : "string"
} ,
2023-09-09 02:51:46 +00:00
"enabled" : {
"type" : "boolean"
} ,
2023-11-09 16:10:56 +00:00
"lightStyle" : {
2023-09-09 02:51:46 +00:00
"type" : "string"
}
} ,
"required" : [
"enabled" ,
2023-11-09 16:10:56 +00:00
"lightStyle" ,
"darkStyle"
2023-09-09 02:51:46 +00:00
] ,
"type" : "object"
} ,
2023-10-24 15:05:42 +00:00
"SystemConfigNewVersionCheckDto" : {
"properties" : {
"enabled" : {
"type" : "boolean"
}
} ,
"required" : [
"enabled"
] ,
"type" : "object"
} ,
2023-06-10 04:14:18 +00:00
"SystemConfigOAuthDto" : {
2022-12-05 17:56:44 +00:00
"properties" : {
2023-08-01 16:49:18 +00:00
"autoLaunch" : {
2023-06-10 04:14:18 +00:00
"type" : "boolean"
2022-12-05 17:56:44 +00:00
} ,
2023-08-01 16:49:18 +00:00
"autoRegister" : {
"type" : "boolean"
} ,
"buttonText" : {
2023-06-10 04:14:18 +00:00
"type" : "string"
} ,
"clientId" : {
"type" : "string"
} ,
"clientSecret" : {
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"enabled" : {
2023-06-10 04:14:18 +00:00
"type" : "boolean"
} ,
2023-08-01 16:49:18 +00:00
"issuerUrl" : {
"type" : "string"
2023-06-10 04:14:18 +00:00
} ,
"mobileOverrideEnabled" : {
"type" : "boolean"
} ,
"mobileRedirectUri" : {
2022-12-05 17:56:44 +00:00
"type" : "string"
2023-08-01 16:49:18 +00:00
} ,
"scope" : {
"type" : "string"
} ,
"storageLabelClaim" : {
"type" : "string"
2022-12-05 17:56:44 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"enabled" ,
"issuerUrl" ,
"clientId" ,
"clientSecret" ,
"scope" ,
2023-07-15 19:50:29 +00:00
"storageLabelClaim" ,
2023-06-10 04:14:18 +00:00
"buttonText" ,
"autoRegister" ,
"autoLaunch" ,
"mobileOverrideEnabled" ,
"mobileRedirectUri"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2022-12-05 17:56:44 +00:00
} ,
2023-06-10 04:14:18 +00:00
"SystemConfigPasswordLoginDto" : {
2022-12-05 17:56:44 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"enabled" : {
"type" : "boolean"
2022-12-05 17:56:44 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"enabled"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2022-12-05 17:56:44 +00:00
} ,
2023-09-26 07:03:57 +00:00
"SystemConfigReverseGeocodingDto" : {
"properties" : {
"citiesFileOverride" : {
"$ref" : "#/components/schemas/CitiesFile"
} ,
"enabled" : {
"type" : "boolean"
}
} ,
"required" : [
"citiesFileOverride" ,
"enabled"
] ,
"type" : "object"
} ,
2023-06-10 04:14:18 +00:00
"SystemConfigStorageTemplateDto" : {
2023-05-24 21:08:21 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"template" : {
2023-05-24 21:08:21 +00:00
"type" : "string"
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"template"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-05-24 21:08:21 +00:00
} ,
2023-06-10 04:14:18 +00:00
"SystemConfigTemplateStorageOptionDto" : {
2023-05-24 21:08:21 +00:00
"properties" : {
2023-08-01 16:49:18 +00:00
"dayOptions" : {
2023-05-24 21:08:21 +00:00
"items" : {
2023-06-10 04:14:18 +00:00
"type" : "string"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"hourOptions" : {
2023-06-10 04:14:18 +00:00
"items" : {
"type" : "string"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"minuteOptions" : {
2023-06-10 04:14:18 +00:00
"items" : {
"type" : "string"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"monthOptions" : {
2023-06-10 04:14:18 +00:00
"items" : {
"type" : "string"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-06-10 04:14:18 +00:00
} ,
2023-08-01 16:49:18 +00:00
"presetOptions" : {
2023-06-10 04:14:18 +00:00
"items" : {
"type" : "string"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-06-10 04:14:18 +00:00
} ,
"secondOptions" : {
"items" : {
"type" : "string"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-06-10 04:14:18 +00:00
} ,
2023-09-28 17:47:31 +00:00
"weekOptions" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
2023-08-01 16:49:18 +00:00
"yearOptions" : {
2023-06-10 04:14:18 +00:00
"items" : {
"type" : "string"
2023-08-01 16:49:18 +00:00
} ,
"type" : "array"
2023-05-24 21:08:21 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"yearOptions" ,
"monthOptions" ,
2023-09-28 17:47:31 +00:00
"weekOptions" ,
2023-06-10 04:14:18 +00:00
"dayOptions" ,
"hourOptions" ,
"minuteOptions" ,
"secondOptions" ,
"presetOptions"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-05-24 21:08:21 +00:00
} ,
2023-10-23 18:38:41 +00:00
"SystemConfigThemeDto" : {
"properties" : {
"customCss" : {
"type" : "string"
}
} ,
"required" : [
"customCss"
] ,
"type" : "object"
} ,
2023-08-08 14:39:51 +00:00
"SystemConfigThumbnailDto" : {
"properties" : {
2023-09-03 06:21:51 +00:00
"colorspace" : {
"$ref" : "#/components/schemas/Colorspace"
} ,
2023-08-08 14:39:51 +00:00
"jpegSize" : {
"type" : "integer"
} ,
2023-09-03 06:21:51 +00:00
"quality" : {
"type" : "integer"
} ,
2023-08-08 14:39:51 +00:00
"webpSize" : {
"type" : "integer"
}
} ,
"required" : [
"webpSize" ,
2023-09-03 06:21:51 +00:00
"jpegSize" ,
"quality" ,
"colorspace"
2023-08-08 14:39:51 +00:00
] ,
"type" : "object"
} ,
2023-10-06 07:01:14 +00:00
"SystemConfigTrashDto" : {
"properties" : {
"days" : {
"type" : "integer"
} ,
"enabled" : {
"type" : "boolean"
}
} ,
"required" : [
"days" ,
"enabled"
] ,
"type" : "object"
} ,
2023-06-10 04:14:18 +00:00
"TagResponseDto" : {
2023-05-24 21:08:21 +00:00
"properties" : {
"id" : {
"type" : "string"
} ,
2023-06-10 04:14:18 +00:00
"name" : {
"type" : "string"
2023-05-24 21:08:21 +00:00
} ,
2023-08-01 16:49:18 +00:00
"type" : {
"$ref" : "#/components/schemas/TagTypeEnum"
} ,
2023-06-10 04:14:18 +00:00
"userId" : {
2023-05-24 21:08:21 +00:00
"type" : "string"
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"type" ,
2023-05-24 21:08:21 +00:00
"id" ,
2023-06-10 04:14:18 +00:00
"name" ,
"userId"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-05-24 21:08:21 +00:00
} ,
2023-06-10 04:14:18 +00:00
"TagTypeEnum" : {
"enum" : [
"OBJECT" ,
"FACE" ,
"CUSTOM"
2023-08-01 16:49:18 +00:00
] ,
"type" : "string"
2023-06-10 04:14:18 +00:00
} ,
"ThumbnailFormat" : {
"enum" : [
"JPEG" ,
"WEBP"
2023-08-01 16:49:18 +00:00
] ,
"type" : "string"
2023-06-10 04:14:18 +00:00
} ,
2023-08-04 21:07:15 +00:00
"TimeBucketResponseDto" : {
"properties" : {
"count" : {
"type" : "integer"
} ,
"timeBucket" : {
"type" : "string"
}
} ,
"required" : [
"timeBucket" ,
"count"
] ,
"type" : "object"
} ,
"TimeBucketSize" : {
2023-06-10 04:14:18 +00:00
"enum" : [
2023-08-04 21:07:15 +00:00
"DAY" ,
"MONTH"
2023-08-01 16:49:18 +00:00
] ,
"type" : "string"
2023-08-07 20:35:25 +00:00
} ,
"ToneMapping" : {
"enum" : [
"hable" ,
"mobius" ,
"reinhard" ,
"disabled"
] ,
"type" : "string"
2023-06-10 04:14:18 +00:00
} ,
2023-08-02 01:56:10 +00:00
"TranscodeHWAccel" : {
"enum" : [
"nvenc" ,
"qsv" ,
"vaapi" ,
2023-10-30 14:39:37 +00:00
"rkmpp" ,
2023-08-02 01:56:10 +00:00
"disabled"
] ,
"type" : "string"
} ,
2023-07-09 02:43:11 +00:00
"TranscodePolicy" : {
"enum" : [
"all" ,
"optimal" ,
"required" ,
"disabled"
2023-08-01 16:49:18 +00:00
] ,
"type" : "string"
2023-07-09 02:43:11 +00:00
} ,
2023-06-10 04:14:18 +00:00
"UpdateAlbumDto" : {
2023-05-24 21:08:21 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"albumName" : {
"type" : "string"
} ,
"albumThumbnailAssetId" : {
2023-08-01 16:49:18 +00:00
"format" : "uuid" ,
"type" : "string"
2023-08-06 02:43:26 +00:00
} ,
"description" : {
"type" : "string"
2023-11-07 04:37:21 +00:00
} ,
"isActivityEnabled" : {
"type" : "boolean"
2023-05-24 21:08:21 +00:00
}
2023-08-01 16:49:18 +00:00
} ,
"type" : "object"
2023-05-24 21:08:21 +00:00
} ,
2023-06-10 04:14:18 +00:00
"UpdateAssetDto" : {
2023-01-15 05:49:47 +00:00
"properties" : {
2023-08-01 16:49:18 +00:00
"description" : {
"type" : "string"
} ,
"isArchived" : {
"type" : "boolean"
} ,
"isFavorite" : {
"type" : "boolean"
2023-01-15 05:49:47 +00:00
}
2023-08-01 16:49:18 +00:00
} ,
"type" : "object"
2023-01-15 05:49:47 +00:00
} ,
2023-09-20 11:16:33 +00:00
"UpdateLibraryDto" : {
"properties" : {
"exclusionPatterns" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"importPaths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"isVisible" : {
"type" : "boolean"
} ,
"name" : {
"type" : "string"
}
} ,
"type" : "object"
} ,
2023-11-11 21:06:19 +00:00
"UpdatePartnerDto" : {
"properties" : {
"inTimeline" : {
"type" : "boolean"
}
} ,
"required" : [
"inTimeline"
] ,
"type" : "object"
} ,
2023-10-22 02:38:07 +00:00
"UpdateStackParentDto" : {
"properties" : {
"newParentId" : {
"format" : "uuid" ,
"type" : "string"
} ,
"oldParentId" : {
"format" : "uuid" ,
"type" : "string"
}
} ,
"required" : [
"oldParentId" ,
"newParentId"
] ,
"type" : "object"
} ,
2023-06-10 04:14:18 +00:00
"UpdateTagDto" : {
2023-02-15 21:21:22 +00:00
"properties" : {
2023-06-10 04:14:18 +00:00
"name" : {
"type" : "string"
2023-02-15 21:21:22 +00:00
}
2023-08-01 16:49:18 +00:00
} ,
"type" : "object"
2023-02-15 21:21:22 +00:00
} ,
2023-06-10 04:14:18 +00:00
"UpdateUserDto" : {
2023-01-15 05:49:47 +00:00
"properties" : {
2023-11-14 03:10:35 +00:00
"avatarColor" : {
"$ref" : "#/components/schemas/UserAvatarColor"
} ,
2023-06-10 04:14:18 +00:00
"email" : {
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"externalPath" : {
2023-06-10 04:14:18 +00:00
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"id" : {
"format" : "uuid" ,
2023-06-10 04:14:18 +00:00
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"isAdmin" : {
"type" : "boolean"
2023-06-10 04:14:18 +00:00
} ,
2023-08-10 02:01:16 +00:00
"memoriesEnabled" : {
"type" : "boolean"
} ,
2023-11-12 01:03:32 +00:00
"name" : {
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"password" : {
"type" : "string"
2023-06-10 04:14:18 +00:00
} ,
"shouldChangePassword" : {
"type" : "boolean"
2023-08-01 16:49:18 +00:00
} ,
"storageLabel" : {
"type" : "string"
2023-01-15 05:49:47 +00:00
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"id"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-01-15 05:49:47 +00:00
} ,
2023-06-10 04:14:18 +00:00
"UsageByUserDto" : {
2022-12-05 17:56:44 +00:00
"properties" : {
2023-08-01 16:49:18 +00:00
"photos" : {
"type" : "integer"
} ,
"usage" : {
"format" : "int64" ,
"type" : "integer"
2022-12-05 17:56:44 +00:00
} ,
2023-08-01 16:49:18 +00:00
"userId" : {
2023-06-10 04:14:18 +00:00
"type" : "string"
} ,
2023-11-12 01:03:32 +00:00
"userName" : {
2023-08-01 16:49:18 +00:00
"type" : "string"
2022-12-05 17:56:44 +00:00
} ,
2023-06-10 04:14:18 +00:00
"videos" : {
2022-12-05 17:56:44 +00:00
"type" : "integer"
}
} ,
"required" : [
2023-06-10 04:14:18 +00:00
"userId" ,
2023-11-12 01:03:32 +00:00
"userName" ,
2023-06-10 04:14:18 +00:00
"photos" ,
"videos" ,
"usage"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2022-12-05 17:56:44 +00:00
} ,
2023-11-14 03:10:35 +00:00
"UserAvatarColor" : {
"enum" : [
"primary" ,
"pink" ,
"red" ,
"yellow" ,
"blue" ,
"green" ,
"purple" ,
"orange" ,
"gray" ,
"amber"
] ,
"type" : "string"
} ,
2023-11-01 03:13:34 +00:00
"UserDto" : {
"properties" : {
2023-11-14 03:10:35 +00:00
"avatarColor" : {
"$ref" : "#/components/schemas/UserAvatarColor"
} ,
2023-11-01 03:13:34 +00:00
"email" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
2023-11-12 01:03:32 +00:00
"name" : {
2023-11-01 03:13:34 +00:00
"type" : "string"
} ,
"profileImagePath" : {
"type" : "string"
}
} ,
"required" : [
2023-11-14 03:10:35 +00:00
"avatarColor" ,
2023-11-01 03:13:34 +00:00
"id" ,
2023-11-12 01:03:32 +00:00
"name" ,
2023-11-01 03:13:34 +00:00
"email" ,
"profileImagePath"
] ,
"type" : "object"
} ,
2023-06-10 04:14:18 +00:00
"UserResponseDto" : {
2023-01-09 20:16:08 +00:00
"properties" : {
2023-11-14 03:10:35 +00:00
"avatarColor" : {
"$ref" : "#/components/schemas/UserAvatarColor"
} ,
2023-08-01 16:49:18 +00:00
"createdAt" : {
"format" : "date-time" ,
"type" : "string"
} ,
"deletedAt" : {
"format" : "date-time" ,
"nullable" : true ,
2023-06-10 04:14:18 +00:00
"type" : "string"
} ,
"email" : {
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"externalPath" : {
"nullable" : true ,
"type" : "string"
} ,
"id" : {
2023-06-10 04:14:18 +00:00
"type" : "string"
} ,
2023-08-01 16:49:18 +00:00
"isAdmin" : {
"type" : "boolean"
2023-01-09 20:16:08 +00:00
} ,
2023-08-10 02:01:16 +00:00
"memoriesEnabled" : {
"type" : "boolean"
} ,
2023-11-12 01:03:32 +00:00
"name" : {
"type" : "string"
} ,
2023-08-01 16:49:18 +00: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 02:33:20 +00:00
} ,
2023-06-10 04:14:18 +00:00
"profileImagePath" : {
2023-05-30 13:15:56 +00:00
"type" : "string"
2023-01-09 20:16:08 +00:00
} ,
2023-06-10 04:14:18 +00:00
"shouldChangePassword" : {
2023-01-09 20:16:08 +00:00
"type" : "boolean"
2023-01-22 04:15:16 +00:00
} ,
2023-08-01 16:49:18 +00:00
"storageLabel" : {
"nullable" : true ,
2023-06-10 04:14:18 +00:00
"type" : "string"
2023-01-09 20:16:08 +00:00
} ,
2023-06-10 04:14:18 +00:00
"updatedAt" : {
"format" : "date-time" ,
"type" : "string"
2023-01-09 20:16:08 +00:00
}
} ,
"required" : [
2023-11-14 03:10:35 +00:00
"avatarColor" ,
2023-06-10 04:14:18 +00:00
"id" ,
2023-11-12 01:03:32 +00:00
"name" ,
2023-11-01 03:13:34 +00:00
"email" ,
"profileImagePath" ,
2023-06-10 04:14:18 +00:00
"storageLabel" ,
feat(server): support for read-only assets and importing existing items in the filesystem (#2715)
* Added read-only flag for assets, endpoint to trigger file import vs upload
* updated fixtures with new property
* if upload is 'read-only', ensure there is no existing asset at the designated originalPath
* added test for file import as well as detecting existing image at read-only destination location
* Added storage service test for a case where it should not move read-only assets
* upload doesn't need the read-only flag available, just importing
* default isReadOnly on import endpoint to true
* formatting fixes
* create-asset dto needs isReadOnly, so set it to false by default on create, updated api generation
* updated code to reflect changes in MR
* fixed read stream promise return type
* new index for originalPath, check for existing path on import, reglardless of user, to prevent duplicates
* refactor: import asset
* chore: open api
* chore: tests
* Added externalPath support for individual users, updated UI to allow this to be set by admin
* added missing var for externalPath in ui
* chore: open api
* fix: compilation issues
* fix: server test
* built api, fixed user-response dto to include externalPath
* reverted accidental commit
* bad commit of duplicate externalPath in user response dto
* fixed tests to include externalPath on expected result
* fix: unit tests
* centralized supported filetypes, perform file type checking of asset and sidecar during file import process
* centralized supported filetype check method to keep regex DRY
* fixed typo
* combined migrations into one
* update api
* Removed externalPath from shared-link code, added column to admin user page whether external paths / import is enabled or not
* update mimetype
* Fixed detect correct mimetype
* revert asset-upload config
* reverted domain.constant
* refactor
* fix mime-type issue
* fix format
---------
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2023-06-22 02:33:20 +00:00
"externalPath" ,
2023-06-10 04:14:18 +00:00
"shouldChangePassword" ,
"isAdmin" ,
"createdAt" ,
"deletedAt" ,
"updatedAt" ,
2023-08-14 17:52:06 +00:00
"oauthId"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-06-10 04:14:18 +00:00
} ,
"ValidateAccessTokenResponseDto" : {
"properties" : {
"authStatus" : {
"type" : "boolean"
}
} ,
"required" : [
"authStatus"
2023-08-01 16:49:18 +00:00
] ,
"type" : "object"
2023-07-09 02:43:11 +00:00
} ,
"VideoCodec" : {
"enum" : [
"h264" ,
"hevc" ,
"vp9"
2023-08-01 16:49:18 +00:00
] ,
"type" : "string"
2022-12-05 17:56:44 +00:00
}
}
}
}
