Space

此结构在哪里使用

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

• POSTCreate Space/api/v1/spaces
• GETGet Space/api/v1/spaces/{space}
• PATCHUpdate Space/api/v1/spaces/{space}

被以下组件结构引用：

• ListSpacesResponse
• SpaceInvitation
• UserNotification_SpaceInvitationPayload

结构与字段

object

Space is a collaboration boundary for placed memos.

完整结构

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

{
  "required": [
    "title"
  ],
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The resource name of the space. Format: spaces/{space}."
    },
    "title": {
      "type": "string",
      "description": "Required. The human-readable title."
    },
    "description": {
      "type": "string",
      "description": "Optional. A description of the space."
    },
    "currentUserRole": {
      "readOnly": true,
      "enum": [
        "ROLE_UNSPECIFIED",
        "ADMIN",
        "USER"
      ],
      "type": "string",
      "description": "Output only. The authenticated user's membership role in this space.\n ROLE_UNSPECIFIED when this Space is exposed as metadata-only.",
      "format": "enum"
    },
    "memberCount": {
      "readOnly": true,
      "type": "integer",
      "description": "Output only. The number of accepted members in this space. Pending\n invitations are excluded. Zero when this Space is exposed as metadata-only.",
      "format": "int32"
    },
    "icon": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Space_Icon"
        }
      ],
      "description": "Optional. Display icon. Omit when updating with the \"icon\" mask to reset\n to the default Space mark."
    }
  },
  "description": "Space is a collaboration boundary for placed memos."
}