Skip to content

πŸ†™ Upscayl - #1 Free and Open Source AI Image Upscaler for Linux, MacOS and Windows.

add new endpoints

TGS963773ca39daafb
diff --git a/docs/complete-a-multipart-upload.mdx b/docs/complete-a-multipart-upload.mdx
new file mode 100644
index 0000000..8607bee
--- /dev/null
+++ b/docs/complete-a-multipart-upload.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /complete-multipart-upload
+---
\ No newline at end of file
diff --git a/docs/get-task-status.mdx b/docs/get-task-status.mdx
index 7edfc2d..2ff9273 100644
--- a/docs/get-task-status.mdx
+++ b/docs/get-task-status.mdx
@@ -1,3 +1,3 @@
---
-openapi: post /gettaskstatus
+openapi: post /get-task-status
---
\ No newline at end of file
diff --git a/docs/get-upload-url.mdx b/docs/get-upload-url.mdx
index 5fe2f1b..ff3c365 100644
--- a/docs/get-upload-url.mdx
+++ b/docs/get-upload-url.mdx
@@ -1,3 +1,3 @@
---
-openapi: post /getuploadurl
+openapi: post /get-upload-url
---
\ No newline at end of file
diff --git a/docs/get-upscayl-history.mdx b/docs/get-upscayl-history.mdx
index ca32389..b872d91 100644
--- a/docs/get-upscayl-history.mdx
+++ b/docs/get-upscayl-history.mdx
@@ -1,3 +1,3 @@
---
-openapi: post /getupscaylhistory
+openapi: post /get-upscayl-history
---
\ No newline at end of file
diff --git a/docs/mint.json b/docs/mint.json
index b8c7874..c9fa763 100644
--- a/docs/mint.json
+++ b/docs/mint.json
@@ -48,7 +48,7 @@
"pages": ["introduction"]
},{
"group": "API Reference",
- "pages": ["get-task-status", "get-upload-url", "get-upscayl-history", "start-a-new-task"]
+ "pages": ["get-task-status", "get-upload-url", "complete-a-multipart-upload", "get-upscayl-history", "start-a-new-task"]
}
],
"footerSocials": {
diff --git a/docs/openapi.yaml b/docs/openapi.yaml
index 9ab06f4..7dfd539 100644
--- a/docs/openapi.yaml
+++ b/docs/openapi.yaml
@@ -4,7 +4,7 @@ info:
title: Upscayl Cloud API Documentation
version: 1.0.0
paths:
- /getuploadurl:
+ /get-upload-url:
post:
operationId: getUploadUrl
summary: Get upload URL
@@ -95,7 +95,7 @@ paths:
schema:
type: string
example: Internal Server Error
- /getupscaylhistory:
+ /get-upscayl-history:
post:
operationId: getUpscaylHistory
summary: Get Upscayl History
@@ -225,7 +225,7 @@ paths:
schema:
type: string
example: "Error getting data"
- /gettaskstatus:
+ /get-task-status:
post:
operationId: getTaskStatus
summary: Get Task Status
@@ -364,7 +364,7 @@ paths:
value: "Error getting data"
linkGenerationError:
value: "Error generating links for images"
- /starttask:
+ /start-task:
post:
operationId: startTask
summary: Start a new task
@@ -475,4 +475,93 @@ paths:
text/plain:
schema:
type: string
- example: "Error contacting the server"
\ No newline at end of file
+ example: "Error contacting the server"
+ /complete-multipart-upload:
+ post:
+ operationId: completeMultipartUpload
+ summary: Complete a multipart upload
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ data:
+ type: object
+ properties:
+ uploadId:
+ type: string
+ description: The upload ID
+ example: "exampleUploadId"
+ key:
+ type: string
+ description: The object key
+ example: "exampleKey"
+ parts:
+ type: array
+ items:
+ type: object
+ properties:
+ ETag:
+ type: string
+ description: The entity tag for the part
+ example: "exampleETag"
+ PartNumber:
+ type: integer
+ description: The part number
+ example: 1
+ required:
+ - uploadId
+ - key
+ - parts
+ responses:
+ "200":
+ description: Successful operation
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ status:
+ type: string
+ example: "success"
+ data:
+ type: object
+ properties:
+ status:
+ type: string
+ example: "success"
+ # Uncomment and add these properties if needed
+ # location:
+ # type: string
+ # example: "http://example.com/location"
+ # bucket:
+ # type: string
+ # example: "exampleBucket"
+ # key:
+ # type: string
+ # example: "exampleKey"
+ # eTag:
+ # type: string
+ # example: "exampleETag"
+ "400":
+ description: Bad request
+ content:
+ text/plain:
+ schema:
+ type: string
+ example: "Bad Request: Missing required parameters"
+ "401":
+ description: Unauthorized
+ content:
+ text/plain:
+ schema:
+ type: string
+ example: "Unauthorized: Invalid API key"
+ "500":
+ description: Internal server error
+ content:
+ text/plain:
+ schema:
+ type: string
+ example: "Internal Server Error: Error completing multipart upload"
\ No newline at end of file
diff --git a/docs/start-a-new-task.mdx b/docs/start-a-new-task.mdx
index db118a6..d0246c7 100644
--- a/docs/start-a-new-task.mdx
+++ b/docs/start-a-new-task.mdx
@@ -1,3 +1,3 @@
---
-openapi: post /starttask
+openapi: post /start-task
---
\ No newline at end of file