David Rosa
1be4e10a2d
docs: Explain link sharing in /api/upload-file.
...
Rewrittten by tabbott to clearly explain the security model, and add a
code example.
2019-12-02 12:01:46 -08:00
Tim Abbott
bf117fed96
api docs: Fix link to client libraries.
...
This should have been caught by CI.
2019-11-22 11:08:44 -08:00
David Rosa
1c45e4ac11
docs: Add top level page for language bindings.
...
Lists API client bindings/libraries/wrappers and makes a distinction
between official core projects and community projects.
Tweaked by tabbott to sort the community and outdated libraries, and
restructure how we talk about other projects.
Fixes #2093 .
2019-11-22 04:33:18 -08:00
Mateusz Mandera
b05a0d0177
social_backends: If no icon is to be displayed, set display_icon to None.
2019-11-05 15:44:07 -08:00
Tim Abbott
399acea755
outgoing webhooks: Call finalize_payload on payloads.
...
Apparently, the refactor months ago that introduced finalize_payload
wasn't applied to the outgoing webhook code path, resulting in message
dicts with an unexpected format with no avatar_url and some extra
values that were intended to be internal details not relevant to
external clients.
Because this API is not widely used, we expect there to be little to
no impact of converting this back to matching the `get_messages`
interface, as it once was and has always been intended to be.
The one somewhat tricky detail is that we include both the `content`
and `rendered_content` fields, rather than asking the client to pick
which they want via the `apply_markdown` flag, because there is no
place for the client to configure that setting.
2019-11-05 12:26:33 -08:00
Mateusz Mandera
34a540bacb
context: Rename social_backends to external_authentication_methods.
...
The main purpose of this is to make that name change happen in
/server_settings. external_authentication_methods is a much better, more
descriptive name than social_backends from API perspective.
2019-11-03 15:55:44 -08:00
Mateusz Mandera
15126dbe31
docs: Describe the name field of social_backends in /server_settings.
2019-11-03 15:54:05 -08:00
Mateusz Mandera
5a39e70bce
social_backends: Remove sort_order from social backend dicts.
...
These are returned through the API, at the /server_settings
endpoint. It's better to just return the list of dicts with a guarantee
of being sorted in the correct order, than to clutter things with the
sort_order field.
2019-11-03 15:51:49 -08:00
Mateusz Mandera
f229839022
docs: Document social_backends in /server_settings.
...
This updates the docs for the /server_settings endpoint to document the
newly added social_backends structure.
2019-10-29 15:57:29 -07:00
Vishnu KS
f2242c1487
docs: Make update-notification-settings use curl example system.
2019-10-21 17:10:35 +05:30
Vishnu KS
0af7aa8db3
docs: Make update-stream use curl example system.
...
new_name and description params should be valid JSON
strings. The format of these params are marked as
json so that the curl example genenrator can convert
them into json strings.
2019-10-18 13:45:30 -07:00
Vishnu Ks
e96d96b6e4
docs: Add curl example to upload-file.
2019-10-18 13:45:30 -07:00
Vishnu Ks
9ac77a8734
docs: Make upload-custom-emoji use curl example system.
2019-10-18 13:45:30 -07:00
Vishnu Ks
ca44143014
docs: Make render-message use curl example system.
2019-10-15 15:53:03 -07:00
Vishnu Ks
8ffdbdb9bd
docs: Make dev-fetch-api-key use curl example system.
2019-10-15 15:53:03 -07:00
Vishnu Ks
1a0a282242
docs: Make delete-queue use curl example system.
2019-10-15 15:53:03 -07:00
Vishnu Ks
f7add25cc2
docs: Make get-events-from-queue use curl example system.
2019-10-15 15:53:03 -07:00
Vishnu Ks
33f7ae7766
docs: Make register-queue use curl example system.
2019-10-15 15:53:03 -07:00
Vishnu Ks
a42ef542d2
docs: Make get-org-emoji use curl example system.
2019-10-15 15:53:03 -07:00
Vishnu Ks
0b297fc092
docs: Make remove-linkifiers use curl example system.
2019-10-15 15:53:03 -07:00
Vishnu Ks
16dfc772fb
docs: Make add-linkifiers use curl example system.
2019-10-15 15:53:03 -07:00
Vishnu Ks
3cf939a8a4
docs: Make list-linkifiers use curl example system.
2019-10-15 15:53:03 -07:00
Vishnu Ks
a20b399321
docs: Add is_incompatible key to server-settings response.
2019-10-15 15:53:03 -07:00
Vishnu Ks
616502fd37
docs: Remove realm_logo and realm_night_logo from server-settings response.
...
They were removed in 16123c9a58
2019-10-15 15:53:03 -07:00
Vishnu Ks
573d470fd6
docs: Make server-settings use curl example system.
2019-10-15 15:53:03 -07:00
Vishnu Ks
6a5fdcabbd
docs: Make delete-user-group use curl example system.
2019-10-15 15:53:03 -07:00
Vishnu Ks
d1540f7e10
docs: Make update-user-group use curl example system.
2019-10-15 15:53:03 -07:00
Vishnu Ks
c5d6be4df7
docs: Make create-user-group use curl example system.
2019-10-15 15:53:03 -07:00
Vishnu KS
70e8f5ce8a
docs: Make get-user-groups use curl example system.
2019-10-15 15:53:03 -07:00
Vishnu KS
519b24061d
docs: Update the response schema of get-presence.
...
The response no longer contains pushable and client keys.
2019-10-15 15:53:03 -07:00
Vishnu KS
503e65079a
docs: Make get-presence use curl example system.
2019-10-15 15:53:03 -07:00
Vishnu Ks
6f59a17bfe
docs: Make typing use curl example system.
2019-10-15 15:53:03 -07:00
Vishnu Ks
af83884f6f
docs: Make create-user use curl example system.
2019-10-15 15:53:02 -07:00
Vishnu Ks
2a8065963e
docs: Make get-profile use curl example system.
2019-10-15 15:40:44 -07:00
Vishnu Ks
b68b566711
docs: Make get-all-users use curl example system.
2019-10-15 15:40:44 -07:00
Vishnu Ks
ea06dc6ab3
docs: Make delete-stream use curl example system.
2019-10-15 15:40:44 -07:00
Vishnu Ks
8b29f52d09
docs: Make get-stream-id use curl example system.
2019-10-15 15:40:44 -07:00
Vishnu Ks
04cc121b77
docs: Make mute-topics.md use curl example system.
2019-10-15 15:40:44 -07:00
Vishnu Ks
13bdfc0ef8
docs: Make get-stream-topics use curl example system.
2019-10-15 15:40:44 -07:00
Vishnu Ks
ad16c55c77
docs: Make remove-subscriptions use curl example system.
2019-10-15 15:40:44 -07:00
Vishnu Ks
4364e31d69
docs: Make update-subscription-properties use curl example system.
2019-10-15 15:40:44 -07:00
Vishnu Ks
06883dc4b2
docs: Make add-subscriptions use curl example system.
2019-10-15 15:40:44 -07:00
Vishnu Ks
94d31e9d4f
docs: Make get-subscribed-streams use curl example system.
2019-10-15 15:40:44 -07:00
Vishnu Ks
9442422da1
docs: Make get-all-streams use curl example system.
2019-10-15 15:40:44 -07:00
Vishnu Ks
3f9835ed07
docs: Make mark-as-read-bulk use curl example system.
2019-10-15 15:40:44 -07:00
Vishnu Ks
f0b099dbc0
docs: Make update-message-flags use curl example system.
2019-10-15 15:40:44 -07:00
Vishnu Ks
19ee518f2e
docs: Make get-message-history use curl example system.
2019-10-15 15:40:44 -07:00
Vishnu Ks
ed2e89f167
docs: Make delete-message use curl example system.
2019-10-15 15:40:44 -07:00
Vishnu Ks
0dccebbe39
docs: Make update-message use curl example system.
2019-10-15 15:40:44 -07:00
Vishnu KS
9bc3594f75
docs: Make get-raw-message use curl example system.
2019-10-15 15:40:44 -07:00