文档API 参考

Rust · 0.1.0

UserNotification_SpaceInvitationPayload

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

此结构在哪里使用

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

被以下组件结构引用:

结构与字段

object

字段类型 / 是否必需描述
spaceInvitationstringThe invitation resource. Format: spaces/{space}/invitations/{username}
spaceallOf
Space
The read-only Space summary carried by the invitation.
rolestring (enum)
ROLE_UNSPECIFIED · ADMIN · USER
The role the invitation offers.
statestring (enum)
STATE_UNSPECIFIED · PENDING · ACCEPTED
The current state of the invitation for the receiver.

完整结构

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

{
  "type": "object",
  "properties": {
    "spaceInvitation": {
      "type": "string",
      "description": "The invitation resource.\n Format: spaces/{space}/invitations/{username}"
    },
    "space": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Space"
        }
      ],
      "description": "The read-only Space summary carried by the invitation."
    },
    "role": {
      "enum": [
        "ROLE_UNSPECIFIED",
        "ADMIN",
        "USER"
      ],
      "type": "string",
      "description": "The role the invitation offers.",
      "format": "enum"
    },
    "state": {
      "enum": [
        "STATE_UNSPECIFIED",
        "PENDING",
        "ACCEPTED"
      ],
      "type": "string",
      "description": "The current state of the invitation for the receiver.",
      "format": "enum"
    }
  }
}