Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

api: Fix incorrectly documented event types. 

It's actually "subscription" and "message" (neither is plural).

While we're at it, we should also remove the "pointer" event type,
since that's of generally low interest.
This commit is contained in:
Tim Abbott 2018-04-27 15:12:30 -07:00
parent 7d14ce2cb6
commit be3804f505
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
templates/zerver/api/arguments.json
View File

@ -110,7 +110,7 @@
},
{
"argument": "event_types",
"description": "A JSON-encoded array indicating which types of events you're interested in. Values that you might find useful include: <br/> <br/> * **messages** (messages), <br/> * **subscriptions** (changes in your subscriptions), <br/> * **realm_user** (changes in the list of users in your realm), and <br/> * **pointer** (changes in your pointer). <br/> <br/> If you do not specify this argument, you will receive all events, and have to filter out the events not relevant to your client in your client code. For most applications, one is only interested in messages, so one specifies: `event_types=['message']`",
"description": "A JSON-encoded array indicating which types of events you're interested in. Values that you might find useful include: <br/> <br/> * **message** (messages), <br/> * **subscription** (changes in your subscriptions), <br/> * **realm_user** (changes in the list of users in your realm) <br/> <br/> If you do not specify this argument, you will receive all events, and have to filter out the events not relevant to your client in your client code. For most applications, one is only interested in messages, so one specifies: `event_types=['message']`",
"required": "Optional",
"example": "event_types=['message']"
},
@ -168,7 +168,7 @@
},
{
"argument": "event_types",
"description": "A JSON-encoded array indicating which types of events you're interested in. Values that you might find useful include: <br/> <br/> * **messages** (messages), <br/> * **subscriptions** (changes in your subscriptions), <br/> * **realm_user** (changes in the list of users in your realm), and <br/> * **pointer** (changes in your pointer). <br/> <br/> If you do not specify this argument, you will receive all events, and have to filter out the events not relevant to your client in your client code. For most applications, one is only interested in messages, so one specifies: `event_types=['message']`",
"description": "A JSON-encoded array indicating which types of events you're interested in. Values that you might find useful include: <br/> <br/> * **message** (messages), <br/> * **subscription** (changes in your subscriptions), <br/> * **realm_user** (changes in the list of users in your realm)<br/> <br/> If you do not specify this argument, you will receive all events, and have to filter out the events not relevant to your client in your client code. For most applications, one is only interested in messages, so one specifies: `event_types=['message']`",
"required": "Optional",
"example": "event_types=['message']"
}