diff --git a/templates/zerver/api/arguments.json b/templates/zerver/api/arguments.json index 0675206918..89a468940d 100644 --- a/templates/zerver/api/arguments.json +++ b/templates/zerver/api/arguments.json @@ -78,5 +78,13 @@ "required":"Required", "example":"Denmark" } + ], + "render-message.md":[ + { + "argument":"content", + "description":"The content of the message.", + "required":"Required", + "example":"**foo**" + } ] } diff --git a/templates/zerver/api/render-message.md b/templates/zerver/api/render-message.md new file mode 100644 index 0000000000..a0990ea2a2 --- /dev/null +++ b/templates/zerver/api/render-message.md @@ -0,0 +1,80 @@ +# Render message + +Render a message to HTML. + +`POST {{ api_url }}/v1/messages/render` + +## Arguments + +{generate_api_arguments_table|arguments.json|render-message.md} + +## Usage examples +
foo
' +} +``` + +A typical JSON response for when the required argument `content` +is not supplied: + +``` +{ + 'code':'REQUEST_VARIABLE_MISSING', + 'result':'error', + 'msg':"Missing 'content' argument", + 'var_name':'content' +} +``` + +{!invalid-api-key-json-response.md!} diff --git a/templates/zerver/api/sidebar.md b/templates/zerver/api/sidebar.md index 4a8bc00c08..452f56eb2a 100644 --- a/templates/zerver/api/sidebar.md +++ b/templates/zerver/api/sidebar.md @@ -7,6 +7,7 @@ * [Stream message](/api/stream-message) * [Private message](/api/private-message) +* [Render message](/api/render-message) #### Streams