Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

apidocs: Fix playground URLs and operationIDs. 

We standardized on "Code playground" for this feature, so use that
in the URLs and API documentation.
This commit is contained in:
Suyash Vardhan Mathur 2021-05-23 13:34:50 +05:30 committed by Tim Abbott
parent cb8d9a1f8a
commit b41be98c42
5 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
templates/zerver/api/add-playground.md → templates/zerver/api/add-code-playground.md
View File

10
templates/zerver/api/changelog.md
View File

@ -162,14 +162,14 @@ field with an integer field `invite_to_realm_policy`.
**Feature level 49** **Feature level 49**
* Added new [`POST /realm/playground`](/api/add-playground) and * Added new [`POST /realm/playground`](/api/add-code-playground) and
[`DELETE /realm/playground/{playground_id}`](/api/remove-playground) [`DELETE /realm/playground/{playground_id}`](/api/remove-code-playground)
endpoints for realm playgrounds. endpoints for code playgrounds.
* [`GET /events`](/api/get-events): A new `realm_playgrounds` events * [`GET /events`](/api/get-events): A new `realm_playgrounds` events
is sent when changes are made to a set of configured playgrounds for is sent when changes are made to a set of configured code playgrounds for
an organization. an organization.
* [`POST /register`](/api/register-queue): Added a new `realm_playgrounds` * [`POST /register`](/api/register-queue): Added a new `realm_playgrounds`
field, which is required to fetch the set of configured playgrounds for field, which is required to fetch the set of configured code playgrounds for
an organization. an organization.
**Feature level 48** **Feature level 48**

0
templates/zerver/api/remove-playground.md → templates/zerver/api/remove-code-playground.md
View File

4
templates/zerver/help/include/rest-endpoints.md
View File

@ -61,8 +61,8 @@
* [Add a linkifier](/api/add-linkifier) * [Add a linkifier](/api/add-linkifier)
* [Update a linkifier](/api/update-linkifier) * [Update a linkifier](/api/update-linkifier)
* [Remove a linkifier](/api/remove-linkifier) * [Remove a linkifier](/api/remove-linkifier)
* [Add a playground](/api/add-playground) * [Add a code playground](/api/add-code-playground)
* [Remove a playground](/api/remove-playground) * [Remove a code playground](/api/remove-code-playground)
* [Get all custom emoji](/api/get-custom-emoji) * [Get all custom emoji](/api/get-custom-emoji)
* [Upload custom emoji](/api/upload-custom-emoji) * [Upload custom emoji](/api/upload-custom-emoji)
* [Get all custom profile fields](/api/get-custom-profile-fields) * [Get all custom profile fields](/api/get-custom-profile-fields)

4
zerver/openapi/zulip.yaml
View File

@ -6989,7 +6989,7 @@ paths:
$ref: "#/components/schemas/JsonSuccess" $ref: "#/components/schemas/JsonSuccess"
/realm/playgrounds: /realm/playgrounds:
post: post:
operationId: add_realm_playground operationId: add_code_playground
tags: ["server_and_organizations"] tags: ["server_and_organizations"]
description: | description: |
Configure [code playgrounds](/help/code-blocks#code-playgrounds) for the organization. Configure [code playgrounds](/help/code-blocks#code-playgrounds) for the organization.
@ -7045,7 +7045,7 @@ paths:
example: {"id": 1, "result": "success", "msg": ""} example: {"id": 1, "result": "success", "msg": ""}
/realm/playgrounds/{playground_id}: /realm/playgrounds/{playground_id}:
delete: delete:
operationId: remove_realm_playground operationId: remove_code_playground
tags: ["server_and_organizations"] tags: ["server_and_organizations"]
description: | description: |
Remove a [code playground](/help/code-blocks#code-playgrounds) previously Remove a [code playground](/help/code-blocks#code-playgrounds) previously