discourse/spec/requests/api/schemas/json/topic_create_request.json
Blake Erickson 5c84f702b0
DEV: Update api docs to deprecate target_usernames field (#12394)
When creating a PM target_usernames has been deprecated for some time
now but the api docs have yet to reflect this.

The api docs now specify to use target_recipients.

See: eef21625c6
2021-03-12 16:48:39 -07:00

43 lines
1008 B
JSON

{
"additionalProperties": false,
"properties": {
"title": {
"type": "string",
"description": "Required if creating a new topic or new private message."
},
"raw": {
"type": "string"
},
"topic_id": {
"type": "integer",
"description": "Required if creating a new post."
},
"category": {
"type": "integer",
"description": "Optional if creating a new topic, and ignored if creating a new post."
},
"target_recipients": {
"type": "string",
"description": "Required for private message, comma separated.",
"example": "blake,sam"
},
"target_usernames": {
"type": "string",
"description": "Deprecated. Use target_recipients instead.",
"deprecated": true
},
"archetype": {
"type": "string",
"description": "Required for new private message.",
"example": "private_message"
},
"created_at": {
"type": "string"
}
},
"required": [
"raw"
]
}