mirror of
https://gh.wpcy.net/https://github.com/discourse/discourse.git
synced 2026-05-23 14:55:15 +08:00
0f91ce6079
This commit converts the api docs spec for the invite endpoint to use the new json schema file format.
42 lines
1.1 KiB
JSON
Vendored
42 lines
1.1 KiB
JSON
Vendored
{
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"email": {
|
|
"type": "string",
|
|
"example": "not-a-user-yet@example.com",
|
|
"description": "required for email invites only"
|
|
},
|
|
"skip_email": {
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"custom_message": {
|
|
"type": "string",
|
|
"description": "optional, for email invites"
|
|
},
|
|
"max_redemptions_allowed": {
|
|
"type": "integer",
|
|
"example": 5,
|
|
"default": 1,
|
|
"description": "optional, for link invites"
|
|
},
|
|
"topic_id": {
|
|
"type": "integer"
|
|
},
|
|
"group_ids": {
|
|
"type": "string",
|
|
"description": "Optional, either this or `group_names`. Comma separated list for multiple ids.",
|
|
"example": "42,43"
|
|
},
|
|
"group_names": {
|
|
"type": "string",
|
|
"description": "Optional, either this or `group_ids`. Comma separated list for multiple names.",
|
|
"example": "foo,bar"
|
|
},
|
|
"expires_at": {
|
|
"type": "string",
|
|
"description": "optional, if not supplied, the invite_expiry_days site setting is used"
|
|
}
|
|
}
|
|
}
|
