Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/templates/zerver/api/update-user-group.md

33 lines
693 B
Markdown
Raw Normal View History

api docs: Improve headings and organization for endpoints. Mostly, this is a change in ordering to make more sense, but we also fix several names that were clearly confusing. We restore the convention that each endpoint has the same title at the top of the page as what we have in the sidebar menu, which appears to have been violated in many recent updates to API documentation.
2020-06-19 07:30:42 +02:00
# Update a user group
api_docs: Add documentation for update_user_group.
2019-06-25 21:43:53 +02:00
api docs: Rename 'group_id' to 'user_group_id'. This renames 'group_id' to 'user_group_id' in the api docs to remove the naming mismatch between the url config and the docs and eventually remove the 'user_groups' endpoints from 'pending_endpoints' in test_openapi.py.
2020-07-16 20:39:53 +02:00
{generate_api_description(/user_groups/{user_group_id}:patch)}
api_docs: Add documentation for update_user_group.
2019-06-25 21:43:53 +02:00
## Usage examples
{start_tabs}
{tab|python}
api docs: Rename 'group_id' to 'user_group_id'. This renames 'group_id' to 'user_group_id' in the api docs to remove the naming mismatch between the url config and the docs and eventually remove the 'user_groups' endpoints from 'pending_endpoints' in test_openapi.py.
2020-07-16 20:39:53 +02:00
{generate_code_example(python)|/user_groups/{user_group_id}:patch|example}
api_docs: Add documentation for update_user_group.
2019-06-25 21:43:53 +02:00
{tab|curl}
api docs: Rename 'group_id' to 'user_group_id'. This renames 'group_id' to 'user_group_id' in the api docs to remove the naming mismatch between the url config and the docs and eventually remove the 'user_groups' endpoints from 'pending_endpoints' in test_openapi.py.
2020-07-16 20:39:53 +02:00
{generate_code_example(curl)|/user_groups/{user_group_id}:patch|example}
api_docs: Add documentation for update_user_group.
2019-06-25 21:43:53 +02:00
{end_tabs}
openapi_docs: Replace `argument` with `parameter`. The term `parameter` is a better word than `argument` for data passed to an API endpoint; this is why OpenAPI uses in their terminology. Replace `argument` with `parameter` in the API docs to improve their readability. Fixes #15435.
2020-06-18 15:35:25 +02:00
## Parameters
api_docs: Add documentation for update_user_group.
2019-06-25 21:43:53 +02:00
api docs: Rename 'group_id' to 'user_group_id'. This renames 'group_id' to 'user_group_id' in the api docs to remove the naming mismatch between the url config and the docs and eventually remove the 'user_groups' endpoints from 'pending_endpoints' in test_openapi.py.
2020-07-16 20:39:53 +02:00
{generate_api_arguments_table|zulip.yaml|/user_groups/{user_group_id}:patch}
api_docs: Add documentation for update_user_group.
2019-06-25 21:43:53 +02:00
## Response
#### Example response
A typical successful JSON response may look like:
api docs: Rename 'group_id' to 'user_group_id'. This renames 'group_id' to 'user_group_id' in the api docs to remove the naming mismatch between the url config and the docs and eventually remove the 'user_groups' endpoints from 'pending_endpoints' in test_openapi.py.
2020-07-16 20:39:53 +02:00
{generate_code_example|/user_groups/{user_group_id}:patch|fixture(200)}
api_docs: Add documentation for update_user_group.
2019-06-25 21:43:53 +02:00
An example JSON response when the user group ID is invalid:
api docs: Rename 'group_id' to 'user_group_id'. This renames 'group_id' to 'user_group_id' in the api docs to remove the naming mismatch between the url config and the docs and eventually remove the 'user_groups' endpoints from 'pending_endpoints' in test_openapi.py.
2020-07-16 20:39:53 +02:00
{generate_code_example|/user_groups/{user_group_id}:patch|fixture(400)}