SetWorkspaceSetting updates the setting.

请求参数

Path 参数

setting.name

string

必需

name is the name of the setting.
Format: settings/{setting}

正则匹配:

settings/[^/]+

Body 参数application/json

generalSetting

object (apiv1WorkspaceGeneralSetting)

可选

disallowUserRegistration

boolean

可选

disallow_user_registration disallows user registration.

disallowPasswordAuth

boolean

可选

disallow_password_auth disallows password authentication.

additionalScript

string

可选

additional_script is the additional script.

additionalStyle

string

可选

additional_style is the additional style.

customProfile

object (apiv1WorkspaceCustomProfile)

可选

weekStartDayOffset

integer <int32>

可选

week_start_day_offset is the week start day offset from Sunday.
0: Sunday, 1: Monday, 2: Tuesday, 3: Wednesday, 4: Thursday, 5: Friday, 6: Saturday
Default is Sunday.

disallowChangeUsername

boolean

可选

disallow_change_username disallows changing username.

disallowChangeNickname

boolean

可选

disallow_change_nickname disallows changing nickname.

storageSetting

object (apiv1WorkspaceStorageSetting)

可选

storageType

enum<string>

可选

DATABASE: DATABASE is the database storage type.

LOCAL: LOCAL is the local storage type.

S3: S3 is the S3 storage type.

枚举值:

STORAGE_TYPE_UNSPECIFIEDDATABASELOCALS3

默认值:

STORAGE_TYPE_UNSPECIFIED

filepathTemplate

string

The template of file path. e.g. assets/{timestamp}_{filename}

可选

uploadSizeLimitMb

string <int64>

可选

The max upload size in megabytes.

s3Config

object (Reference: https://developers.cloudflare.com/r2/examples/aws/aws-sdk-go/)

可选

memoRelatedSetting

object (apiv1WorkspaceMemoRelatedSetting)

可选

disallowPublicVisibility

boolean

可选

disallow_public_visibility disallows set memo as public visibility.

displayWithUpdateTime

boolean

可选

display_with_update_time orders and displays memo with update time.

contentLengthLimit

integer <int32>

可选

content_length_limit is the limit of content length. Unit is byte.

enableAutoCompact

boolean

可选

enable_auto_compact enables auto compact for large content.

enableDoubleClickEdit

boolean

可选

enable_double_click_edit enables editing on double click.

enableLinkPreview

boolean

可选

enable_link_preview enables links preview.

enableComment

boolean

可选

enable_comment enables comment.

enableLocation

boolean

可选

enable_location enables setting location for memo.

defaultVisibility

string

可选

default_visibility set the global memos default visibility.

reactions

array[string]

可选

reactions is the list of reactions.

disableMarkdownShortcuts

boolean

可选

disable_markdown_shortcuts disallow the registration of markdown shortcuts.

示例

{
    "generalSetting": {
        "disallowUserRegistration": true,
        "disallowPasswordAuth": true,
        "additionalScript": "string",
        "additionalStyle": "string",
        "customProfile": {
            "title": "string",
            "description": "string",
            "logoUrl": "string",
            "locale": "string",
            "appearance": "string"
        },
        "weekStartDayOffset": 0,
        "disallowChangeUsername": true,
        "disallowChangeNickname": true
    },
    "storageSetting": {
        "storageType": "STORAGE_TYPE_UNSPECIFIED",
        "filepathTemplate": "string",
        "uploadSizeLimitMb": "string",
        "s3Config": {
            "accessKeyId": "string",
            "accessKeySecret": "string",
            "endpoint": "string",
            "region": "string",
            "bucket": "string",
            "usePathStyle": true
        }
    },
    "memoRelatedSetting": {
        "disallowPublicVisibility": true,
        "displayWithUpdateTime": true,
        "contentLengthLimit": 0,
        "enableAutoCompact": true,
        "enableDoubleClickEdit": true,
        "enableLinkPreview": true,
        "enableComment": true,
        "enableLocation": true,
        "defaultVisibility": "string",
        "reactions": [
            "string"
        ],
        "disableMarkdownShortcuts": true
    }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PATCH '/api/v1/workspace/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "generalSetting": {
        "disallowUserRegistration": true,
        "disallowPasswordAuth": true,
        "additionalScript": "string",
        "additionalStyle": "string",
        "customProfile": {
            "title": "string",
            "description": "string",
            "logoUrl": "string",
            "locale": "string",
            "appearance": "string"
        },
        "weekStartDayOffset": 0,
        "disallowChangeUsername": true,
        "disallowChangeNickname": true
    },
    "storageSetting": {
        "storageType": "STORAGE_TYPE_UNSPECIFIED",
        "filepathTemplate": "string",
        "uploadSizeLimitMb": "string",
        "s3Config": {
            "accessKeyId": "string",
            "accessKeySecret": "string",
            "endpoint": "string",
            "region": "string",
            "bucket": "string",
            "usePathStyle": true
        }
    },
    "memoRelatedSetting": {
        "disallowPublicVisibility": true,
        "displayWithUpdateTime": true,
        "contentLengthLimit": 0,
        "enableAutoCompact": true,
        "enableDoubleClickEdit": true,
        "enableLinkPreview": true,
        "enableComment": true,
        "enableLocation": true,
        "defaultVisibility": "string",
        "reactions": [
            "string"
        ],
        "disableMarkdownShortcuts": true
    }
}'

返回响应

🟢200成功

application/json

A successful response.

Body

name

string

name is the name of the setting. Format: settings/{setting}

可选

generalSetting

object (apiv1WorkspaceGeneralSetting)

可选

disallowUserRegistration

boolean

可选

disallow_user_registration disallows user registration.

disallowPasswordAuth

boolean

可选

disallow_password_auth disallows password authentication.

additionalScript

string

可选

additional_script is the additional script.

additionalStyle

string

可选

additional_style is the additional style.

customProfile

object (apiv1WorkspaceCustomProfile)

可选

weekStartDayOffset

integer <int32>

可选

week_start_day_offset is the week start day offset from Sunday.
0: Sunday, 1: Monday, 2: Tuesday, 3: Wednesday, 4: Thursday, 5: Friday, 6: Saturday
Default is Sunday.

disallowChangeUsername

boolean

可选

disallow_change_username disallows changing username.

disallowChangeNickname

boolean

可选

disallow_change_nickname disallows changing nickname.

storageSetting

object (apiv1WorkspaceStorageSetting)

可选

storageType

enum<string>

可选

DATABASE: DATABASE is the database storage type.

LOCAL: LOCAL is the local storage type.

S3: S3 is the S3 storage type.

枚举值:

STORAGE_TYPE_UNSPECIFIEDDATABASELOCALS3

默认值:

STORAGE_TYPE_UNSPECIFIED

filepathTemplate

string

The template of file path. e.g. assets/{timestamp}_{filename}

可选

uploadSizeLimitMb

string <int64>

可选

The max upload size in megabytes.

s3Config

object (Reference: https://developers.cloudflare.com/r2/examples/aws/aws-sdk-go/)

可选

memoRelatedSetting

object (apiv1WorkspaceMemoRelatedSetting)

可选

disallowPublicVisibility

boolean

可选

disallow_public_visibility disallows set memo as public visibility.

displayWithUpdateTime

boolean

可选

display_with_update_time orders and displays memo with update time.

contentLengthLimit

integer <int32>

可选

content_length_limit is the limit of content length. Unit is byte.

enableAutoCompact

boolean

可选

enable_auto_compact enables auto compact for large content.

enableDoubleClickEdit

boolean

可选

enable_double_click_edit enables editing on double click.

enableLinkPreview

boolean

可选

enable_link_preview enables links preview.

enableComment

boolean

可选

enable_comment enables comment.

enableLocation

boolean

可选

enable_location enables setting location for memo.

defaultVisibility

string

可选

default_visibility set the global memos default visibility.

reactions

array[string]

可选

reactions is the list of reactions.

disableMarkdownShortcuts

boolean

可选

disable_markdown_shortcuts disallow the registration of markdown shortcuts.

示例

{
    "name": "string",
    "generalSetting": {
        "disallowUserRegistration": true,
        "disallowPasswordAuth": true,
        "additionalScript": "string",
        "additionalStyle": "string",
        "customProfile": {
            "title": "string",
            "description": "string",
            "logoUrl": "string",
            "locale": "string",
            "appearance": "string"
        },
        "weekStartDayOffset": 0,
        "disallowChangeUsername": true,
        "disallowChangeNickname": true
    },
    "storageSetting": {
        "storageType": "STORAGE_TYPE_UNSPECIFIED",
        "filepathTemplate": "string",
        "uploadSizeLimitMb": "string",
        "s3Config": {
            "accessKeyId": "string",
            "accessKeySecret": "string",
            "endpoint": "string",
            "region": "string",
            "bucket": "string",
            "usePathStyle": true
        }
    },
    "memoRelatedSetting": {
        "disallowPublicVisibility": true,
        "displayWithUpdateTime": true,
        "contentLengthLimit": 0,
        "enableAutoCompact": true,
        "enableDoubleClickEdit": true,
        "enableLinkPreview": true,
        "enableComment": true,
        "enableLocation": true,
        "defaultVisibility": "string",
        "reactions": [
            "string"
        ],
        "disableMarkdownShortcuts": true
    }
}

🔴500服务器错误