seahaven-ap/packages/api/openapi/paths/documents-id-confirmations.yaml

53 lines
1.4 KiB
YAML
Raw Normal View History

parameters:
- name: id
in: path
required: true
description: Document primary key.
schema:
type: string
format: uuid
example: dddddddd-dddd-4ddd-8ddd-dddddddddddd
post:
tags: [Documents]
summary: Confirm a document upload
description: Succeeds when the object exists in MinIO or S3. Missing objects are a conflict.
operationId: post-api-documents-id-confirmations
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
responses:
"200":
description: Confirmed document with download URL.
content:
application/json:
schema:
$ref: ../components/schemas.yaml#/Document
"400":
description: Invalid id.
content:
application/json:
schema:
$ref: ../components/schemas.yaml#/Error
"403":
description: Caller lacks write:invoices.
content:
application/json:
schema:
$ref: ../components/schemas.yaml#/Error
"404":
description: Document not found.
content:
application/json:
schema:
$ref: ../components/schemas.yaml#/Error
"409":
description: Object has not been uploaded.
content:
application/json:
schema:
$ref: ../components/schemas.yaml#/Error