paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-02 13:03:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

api-docs: Revise authentication_methods realm setting description.

Browse Source 
Extends the description of the authentication_methods realm setting
in the /api/get-events and /api/register-queue endpoints to clarify
the recommended use of the object is for implementing server settings
UI, and to note the data returned by the /api/server-settings
endpoint should be used for implementing authentication UI.
This commit is contained in:
Chris Bobbe
2024-01-22 15:14:56 -08:00
committed by Tim Abbott
parent 8adc3aa64a
commit 3707999f79
1 changed files with 16 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
zerver/openapi/zulip.yaml
View File

@@ -4133,9 +4133,14 @@ paths:
is enabled in this organization.
type: boolean
description: |
Dictionary of 'authentication_method_name': 'boolean' with each
entry describing whether the authentication name can be used for
authenticating into the organization.
Dictionary of authentication method keys with boolean values that
describe whether the named authentication method is enabled for the
organization.
Clients should use this to implement server-settings UI to change which
methods are enabled for the organization. For authentication UI itself,
clients should use the pre-authentication metadata returned by
[`GET /server_settings`](/api/get-server-settings).
bot_creation_policy:
type: integer
description: |
@@ -14273,9 +14278,14 @@ paths:
description: |
Present if `realm` is present in `fetch_event_types`.
Dictionary of 'authentication_method_name': 'boolean' with each
entry describing whether the authentication name can be used for
authenticating into the organization.
Dictionary of authentication method keys with boolean values that
describe whether the named authentication method is enabled for the
organization.
Clients should use this to implement server-settings UI to change which
methods are enabled for the organization. For authentication UI itself,
clients should use the pre-authentication metadata returned by
[`GET /server_settings`](/api/get-server-settings).
realm_allow_message_editing:
type: boolean
description: |