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

40 lines
1,006 B
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
get:
tags: [Documents]
summary: Get a document
description: Returns document metadata and a presigned GET URL.
operationId: get-api-documents-id
responses:
"200":
description: 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
"401":
description: Missing session.
content:
application/json:
schema:
$ref: ../components/schemas.yaml#/Error
"404":
description: Document not found.
content:
application/json:
schema:
$ref: ../components/schemas.yaml#/Error