Sign in

v1

latestOpenAPI 3.1.02026-07-261344388.3 KB
Document

Publish a document

Publish or unpublish a document version, optionally creating a change request for approval.

put/api/projects/{projectId}/documents/{documentId}/publish

Path parameters

documentIdstring uuid required

Document unique identifier

projectIdstring uuid required

Project unique identifier

Request body

type'publish' | 'unpublish'

Action type: publish or unpublish

versionIdstring uuid

Version ID to publish (required for publish)

commentstring nullable

Comment for the change request

Response

Document with updated publication status

idstring uuid required

Document unique identifier

keystring required

Materialized lowercase path based on the name

pathstring required

Materialized path based on the name

namestring required

Document name

type'f' | 'd' | 'e' required

Document type (file, directory, or external file)

metaobject

Document metadata

contentTypestring

Content MIME type

sizenumber

Document size in bytes

parentIdstring uuid nullable

Parent document ID

projectIdstring uuid required

Project ID

publishedIdstring uuid nullable

Currently published version ID

publishedAtstring nullable

Publication timestamp

updatedAtstring

Last update timestamp

deletedAtstring nullable

Deletion timestamp if soft deleted