mirror of
https://github.com/zulip/zulip.git
synced 2025-11-14 10:57:58 +00:00
api docs: Change Shakespeare quote.
The previous quote doesn't come off well if you don't know the reference (which the majority of our users will not).
This commit is contained in:
Binary file not shown.
|
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 54 KiB |
@@ -29,7 +29,7 @@ zulip(config).then((client) => {
|
|||||||
to: 'Denmark',
|
to: 'Denmark',
|
||||||
type: 'stream',
|
type: 'stream',
|
||||||
subject: 'Castle',
|
subject: 'Castle',
|
||||||
content: 'Something is rotten in the state of Denmark.'
|
content: 'I come not, friends, to steal away your hearts.'
|
||||||
}
|
}
|
||||||
|
|
||||||
client.messages.send(params).then(console.log);
|
client.messages.send(params).then(console.log);
|
||||||
@@ -41,7 +41,7 @@ zulip(config).then((client) => {
|
|||||||
const params = {
|
const params = {
|
||||||
to: 'hamlet@example.com',
|
to: 'hamlet@example.com',
|
||||||
type: 'private',
|
type: 'private',
|
||||||
content: 'I come not, friends, to steal away your hearts.',
|
content: 'With mirth and laughter let old wrinkles come.',
|
||||||
}
|
}
|
||||||
|
|
||||||
client.messages.send(params).then(console.log);
|
client.messages.send(params).then(console.log);
|
||||||
@@ -58,14 +58,14 @@ curl {{ api_url }}/v1/messages \
|
|||||||
-d "type=stream" \
|
-d "type=stream" \
|
||||||
-d "to=Denmark" \
|
-d "to=Denmark" \
|
||||||
-d "subject=Castle" \
|
-d "subject=Castle" \
|
||||||
-d $"content=Something is rotten in the state of Denmark."
|
-d $"content=I come not, friends, to steal away your hearts."
|
||||||
|
|
||||||
# For private messages
|
# For private messages
|
||||||
curl {{ api_url }}/v1/messages \
|
curl {{ api_url }}/v1/messages \
|
||||||
-u BOT_EMAIL_ADDRESS:BOT_API_KEY \
|
-u BOT_EMAIL_ADDRESS:BOT_API_KEY \
|
||||||
-d "type=private" \
|
-d "type=private" \
|
||||||
-d "to=hamlet@example.com" \
|
-d "to=hamlet@example.com" \
|
||||||
-d $"content=I come not, friends, to steal away your hearts."
|
-d $"content=With mirth and laughter let old wrinkles come."
|
||||||
```
|
```
|
||||||
|
|
||||||
{tab|zulip-send}
|
{tab|zulip-send}
|
||||||
@@ -92,7 +92,7 @@ If you'd like, you can also provide the message on the command-line with the
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
zulip-send --stream Denmark --subject Castle \
|
zulip-send --stream Denmark --subject Castle \
|
||||||
--message "Something is rotten in the state of Denmark." \
|
--message "I come not, friends, to steal away your hearts." \
|
||||||
--user othello-bot@example.com --api-key a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5
|
--user othello-bot@example.com --api-key a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -451,7 +451,7 @@ def send_message(client):
|
|||||||
"type": "stream",
|
"type": "stream",
|
||||||
"to": "Denmark",
|
"to": "Denmark",
|
||||||
"subject": "Castle",
|
"subject": "Castle",
|
||||||
"content": "Something is rotten in the state of Denmark."
|
"content": "I come not, friends, to steal away your hearts."
|
||||||
}
|
}
|
||||||
result = client.send_message(request)
|
result = client.send_message(request)
|
||||||
# {code_example|end}
|
# {code_example|end}
|
||||||
@@ -473,7 +473,7 @@ def send_message(client):
|
|||||||
request = {
|
request = {
|
||||||
"type": "private",
|
"type": "private",
|
||||||
"to": "iago@zulip.com",
|
"to": "iago@zulip.com",
|
||||||
"content": "I come not, friends, to steal away your hearts."
|
"content": "With mirth and laughter let old wrinkles come."
|
||||||
}
|
}
|
||||||
result = client.send_message(request)
|
result = client.send_message(request)
|
||||||
# {code_example|end}
|
# {code_example|end}
|
||||||
@@ -498,7 +498,7 @@ def test_nonexistent_stream_error(client):
|
|||||||
"type": "stream",
|
"type": "stream",
|
||||||
"to": "nonexistent_stream",
|
"to": "nonexistent_stream",
|
||||||
"subject": "Castle",
|
"subject": "Castle",
|
||||||
"content": "Something is rotten in the state of Denmark."
|
"content": "I come not, friends, to steal away your hearts."
|
||||||
}
|
}
|
||||||
result = client.send_message(request)
|
result = client.send_message(request)
|
||||||
|
|
||||||
@@ -510,7 +510,7 @@ def test_private_message_invalid_recipient(client):
|
|||||||
request = {
|
request = {
|
||||||
"type": "private",
|
"type": "private",
|
||||||
"to": "eeshan@zulip.com",
|
"to": "eeshan@zulip.com",
|
||||||
"content": "I come not, friends, to steal away your hearts."
|
"content": "With mirth and laughter let old wrinkles come."
|
||||||
}
|
}
|
||||||
result = client.send_message(request)
|
result = client.send_message(request)
|
||||||
|
|
||||||
@@ -551,7 +551,7 @@ def test_update_message_edit_permission_error(client, nonadmin_client):
|
|||||||
"type": "stream",
|
"type": "stream",
|
||||||
"to": "Denmark",
|
"to": "Denmark",
|
||||||
"subject": "Castle",
|
"subject": "Castle",
|
||||||
"content": "Something is rotten in the state of Denmark."
|
"content": "I come not, friends, to steal away your hearts."
|
||||||
}
|
}
|
||||||
result = client.send_message(request)
|
result = client.send_message(request)
|
||||||
|
|
||||||
@@ -581,7 +581,7 @@ def test_delete_message_edit_permission_error(client, nonadmin_client):
|
|||||||
"type": "stream",
|
"type": "stream",
|
||||||
"to": "Denmark",
|
"to": "Denmark",
|
||||||
"subject": "Castle",
|
"subject": "Castle",
|
||||||
"content": "Something is rotten in the state of Denmark."
|
"content": "I come not, friends, to steal away your hearts."
|
||||||
}
|
}
|
||||||
result = client.send_message(request)
|
result = client.send_message(request)
|
||||||
|
|
||||||
@@ -618,7 +618,7 @@ def update_message_flags(client):
|
|||||||
"type": "stream",
|
"type": "stream",
|
||||||
"to": "Denmark",
|
"to": "Denmark",
|
||||||
"subject": "Castle",
|
"subject": "Castle",
|
||||||
"content": "Something is rotten in the state of Denmark."
|
"content": "I come not, friends, to steal away your hearts."
|
||||||
} # type: Dict[str, Any]
|
} # type: Dict[str, Any]
|
||||||
message_ids = []
|
message_ids = []
|
||||||
for i in range(0, 3):
|
for i in range(0, 3):
|
||||||
|
|||||||
@@ -104,7 +104,7 @@ paths:
|
|||||||
"message": {
|
"message": {
|
||||||
"avatar_url": "https://url/for/othello-bots/avatar",
|
"avatar_url": "https://url/for/othello-bots/avatar",
|
||||||
"client": "website",
|
"client": "website",
|
||||||
"content": "Something is rotten in the state of Denmark.",
|
"content": "I come not, friends, to steal away your hearts.",
|
||||||
"content_type": "text/x-markdown",
|
"content_type": "text/x-markdown",
|
||||||
"display_recipient": "Denmark",
|
"display_recipient": "Denmark",
|
||||||
"id": 12345678,
|
"id": 12345678,
|
||||||
@@ -126,7 +126,7 @@ paths:
|
|||||||
"message": {
|
"message": {
|
||||||
"avatar_url": "https://url/for/othello-bots/avatar",
|
"avatar_url": "https://url/for/othello-bots/avatar",
|
||||||
"client": "website",
|
"client": "website",
|
||||||
"content": "I come not, friends, to steal away your hearts.",
|
"content": "With mirth and laughter let old wrinkles come.",
|
||||||
"content_type": "text/x-markdown",
|
"content_type": "text/x-markdown",
|
||||||
"display_recipient": [
|
"display_recipient": [
|
||||||
{
|
{
|
||||||
|
|||||||
Reference in New Issue
Block a user