DocumentationAPI reference
Rust · 0.1.0
UserNotification_SpaceInvitationPayload
Application protocol schema. Field names and inherited descriptions are kept in their original language.
Where this schema is used
These links are derived from direct references in the protocol snapshot. Follow the calling operation for authentication, accepted fields and runtime behavior; a reusable resource schema is not by itself a complete write request.
Referenced by these component schemas:
Shape and fields
object
| Field | Type / requirement | Description |
|---|---|---|
spaceInvitation | string | The invitation resource. Format: spaces/{space}/invitations/{username} |
space | allOf Space | The read-only Space summary carried by the invitation. |
role | string (enum)ROLE_UNSPECIFIED · ADMIN · USER | The role the invitation offers. |
state | string (enum)STATE_UNSPECIFIED · PENDING · ACCEPTED | The current state of the invitation for the receiver. |
Complete schema
Use this complete JSON definition for constraints and nested structure. A field's presence here does not mean it is writable by every caller.
{
"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"
}
}
}