mirror of https://github.com/zulip/zulip.git
api_docs: Correct Zulip 3.0 feature level 1 changelog and notes.
Corrects omissions or inconsistencies between the api changelog and the api documentation for Zulip 3.0, feature level 1, except for the final two bullet points about GitLab authentication and adding None as a video call provider option. The final two bullet points will be addressed in separate commits. Part of work on #22102.
This commit is contained in:
Lauryn Menard
Tim Abbott
parent
c5ebb74280
commit
ddd9cc3ec9
|
|
@ -1019,7 +1019,8 @@ No changes; feature level used for Zulip 3.0 release.
|
||||||
* [`GET /users`](/api/get-users): User objects for bots now
|
* [`GET /users`](/api/get-users): User objects for bots now
|
||||||
contain a `bot_owner_id`, replacing the previous `bot_owner` field
|
contain a `bot_owner_id`, replacing the previous `bot_owner` field
|
||||||
(which had the email address of the bot owner).
|
(which had the email address of the bot owner).
|
||||||
* [`GET /users/{user_id}`](/api/get-user): Endpoint added.
|
* [`GET /users/{user_id}`](/api/get-user): New endpoint added to get
|
||||||
|
a single user's details by the user's ID.
|
||||||
* [`GET /messages`](/api/get-messages): Add support for string-format
|
* [`GET /messages`](/api/get-messages): Add support for string-format
|
||||||
values for the `anchor` parameter, deprecating and replacing the
|
values for the `anchor` parameter, deprecating and replacing the
|
||||||
`use_first_unread_anchor` parameter.
|
`use_first_unread_anchor` parameter.
|
||||||
|
|
@ -1027,24 +1028,26 @@ No changes; feature level used for Zulip 3.0 release.
|
||||||
Message objects now use `topic_links` rather than `subject_links` to
|
Message objects now use `topic_links` rather than `subject_links` to
|
||||||
indicate links either present in the topic or generated by linkifiers
|
indicate links either present in the topic or generated by linkifiers
|
||||||
applied to the topic.
|
applied to the topic.
|
||||||
* [`POST /users/me/subscriptions`](/api/subscribe): Replaced
|
* [`GET /streams`](/api/get-streams),
|
||||||
`is_announcement_only` boolean with `stream_post_policy` enum for
|
[`POST /users/me/subscriptions`](/api/subscribe),
|
||||||
specifying who can post to a stream.
|
[`PATCH /streams/{stream_id}`](/api/update-stream): Stream objects now
|
||||||
* [`PATCH /streams/{stream_id}`](/api/update-stream): Replaced
|
have `stream_post_policy` enum for specifying who can post to the stream,
|
||||||
`is_announcement_only` boolean with `stream_post_policy` enum for
|
deprecating and replacing the `is_announcement_only` boolean.
|
||||||
specifying who can post to a stream.
|
* [`GET /user_uploads/{realm_id_str}/{filename}`](/api/get-file-temporary-url):
|
||||||
* [`GET /streams`](/api/get-streams): Replaced
|
New endpoint added for requesting a temporary URL for an uploaded
|
||||||
`is_announcement_only` boolean with `stream_post_policy` enum for
|
file that does not require authentication to access (e.g. for passing
|
||||||
specifying who can post to a stream.
|
from a Zulip desktop, mobile, or terminal app to the user's default
|
||||||
* `GET /api/v1/user_uploads`: Added new endpoint for requesting a
|
browser).
|
||||||
temporary URL for an uploaded file that does not require
|
* [`POST /register`](/api/register-queue), [`GET /events`](/api/get-events),
|
||||||
authentication to access (e.g. for passing from a Zulip desktop,
|
`PATCH /realm`: Nobody added as an option for the realm setting
|
||||||
mobile, or terminal app to the user's default browser).
|
|
||||||
* Added `EMAIL_ADDRESS_VISIBILITY_NOBODY` possible value for
|
|
||||||
`email_address_visibility`.
|
`email_address_visibility`.
|
||||||
* Added `private_message_policy` realm setting.
|
* [`POST /register`](/api/register-queue), [`GET /events`](/api/get-events),
|
||||||
* `muted_topic` objects now are a 3-item tuple: (`stream_id`, `topic`,
|
`PATCH /realm`: Added realm setting `private_message_policy`.
|
||||||
`date_muted`). Previously, they were a 2-item tuple.
|
* [`POST /register`](/api/register-queue), [`GET /events`](/api/get-events):
|
||||||
|
`muted_topics` array objects now are 3-item tuples that include the
|
||||||
|
stream name, the topic name, and the time when the topic was muted.
|
||||||
|
Previously, they were 2-item tuples and did not include the time when
|
||||||
|
the topic was muted.
|
||||||
* `GitLab` authentication is now available.
|
* `GitLab` authentication is now available.
|
||||||
* Added `None` as a video call provider option.
|
* Added `None` as a video call provider option.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1859,10 +1859,14 @@ paths:
|
||||||
type: array
|
type: array
|
||||||
description: |
|
description: |
|
||||||
Array of tuples, where each tuple describes a muted topic.
|
Array of tuples, where each tuple describes a muted topic.
|
||||||
The first element of tuple is the stream name in which the topic
|
The first element of the tuple is the stream name in which the topic
|
||||||
has to be muted, the second element is the topic name to be muted
|
has to be muted, the second element is the topic name to be muted
|
||||||
and the third element is an integer UNIX timestamp representing
|
and the third element is an integer UNIX timestamp representing
|
||||||
when the topic was muted.
|
when the topic was muted.
|
||||||
|
|
||||||
|
**Changes**: Before Zulip 3.0 (feature level 1), the `muted_topics`
|
||||||
|
array objects were 2-item tuples and did not include the timestamp
|
||||||
|
information for when the topic was muted.
|
||||||
items:
|
items:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
|
|
@ -3782,11 +3786,13 @@ paths:
|
||||||
The [policy][permission-level] for which users in this organization can see
|
The [policy][permission-level] for which users in this organization can see
|
||||||
the real email addresses of other users.
|
the real email addresses of other users.
|
||||||
|
|
||||||
- 1 = everyone
|
- 1 = Everyone
|
||||||
- 2 = members only
|
- 2 = Members only
|
||||||
- 3 = administrators only
|
- 3 = Administrators only
|
||||||
- 4 = nobody (though note that administrators can change this setting).
|
- 4 = Nobody (though note that administrators can change this setting)
|
||||||
- 5 = moderators only
|
- 5 = Moderators only
|
||||||
|
|
||||||
|
**Changes**: Nobody added as an option in Zulip 3.0 (feature level 1).
|
||||||
|
|
||||||
[permission-level]: /api/roles-and-permissions#permission-levels
|
[permission-level]: /api/roles-and-permissions#permission-levels
|
||||||
email_changes_disabled:
|
email_changes_disabled:
|
||||||
|
|
@ -3998,6 +4004,8 @@ paths:
|
||||||
|
|
||||||
- 1 = Everyone
|
- 1 = Everyone
|
||||||
- 2 = Nobody
|
- 2 = Nobody
|
||||||
|
|
||||||
|
**Changes**: New in Zulip 3.0 (feature level 1).
|
||||||
send_welcome_emails:
|
send_welcome_emails:
|
||||||
type: boolean
|
type: boolean
|
||||||
description: |
|
description: |
|
||||||
|
|
@ -6125,6 +6133,8 @@ paths:
|
||||||
tags: ["messages"]
|
tags: ["messages"]
|
||||||
description: |
|
description: |
|
||||||
Get a temporary URL for access to the file that doesn't require authentication.
|
Get a temporary URL for access to the file that doesn't require authentication.
|
||||||
|
|
||||||
|
**Changes**: New in Zulip 3.0 (feature level 1).
|
||||||
parameters:
|
parameters:
|
||||||
- name: realm_id_str
|
- name: realm_id_str
|
||||||
in: path
|
in: path
|
||||||
|
|
@ -9132,6 +9142,8 @@ paths:
|
||||||
type: integer
|
type: integer
|
||||||
description: |
|
description: |
|
||||||
The server's current [Zulip feature level](/api/changelog).
|
The server's current [Zulip feature level](/api/changelog).
|
||||||
|
|
||||||
|
**Changes**: New in Zulip 3.0 (feature level 1).
|
||||||
zulip_version:
|
zulip_version:
|
||||||
type: string
|
type: string
|
||||||
description: |
|
description: |
|
||||||
|
|
@ -9302,10 +9314,14 @@ paths:
|
||||||
Present if `muted_topics` is present in `fetch_event_types`.
|
Present if `muted_topics` is present in `fetch_event_types`.
|
||||||
|
|
||||||
Array of tuples, where each tuple describes a muted topic.
|
Array of tuples, where each tuple describes a muted topic.
|
||||||
The first element of tuple is the stream name in which the topic
|
The first element of the tuple is the stream name in which the topic
|
||||||
has to be muted, the second element is the topic name to be muted
|
has to be muted, the second element is the topic name to be muted
|
||||||
and the third element is an integer UNIX timestamp representing
|
and the third element is an integer UNIX timestamp representing
|
||||||
when the topic was muted.
|
when the topic was muted.
|
||||||
|
|
||||||
|
**Changes**: Before Zulip 3.0 (feature level 1), the `muted_topics`
|
||||||
|
array objects were 2-item tuples and did not include the timestamp
|
||||||
|
information for when the topic was muted.
|
||||||
items:
|
items:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
|
|
@ -10940,11 +10956,13 @@ paths:
|
||||||
The [policy][permission-level] for which users in this organization can see
|
The [policy][permission-level] for which users in this organization can see
|
||||||
the real email addresses of other users.
|
the real email addresses of other users.
|
||||||
|
|
||||||
- 1 = everyone
|
- 1 = Everyone
|
||||||
- 2 = members only
|
- 2 = Members only
|
||||||
- 3 = administrators only
|
- 3 = Administrators only
|
||||||
- 4 = nobody (though note that administrators can change this setting).
|
- 4 = Nobody (though note that administrators can change this setting)
|
||||||
- 5 = moderators only
|
- 5 = Moderators only
|
||||||
|
|
||||||
|
**Changes**: Nobody added as an option in Zulip 3.0 (feature level 1).
|
||||||
|
|
||||||
[permission-level]: /api/roles-and-permissions#permission-levels
|
[permission-level]: /api/roles-and-permissions#permission-levels
|
||||||
realm_email_changes_disabled:
|
realm_email_changes_disabled:
|
||||||
|
|
@ -11154,6 +11172,8 @@ paths:
|
||||||
|
|
||||||
- 1 = Everyone
|
- 1 = Everyone
|
||||||
- 2 = Nobody
|
- 2 = Nobody
|
||||||
|
|
||||||
|
**Changes**: New in Zulip 3.0 (feature level 1).
|
||||||
realm_user_group_edit_policy:
|
realm_user_group_edit_policy:
|
||||||
type: integer
|
type: integer
|
||||||
description: |
|
description: |
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue