1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2025-01-04 02:46:47 +01:00

chore: make open-api

This commit is contained in:
Eli Gao 2024-12-25 01:31:46 +08:00
parent 152dc29c43
commit 9a67ec39cd
11 changed files with 80 additions and 243 deletions

BIN
mobile/openapi/README.md generated

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

View file

@ -1424,6 +1424,7 @@
},
"/assets/bulk-upload-check": {
"post": {
"description": "Checks if assets exist by checksums",
"operationId": "checkBulkUpload",
"parameters": [],
"requestBody": {
@ -1459,7 +1460,6 @@
"api_key": []
}
],
"summary": "Checks if assets exist by checksums",
"tags": [
"Assets"
]
@ -1467,6 +1467,7 @@
},
"/assets/device/{deviceId}": {
"get": {
"description": "Get all asset of a device that are in the database, ID only.",
"operationId": "getAllUserAssetsByDeviceId",
"parameters": [
{
@ -1504,7 +1505,6 @@
"api_key": []
}
],
"summary": "Get all asset of a device that are in the database, ID only.",
"tags": [
"Assets"
]
@ -1512,6 +1512,7 @@
},
"/assets/exist": {
"post": {
"description": "Checks if multiple assets exist on the server and returns all existing - used by background backup",
"operationId": "checkExistingAssets",
"parameters": [],
"requestBody": {
@ -1547,7 +1548,6 @@
"api_key": []
}
],
"summary": "Checks if multiple assets exist on the server and returns all existing - used by background backup",
"tags": [
"Assets"
]
@ -1903,6 +1903,7 @@
]
},
"put": {
"description": "Replace the asset with new file, without changing its id",
"operationId": "replaceAsset",
"parameters": [
{
@ -1956,7 +1957,6 @@
"api_key": []
}
],
"summary": "Replace the asset with new file, without changing its id",
"tags": [
"Assets"
],
@ -7492,7 +7492,6 @@
"items": {
"$ref": "#/components/schemas/Permission"
},
"minItems": 1,
"type": "array"
}
},
@ -7573,11 +7572,7 @@
"type": "string"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/ReactionType"
}
]
"$ref": "#/components/schemas/ReactionType"
}
},
"required": [
@ -7604,11 +7599,7 @@
"type": "string"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/ReactionType"
}
]
"$ref": "#/components/schemas/ReactionType"
},
"user": {
"$ref": "#/components/schemas/UserResponseDto"
@ -7640,7 +7631,6 @@
"items": {
"$ref": "#/components/schemas/AlbumUserAddDto"
},
"minItems": 1,
"type": "array"
}
},
@ -7709,11 +7699,7 @@
"type": "string"
},
"order": {
"allOf": [
{
"$ref": "#/components/schemas/AssetOrder"
}
]
"$ref": "#/components/schemas/AssetOrder"
},
"owner": {
"$ref": "#/components/schemas/UserResponseDto"
@ -7773,12 +7759,7 @@
"AlbumUserAddDto": {
"properties": {
"role": {
"allOf": [
{
"$ref": "#/components/schemas/AlbumUserRole"
}
],
"default": "editor"
"$ref": "#/components/schemas/AlbumUserRole"
},
"userId": {
"format": "uuid",
@ -7793,11 +7774,7 @@
"AlbumUserCreateDto": {
"properties": {
"role": {
"allOf": [
{
"$ref": "#/components/schemas/AlbumUserRole"
}
]
"$ref": "#/components/schemas/AlbumUserRole"
},
"userId": {
"format": "uuid",
@ -7813,11 +7790,7 @@
"AlbumUserResponseDto": {
"properties": {
"role": {
"allOf": [
{
"$ref": "#/components/schemas/AlbumUserRole"
}
]
"$ref": "#/components/schemas/AlbumUserRole"
},
"user": {
"$ref": "#/components/schemas/UserResponseDto"
@ -8114,11 +8087,7 @@
"nullable": true
},
"sourceType": {
"allOf": [
{
"$ref": "#/components/schemas/SourceType"
}
]
"$ref": "#/components/schemas/SourceType"
}
},
"required": [
@ -8189,11 +8158,7 @@
"type": "integer"
},
"sourceType": {
"allOf": [
{
"$ref": "#/components/schemas/SourceType"
}
]
"$ref": "#/components/schemas/SourceType"
}
},
"required": [
@ -8289,11 +8254,7 @@
"type": "array"
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/AssetJobName"
}
]
"$ref": "#/components/schemas/AssetJobName"
}
},
"required": [
@ -8391,11 +8352,7 @@
"type": "string"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/AssetMediaStatus"
}
]
"$ref": "#/components/schemas/AssetMediaStatus"
}
},
"required": [
@ -8534,11 +8491,7 @@
"type": "string"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/AssetTypeEnum"
}
]
"$ref": "#/components/schemas/AssetTypeEnum"
},
"unassignedFaces": {
"items": {
@ -8651,11 +8604,7 @@
"AvatarResponse": {
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/UserAvatarColor"
}
]
"$ref": "#/components/schemas/UserAvatarColor"
}
},
"required": [
@ -8666,11 +8615,7 @@
"AvatarUpdate": {
"properties": {
"color": {
"allOf": [
{
"$ref": "#/components/schemas/UserAvatarColor"
}
]
"$ref": "#/components/schemas/UserAvatarColor"
}
},
"type": "object"
@ -8761,7 +8706,6 @@
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"deviceId": {
@ -8828,17 +8772,13 @@
"items": {
"type": "string"
},
"maxItems": 128,
"type": "array",
"uniqueItems": true
"type": "array"
},
"importPaths": {
"items": {
"type": "string"
},
"maxItems": 128,
"type": "array",
"uniqueItems": true
"type": "array"
},
"name": {
"type": "string"
@ -9307,18 +9247,10 @@
"type": "string"
},
"entityType": {
"allOf": [
{
"$ref": "#/components/schemas/PathEntityType"
}
]
"$ref": "#/components/schemas/PathEntityType"
},
"pathType": {
"allOf": [
{
"$ref": "#/components/schemas/PathType"
}
]
"$ref": "#/components/schemas/PathType"
},
"pathValue": {
"type": "string"
@ -9380,11 +9312,7 @@
"JobCommandDto": {
"properties": {
"command": {
"allOf": [
{
"$ref": "#/components/schemas/JobCommand"
}
]
"$ref": "#/components/schemas/JobCommand"
},
"force": {
"type": "boolean"
@ -9429,11 +9357,7 @@
"JobCreateDto": {
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/ManualJobName"
}
]
"$ref": "#/components/schemas/ManualJobName"
}
},
"required": [
@ -9621,7 +9545,6 @@
"properties": {
"email": {
"example": "testuser@email.com",
"format": "email",
"type": "string"
},
"password": {
@ -9795,11 +9718,7 @@
"type": "string"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/MemoryType"
}
]
"$ref": "#/components/schemas/MemoryType"
}
},
"required": [
@ -9864,11 +9783,7 @@
"type": "string"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/MemoryType"
}
]
"$ref": "#/components/schemas/MemoryType"
},
"updatedAt": {
"format": "date-time",
@ -9997,11 +9912,7 @@
"type": "string"
},
"order": {
"allOf": [
{
"$ref": "#/components/schemas/AssetOrder"
}
]
"$ref": "#/components/schemas/AssetOrder"
},
"originalFileName": {
"type": "string"
@ -10052,11 +9963,7 @@
"type": "string"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/AssetTypeEnum"
}
]
"$ref": "#/components/schemas/AssetTypeEnum"
},
"updatedAfter": {
"format": "date-time",
@ -10140,11 +10047,7 @@
"PartnerResponseDto": {
"properties": {
"avatarColor": {
"allOf": [
{
"$ref": "#/components/schemas/UserAvatarColor"
}
]
"$ref": "#/components/schemas/UserAvatarColor"
},
"email": {
"type": "string"
@ -10663,11 +10566,7 @@
"type": "string"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/AssetTypeEnum"
}
]
"$ref": "#/components/schemas/AssetTypeEnum"
},
"updatedAfter": {
"format": "date-time",
@ -11335,11 +11234,7 @@
"type": "boolean"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/SharedLinkType"
}
]
"$ref": "#/components/schemas/SharedLinkType"
}
},
"required": [
@ -11424,11 +11319,7 @@
"type": "string"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/SharedLinkType"
}
]
"$ref": "#/components/schemas/SharedLinkType"
},
"userId": {
"type": "string"
@ -11461,7 +11352,6 @@
"properties": {
"email": {
"example": "testuser@email.com",
"format": "email",
"type": "string"
},
"name": {
@ -11578,11 +11468,7 @@
"type": "string"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/AssetTypeEnum"
}
]
"$ref": "#/components/schemas/AssetTypeEnum"
},
"updatedAfter": {
"format": "date-time",
@ -11623,7 +11509,6 @@
"format": "uuid",
"type": "string"
},
"minItems": 2,
"type": "array"
}
},
@ -11764,11 +11649,7 @@
"SystemConfigFFmpegDto": {
"properties": {
"accel": {
"allOf": [
{
"$ref": "#/components/schemas/TranscodeHWAccel"
}
]
"$ref": "#/components/schemas/TranscodeHWAccel"
},
"accelDecode": {
"type": "boolean"
@ -11797,11 +11678,7 @@
"type": "integer"
},
"cqMode": {
"allOf": [
{
"$ref": "#/components/schemas/CQMode"
}
]
"$ref": "#/components/schemas/CQMode"
},
"crf": {
"maximum": 51,
@ -11827,21 +11704,13 @@
"type": "integer"
},
"targetAudioCodec": {
"allOf": [
{
"$ref": "#/components/schemas/AudioCodec"
}
]
"$ref": "#/components/schemas/AudioCodec"
},
"targetResolution": {
"type": "string"
},
"targetVideoCodec": {
"allOf": [
{
"$ref": "#/components/schemas/VideoCodec"
}
]
"$ref": "#/components/schemas/VideoCodec"
},
"temporalAQ": {
"type": "boolean"
@ -11851,18 +11720,10 @@
"type": "integer"
},
"tonemap": {
"allOf": [
{
"$ref": "#/components/schemas/ToneMapping"
}
]
"$ref": "#/components/schemas/ToneMapping"
},
"transcode": {
"allOf": [
{
"$ref": "#/components/schemas/TranscodePolicy"
}
]
"$ref": "#/components/schemas/TranscodePolicy"
},
"twoPass": {
"type": "boolean"
@ -11904,14 +11765,31 @@
],
"type": "object"
},
"SystemConfigGeneratedFullsizeImageDto": {
"properties": {
"enabled": {
"type": "boolean"
},
"format": {
"$ref": "#/components/schemas/ImageFormat"
},
"quality": {
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
"required": [
"enabled",
"format",
"quality"
],
"type": "object"
},
"SystemConfigGeneratedImageDto": {
"properties": {
"format": {
"allOf": [
{
"$ref": "#/components/schemas/ImageFormat"
}
]
"$ref": "#/components/schemas/ImageFormat"
},
"quality": {
"maximum": 100,
@ -11933,17 +11811,13 @@
"SystemConfigImageDto": {
"properties": {
"colorspace": {
"allOf": [
{
"$ref": "#/components/schemas/Colorspace"
}
]
"$ref": "#/components/schemas/Colorspace"
},
"extractEmbedded": {
"type": "boolean"
},
"fullsizePreview": {
"type": "boolean"
"fullsize": {
"$ref": "#/components/schemas/SystemConfigGeneratedFullsizeImageDto"
},
"preview": {
"$ref": "#/components/schemas/SystemConfigGeneratedImageDto"
@ -11955,7 +11829,7 @@
"required": [
"colorspace",
"extractEmbedded",
"fullsizePreview",
"fullsize",
"preview",
"thumbnail"
],
@ -12059,11 +11933,7 @@
"type": "boolean"
},
"level": {
"allOf": [
{
"$ref": "#/components/schemas/LogLevel"
}
]
"$ref": "#/components/schemas/LogLevel"
}
},
"required": [
@ -12092,7 +11962,6 @@
"type": "string"
},
"urls": {
"format": "uri",
"items": {
"format": "uri",
"type": "string"
@ -12113,14 +11982,12 @@
"SystemConfigMapDto": {
"properties": {
"darkStyle": {
"format": "uri",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"lightStyle": {
"format": "uri",
"type": "string"
}
},
@ -12195,7 +12062,6 @@
"type": "boolean"
},
"mobileRedirectUri": {
"format": "uri",
"type": "string"
},
"profileSigningAlgorithm": {
@ -12258,7 +12124,6 @@
"SystemConfigServerDto": {
"properties": {
"externalDomain": {
"format": "uri",
"type": "string"
},
"loginPageMessage": {
@ -12515,7 +12380,6 @@
"TagCreateDto": {
"properties": {
"color": {
"pattern": "^#?([0-9A-F]{3}|[0-9A-F]{4}|[0-9A-F]{6}|[0-9A-F]{8})$",
"type": "string"
},
"name": {
@ -12571,7 +12435,6 @@
"properties": {
"color": {
"nullable": true,
"pattern": "^#?([0-9A-F]{3}|[0-9A-F]{4}|[0-9A-F]{6}|[0-9A-F]{8})$",
"type": "string"
}
},
@ -12734,11 +12597,7 @@
"type": "boolean"
},
"order": {
"allOf": [
{
"$ref": "#/components/schemas/AssetOrder"
}
]
"$ref": "#/components/schemas/AssetOrder"
}
},
"type": "object"
@ -12746,11 +12605,7 @@
"UpdateAlbumUserDto": {
"properties": {
"role": {
"allOf": [
{
"$ref": "#/components/schemas/AlbumUserRole"
}
]
"$ref": "#/components/schemas/AlbumUserRole"
}
},
"required": [
@ -12797,17 +12652,13 @@
"items": {
"type": "string"
},
"maxItems": 128,
"type": "array",
"uniqueItems": true
"type": "array"
},
"importPaths": {
"items": {
"type": "string"
},
"maxItems": 128,
"type": "array",
"uniqueItems": true
"type": "array"
},
"name": {
"type": "string"
@ -12873,7 +12724,6 @@
"UserAdminCreateDto": {
"properties": {
"email": {
"format": "email",
"type": "string"
},
"name": {
@ -12917,11 +12767,7 @@
"UserAdminResponseDto": {
"properties": {
"avatarColor": {
"allOf": [
{
"$ref": "#/components/schemas/UserAvatarColor"
}
]
"$ref": "#/components/schemas/UserAvatarColor"
},
"createdAt": {
"format": "date-time",
@ -12976,11 +12822,7 @@
"type": "boolean"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/UserStatus"
}
]
"$ref": "#/components/schemas/UserStatus"
},
"storageLabel": {
"nullable": true,
@ -13015,7 +12857,6 @@
"UserAdminUpdateDto": {
"properties": {
"email": {
"format": "email",
"type": "string"
},
"name": {
@ -13153,11 +12994,7 @@
"UserResponseDto": {
"properties": {
"avatarColor": {
"allOf": [
{
"$ref": "#/components/schemas/UserAvatarColor"
}
]
"$ref": "#/components/schemas/UserAvatarColor"
},
"email": {
"type": "string"
@ -13197,7 +13034,6 @@
"UserUpdateMeDto": {
"properties": {
"email": {
"format": "email",
"type": "string"
},
"name": {
@ -13226,17 +13062,13 @@
"items": {
"type": "string"
},
"maxItems": 128,
"type": "array",
"uniqueItems": true
"type": "array"
},
"importPaths": {
"items": {
"type": "string"
},
"maxItems": 128,
"type": "array",
"uniqueItems": true
"type": "array"
}
},
"type": "object"

View file

@ -1123,6 +1123,11 @@ export type SystemConfigFFmpegDto = {
transcode: TranscodePolicy;
twoPass: boolean;
};
export type SystemConfigGeneratedFullsizeImageDto = {
enabled: boolean;
format: ImageFormat;
quality: number;
};
export type SystemConfigGeneratedImageDto = {
format: ImageFormat;
quality: number;
@ -1131,7 +1136,7 @@ export type SystemConfigGeneratedImageDto = {
export type SystemConfigImageDto = {
colorspace: Colorspace;
extractEmbedded: boolean;
fullsizePreview: boolean;
fullsize: SystemConfigGeneratedFullsizeImageDto;
preview: SystemConfigGeneratedImageDto;
thumbnail: SystemConfigGeneratedImageDto;
};