Coda

Publish doc

开发环境

http://dev-cn.your-api-server.com

PUT

/docs/{docId}/publish

Publishing

Update publish settings for a doc.

请求示例

Python

Shell

JavaScript

Java

curl --location --request PUT 'http://dev-cn.your-api-server.com/docs/AbCDeFGH/publish' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mode": "view",
    "slug": "my-doc",
    "discoverable": true,
    "earnCredit": true,
    "categoryNames": [
        "Project management"
    ]
}'

响应示例

202 - 示例 1

{
    "requestId": "abc-123-def-456"
}

请求参数

Path 参数

docId

string

必需

ID of the doc.

示例值:

AbCDeFGH

Body 参数application/json

Payload for publishing a doc or or updating its publishing information.

mode

enum<string>

可选

Which interaction mode the published doc should use.

枚举值:

viewplayedit

slug

string

可选

Slug for the published doc.

示例值:

my-doc

discoverable

boolean

可选

If true, indicates that the doc is discoverable.

示例值:

true

earnCredit

boolean

可选

If true, new users may be required to sign in to view content within this document. You will receive Coda credit for each user who signs up via your doc.

示例值:

true

categoryNames

array[string]

可选

The names of categories to apply to the document.

示例值:

["Project management"]

示例

返回响应

🟢202Confirmation that the publish request was accepted.

application/json

Body

The result of publishing a doc.

requestId

string

必需

An arbitrary unique identifier for this request.

示例值:

abc-123-def-456

🟠400400

🟠401401

🟠403403

🟠404404

🟠429429

修改于 2024-03-20 08:13:15

Unpublish doc

Get info about a doc