Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/templates/zerver/api/get-own-user.md

39 lines
661 B
Markdown
Raw Normal View History

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-19 07:30:42 +02:00
# Get own user
api docs: Document the GET /api/v1/users/me endpoint. Note that there is no JavaScript equivalent for requesting this endpoint in zulip-js yet.
2018-01-05 22:31:56 +01:00
openapi: Use description markdown for rendering endpoint descriptions. Firstly, change endpoint descriptions in zulip.yaml so that they match their counterpart in the api docs. Then edit the api docs so that they use api description markdown extension for displaying endpoint description.
2020-04-28 20:00:46 +02:00
{generate_api_description(/users/me:get)}
api docs: Document the GET /api/v1/users/me endpoint. Note that there is no JavaScript equivalent for requesting this endpoint in zulip-js yet.
2018-01-05 22:31:56 +01:00
## Usage examples
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
{start_tabs}
{tab|python}
api docs: Document the GET /api/v1/users/me endpoint. Note that there is no JavaScript equivalent for requesting this endpoint in zulip-js yet.
2018-01-05 22:31:56 +01:00
openapi: Remove /users/me from pending endpoints. This commit progress our efforts to reduce pending_endpoints as well as to migrate away from templates/zerver/api/fixtures and towards our OpenAPI documentation. Similar to commit d62b75fc.
2019-08-04 13:08:36 +02:00
{generate_code_example(python)|/users/me:get|example}
api docs: Document the GET /api/v1/users/me endpoint. Note that there is no JavaScript equivalent for requesting this endpoint in zulip-js yet.
2018-01-05 22:31:56 +01:00
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
{tab|js}
api docs: Document the GET /api/v1/users/me endpoint. Note that there is no JavaScript equivalent for requesting this endpoint in zulip-js yet.
2018-01-05 22:31:56 +01:00
api/get-profile: Add JavaScript example.
2018-01-13 23:34:34 +01:00
More examples and documentation can be found [here](https://github.com/zulip/zulip-js).
js_examples: Migrate and test get_own_user example.
2020-06-21 21:58:07 +02:00
{generate_code_example(javascript)|/users/me:get|example}
api/get-profile: Add JavaScript example.
2018-01-13 23:34:34 +01:00
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
{tab|curl}
docs: Make get-profile use curl example system.
2019-10-11 14:52:41 +02:00
{generate_code_example(curl)|/users/me:get|example}
api docs: Document the GET /api/v1/users/me endpoint. Note that there is no JavaScript equivalent for requesting this endpoint in zulip-js yet.
2018-01-05 22:31:56 +01:00
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
{end_tabs}
api docs: Document the GET /api/v1/users/me endpoint. Note that there is no JavaScript equivalent for requesting this endpoint in zulip-js yet.
2018-01-05 22:31:56 +01:00
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 15:35:25 +02:00
## Parameters
api docs: Move code examples farther up.
2018-01-20 22:03:05 +01:00
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 15:35:25 +02:00
This endpoint takes no parameters.
api docs: Move code examples farther up.
2018-01-20 22:03:05 +01:00
api docs: Document the GET /api/v1/users/me endpoint. Note that there is no JavaScript equivalent for requesting this endpoint in zulip-js yet.
2018-01-05 22:31:56 +01:00
## Response
#### Return values
openapi: Add markdown extension for rendering return values in API docs. Currently response return values have to be written twice, once in the docs and once in zulip.yaml. Create a markdown extension so that the return values in api docs are rendered using content from zulip.yaml
2020-05-20 11:57:57 +02:00
{generate_return_values_table|zulip.yaml|/users/me:get}
api docs: Document the GET /api/v1/users/me endpoint. Note that there is no JavaScript equivalent for requesting this endpoint in zulip-js yet.
2018-01-05 22:31:56 +01:00
#### Example response
A typical successful JSON response may look like:
openapi: Remove /users/me from pending endpoints. This commit progress our efforts to reduce pending_endpoints as well as to migrate away from templates/zerver/api/fixtures and towards our OpenAPI documentation. Similar to commit d62b75fc.
2019-08-04 13:08:36 +02:00
{generate_code_example|/users/me:get|fixture(200)}