文档API 参考

Rust · 0.1.0

InstanceSetting_GeneralSetting

应用协议结构。字段名称及继承的描述保留原始语言。

此结构在哪里使用

以下链接根据协议快照中的直接引用生成。认证、可写字段和运行行为应以调用操作为准;可复用资源结构本身并不是完整的写入请求。

被以下组件结构引用:

结构与字段

object

General instance settings configuration.

字段类型 / 是否必需描述
disallowUserRegistrationbooleandisallow_user_registration disallows user registration.
disallowPasswordAuthbooleandisallow_password_auth disallows password authentication.
additionalScriptstringadditional_script is the additional script.
additionalStylestringadditional_style is the additional style.
customProfileallOf
GeneralSetting_CustomProfile
custom_profile is the custom profile.
weekStartDayOffsetinteger (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.
disallowChangeUsernamebooleandisallow_change_username disallows changing username.
disallowChangeNicknamebooleandisallow_change_nickname disallows changing nickname.

完整结构

约束与嵌套结构请以这份完整 JSON 定义为准。字段出现在这里,并不意味着每位调用者都能修改它。

{
  "type": "object",
  "properties": {
    "disallowUserRegistration": {
      "type": "boolean",
      "description": "disallow_user_registration disallows user registration."
    },
    "disallowPasswordAuth": {
      "type": "boolean",
      "description": "disallow_password_auth disallows password authentication."
    },
    "additionalScript": {
      "type": "string",
      "description": "additional_script is the additional script."
    },
    "additionalStyle": {
      "type": "string",
      "description": "additional_style is the additional style."
    },
    "customProfile": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GeneralSetting_CustomProfile"
        }
      ],
      "description": "custom_profile is the custom profile."
    },
    "weekStartDayOffset": {
      "type": "integer",
      "description": "week_start_day_offset is the week start day offset from Sunday.\n 0: Sunday, 1: Monday, 2: Tuesday, 3: Wednesday, 4: Thursday, 5: Friday, 6: Saturday\n Default is Sunday.",
      "format": "int32"
    },
    "disallowChangeUsername": {
      "type": "boolean",
      "description": "disallow_change_username disallows changing username."
    },
    "disallowChangeNickname": {
      "type": "boolean",
      "description": "disallow_change_nickname disallows changing nickname."
    }
  },
  "description": "General instance settings configuration."
}