Skip to content

Commit 5a1ebc9

Browse files
author
github-actions
committed
Update REST API documentation Mon Jul 13 08:39:57 UTC 2026
1 parent 4f36cd2 commit 5a1ebc9

1 file changed

Lines changed: 130 additions & 0 deletions

File tree

restapi.json

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2988,6 +2988,132 @@
29882988
}
29892989
}
29902990
},
2991+
"/api/v2/editor-uploads": {
2992+
"post": {
2993+
"tags": [
2994+
"editor-uploads"
2995+
],
2996+
"summary": "Upload editor asset",
2997+
"description": "Uploads an editor asset for use in CKEditor.",
2998+
"operationId": "b6cf7a64f5fccb8f0601331579203dc1",
2999+
"parameters": [
3000+
{
3001+
"name": "php-auth-pw",
3002+
"in": "header",
3003+
"description": "Session key obtained from login",
3004+
"required": true,
3005+
"schema": {
3006+
"type": "string"
3007+
}
3008+
}
3009+
],
3010+
"requestBody": {
3011+
"required": true,
3012+
"content": {
3013+
"multipart/form-data": {
3014+
"schema": {
3015+
"properties": {
3016+
"upload": {
3017+
"description": "Asset file to upload",
3018+
"type": "string",
3019+
"format": "binary"
3020+
},
3021+
"file": {
3022+
"description": "Alternative asset file field name",
3023+
"type": "string",
3024+
"format": "binary"
3025+
}
3026+
},
3027+
"type": "object"
3028+
}
3029+
}
3030+
}
3031+
},
3032+
"responses": {
3033+
"201": {
3034+
"description": "Asset uploaded",
3035+
"content": {
3036+
"application/json": {
3037+
"schema": {
3038+
"properties": {
3039+
"uploaded": {
3040+
"type": "boolean",
3041+
"example": true
3042+
},
3043+
"fileName": {
3044+
"type": "string",
3045+
"example": "f47ac10b58cc4372a5670e02b2c3d479.png"
3046+
},
3047+
"url": {
3048+
"type": "string",
3049+
"example": "https://example.com/uploadfiles/f47ac10b58cc4372a5670e02b2c3d479.png"
3050+
},
3051+
"default": {
3052+
"type": "string",
3053+
"example": "https://example.com/uploadfiles/f47ac10b58cc4372a5670e02b2c3d479.png"
3054+
},
3055+
"mimeType": {
3056+
"type": "string",
3057+
"example": "image/png"
3058+
},
3059+
"size": {
3060+
"type": "integer",
3061+
"example": 123456,
3062+
"nullable": true
3063+
},
3064+
"extension": {
3065+
"type": "string",
3066+
"example": "png"
3067+
}
3068+
},
3069+
"type": "object"
3070+
}
3071+
}
3072+
}
3073+
},
3074+
"400": {
3075+
"description": "Bad request",
3076+
"content": {
3077+
"application/json": {
3078+
"schema": {
3079+
"$ref": "#/components/schemas/BadRequestResponse"
3080+
}
3081+
}
3082+
}
3083+
},
3084+
"401": {
3085+
"description": "Unauthorized",
3086+
"content": {
3087+
"application/json": {
3088+
"schema": {
3089+
"$ref": "#/components/schemas/UnauthorizedResponse"
3090+
}
3091+
}
3092+
}
3093+
},
3094+
"413": {
3095+
"description": "Payload too large",
3096+
"content": {
3097+
"application/json": {
3098+
"schema": {
3099+
"$ref": "#/components/schemas/GenericErrorResponse"
3100+
}
3101+
}
3102+
}
3103+
},
3104+
"500": {
3105+
"description": "Storage failure",
3106+
"content": {
3107+
"application/json": {
3108+
"schema": {
3109+
"$ref": "#/components/schemas/GenericErrorResponse"
3110+
}
3111+
}
3112+
}
3113+
}
3114+
}
3115+
}
3116+
},
29913117
"/api/v2/email-forward/{messageId}": {
29923118
"post": {
29933119
"tags": [
@@ -9441,6 +9567,10 @@
94419567
"name": "campaigns",
94429568
"description": "campaigns"
94439569
},
9570+
{
9571+
"name": "editor-uploads",
9572+
"description": "editor-uploads"
9573+
},
94449574
{
94459575
"name": "list-messages",
94469576
"description": "list-messages"

0 commit comments

Comments
 (0)