Update Space

PATCH /api/v1/spaces/{space}

SpaceService · SpaceService_UpdateSpace

基于协议生成的参考。授权与实例策略仍然生效。结构描述继承自 MIT 许可的应用接口定义；本站不会向真实服务执行示例。

访问权限

需要有效成员的空间 ADMIN 角色；不是空间管理员的实例管理员不能执行这些管理操作。

可编辑元数据

使用包含 title、description 或 icon 的非空掩码。title 不能为空。掩码包含 icon 而省略其值时重置图标。此操作不移动笔记，也不改变成员资格。

请求

UpdateSpace updates space metadata.

PATCH/api/v1/spaces/{space}

参数

名称 / 位置	类型 / 是否必需	描述
`space` path	string 必需	The space id.
`updateMask` query	string (field-mask) 必需（接口描述）	Required. The fields to update: title or description.

请求体

必需

application/json · Space

响应

200 · OK

application/json · Space

default · Default error response

application/json · Status

完整操作定义

下方保留全部已声明约束、媒体类型和响应细节。结构引用链接到完整定义。

展开 JSON 定义

{
  "tags": [
    "SpaceService"
  ],
  "description": "UpdateSpace updates space metadata.",
  "operationId": "SpaceService_UpdateSpace",
  "parameters": [
    {
      "name": "space",
      "in": "path",
      "description": "The space id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "updateMask",
      "in": "query",
      "description": "Required. The fields to update: title or description.",
      "schema": {
        "type": "string",
        "format": "field-mask"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Space"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Space"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}