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: Document GET /realm/profile_fields endpoint.

Browse Source
This commit is contained in:
Kartik Srivastava
2020-07-03 21:27:22 +05:30
committed by Tim Abbott
parent 94a29f5870
commit f8d6b9755a
3 changed files with 46 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
zerver/openapi/python_examples.py
View File

@@ -275,6 +275,17 @@ def get_realm_filters(client: Client) -> None:
validate_against_openapi_schema(result, '/realm/filters', 'get', '200')
@openapi_test_function("/realm/profile_fields:get")
def get_realm_profile_fields(client: Client) -> None:
# {code_example|start}
# Fetch all the custom profile fields in the user's organization.
result = client.call_endpoint(
url='/realm/profile_fields',
method='GET',
)
# {code_example|end}
validate_against_openapi_schema(result, '/realm/profile_fields', 'get', '200')
@openapi_test_function("/realm/filters:post")
def add_realm_filter(client: Client) -> None:
@@ -1234,6 +1245,7 @@ def test_server_organizations(client: Client) -> None:
remove_realm_filter(client)
get_realm_emoji(client)
upload_custom_emoji(client)
get_realm_profile_fields(client)
def test_errors(client: Client) -> None:
test_missing_request_argument(client)