paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-05 06:23:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

api docs: Rename 'group_id' to 'user_group_id'.

Browse Source 
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.
This commit is contained in:
Kartik Srivastava
2020-07-17 00:09:53 +05:30
committed by Tim Abbott
parent b9b9a79382
commit 7677ba2d2b
6 changed files with 35 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
zerver/openapi/python_examples.py
View File

@@ -1102,11 +1102,11 @@ def create_user_group(client: Client) -> None:
assert result['result'] == 'success'
@openapi_test_function("/user_groups/{group_id}:patch")
def update_user_group(client: Client, group_id: int) -> None:
@openapi_test_function("/user_groups/{user_group_id}:patch")
def update_user_group(client: Client, user_group_id: int) -> None:
# {code_example|start}
request = {
'group_id': group_id,
'group_id': user_group_id,
'name': 'marketing',
'description': 'The marketing team.',
}
@@ -1115,21 +1115,21 @@ def update_user_group(client: Client, group_id: int) -> None:
# {code_example|end}
assert result['result'] == 'success'
@openapi_test_function("/user_groups/{group_id}:delete")
def remove_user_group(client: Client, group_id: int) -> None:
@openapi_test_function("/user_groups/{user_group_id}:delete")
def remove_user_group(client: Client, user_group_id: int) -> None:
# {code_example|start}
result = client.remove_user_group(group_id)
result = client.remove_user_group(user_group_id)
# {code_example|end}
validate_against_openapi_schema(result, '/user_groups/{group_id}', 'delete', '200')
validate_against_openapi_schema(result, '/user_groups/{user_group_id}', 'delete', '200')
assert result['result'] == 'success'
@openapi_test_function("/user_groups/{group_id}/members:post")
def update_user_group_members(client: Client, group_id: int) -> None:
@openapi_test_function("/user_groups/{user_group_id}/members:post")
def update_user_group_members(client: Client, user_group_id: int) -> None:
ensure_users([8, 10, 11], ['cordelia', 'hamlet', 'iago'])
request = {
'group_id': group_id,
'group_id': user_group_id,
'delete': [8, 10],
'add': [11],
}
@@ -1235,10 +1235,10 @@ def test_users(client: Client) -> None:
update_presence(client)
get_user_presence(client)
create_user_group(client)
group_id = get_user_groups(client)
update_user_group(client, group_id)
update_user_group_members(client, group_id)
remove_user_group(client, group_id)
user_group_id = get_user_groups(client)
update_user_group(client, user_group_id)
update_user_group_members(client, user_group_id)
remove_user_group(client, user_group_id)
get_alert_words(client)
add_alert_words(client)
remove_alert_words(client)