Add documentation for "is-ready" endpoint to check stored object status

- Introduced `/1.0/doc-store/stored-object/{uuid}/is-ready` endpoint to retrieve the status of a stored object.
- Added path parameter for `uuid` and returned `status` property with `empty`, `ready`, `pending`, or `failure` states.
This commit is contained in:
2026-02-23 12:47:29 +01:00
parent 6b9377025f
commit 8a9a25ea43

View File

@@ -54,6 +54,38 @@ paths:
422:
description: "Invalid data"
/1.0/doc-store/stored-object/{uuid}/is-ready:
get:
tags:
- storedobject
summary: Get the status of a stored object
parameters:
- in: path
name: uuid
required: true
allowEmptyValue: false
description: The UUID of the storedObject
schema:
type: string
format: uuid
responses:
200:
description: "OK"
content:
application/json:
schema:
type: object
properties:
id:
type: integer
filename:
type: string
status:
type: string
enum: [empty, ready, pending, failure]
type:
type: string
/1.0/doc-store/async-upload/temp_url/{uuid}/generate/post:
get:
tags: