zulip

Commit Graph

Author	SHA1	Message	Date
Tim Abbott	bfc30e4214	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-18 22:38:05 -07:00
orientor	817ee5c6b2	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 09:18:27 -07:00
Kartik Srivastava	8c39ddfd28	api: Add GET /users/{user_id}/subscription/{stream_id} endpoint. This new endpoint returns a 'user' dictionary which, as of now, contains a single key 'is_subscribed' with a boolean value that represents whether the user with the given 'user_id' is subscribed to the stream with the given 'stream_id'. Fixes #14966.	2020-06-10 17:59:14 -07:00

Author

SHA1

Message

Date

Tim Abbott

bfc30e4214

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-18 22:38:05 -07:00

orientor

817ee5c6b2

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 09:18:27 -07:00

Kartik Srivastava

8c39ddfd28

api: Add GET /users/{user_id}/subscription/{stream_id} endpoint.

This new endpoint returns a 'user' dictionary which, as of now,
contains a single key 'is_subscribed' with a boolean value that
represents whether the user with the given 'user_id' is subscribed
to the stream with the given 'stream_id'.

Fixes #14966.

2020-06-10 17:59:14 -07:00

3 Commits