CodeCow/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2026-07-09 21:21:47 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
1fa82c2fcd
zulip/templates/zerver/api/get-server-settings.md
Suyash Vardhan Mathur 1fa82c2fcd apidocs: Fix response in API templates. 
Now, the descriptions and all subschemas
are directly returned just by
`generate_code_example`, and so, these individual
subschemas and descriptions can be removed from the
templates.

All API endpoints docs are exactly the same after the
change, except few where missing 400 responses got added
due to the modification
2021-06-09 12:43:12 -07:00

1.2 KiB
Raw Blame History

{generate_api_title(/server_settings:get)}

{generate_api_description(/server_settings:get)}

Usage examples

{start_tabs} {tab|python}

{generate_code_example(python)|/server_settings:get|example}

{tab|curl}

{generate_code_example(curl)|/server_settings:get|example}

{end_tabs}

Parameters

{generate_api_arguments_table|zulip.yaml|/server_settings:get}

Response

Return values

{generate_return_values_table|zulip.yaml|/server_settings:get}

Please note that not all of these attributes are guaranteed to appear in a response, for two reasons:

  • This endpoint has evolved over time, so responses from older Zulip servers might be missing some keys (in which case a client should assume the appropriate default).
  • If a /server_settings request is made to the root domain of a multi-subdomain server, like the root domain of zulip.com, the settings that are realm-specific are not known and thus not provided.

Example response

{generate_code_example|/server_settings:get|fixture(200)}

{generate_code_example|/server_settings:get|fixture(400)}