From b41be98c42e862bffb55263542175ea9d79c13de Mon Sep 17 00:00:00 2001 From: Suyash Vardhan Mathur Date: Sun, 23 May 2021 13:34:50 +0530 Subject: [PATCH] apidocs: Fix playground URLs and operationIDs. We standardized on "Code playground" for this feature, so use that in the URLs and API documentation. --- .../api/{add-playground.md => add-code-playground.md} | 0 templates/zerver/api/changelog.md | 10 +++++----- ...{remove-playground.md => remove-code-playground.md} | 0 templates/zerver/help/include/rest-endpoints.md | 4 ++-- zerver/openapi/zulip.yaml | 4 ++-- 5 files changed, 9 insertions(+), 9 deletions(-) rename templates/zerver/api/{add-playground.md => add-code-playground.md} (100%) rename templates/zerver/api/{remove-playground.md => remove-code-playground.md} (100%) diff --git a/templates/zerver/api/add-playground.md b/templates/zerver/api/add-code-playground.md similarity index 100% rename from templates/zerver/api/add-playground.md rename to templates/zerver/api/add-code-playground.md diff --git a/templates/zerver/api/changelog.md b/templates/zerver/api/changelog.md index 7012edbc80..0f591a065a 100644 --- a/templates/zerver/api/changelog.md +++ b/templates/zerver/api/changelog.md @@ -162,14 +162,14 @@ field with an integer field `invite_to_realm_policy`. **Feature level 49** -* Added new [`POST /realm/playground`](/api/add-playground) and - [`DELETE /realm/playground/{playground_id}`](/api/remove-playground) - endpoints for realm playgrounds. +* Added new [`POST /realm/playground`](/api/add-code-playground) and + [`DELETE /realm/playground/{playground_id}`](/api/remove-code-playground) + endpoints for code playgrounds. * [`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. * [`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. **Feature level 48** diff --git a/templates/zerver/api/remove-playground.md b/templates/zerver/api/remove-code-playground.md similarity index 100% rename from templates/zerver/api/remove-playground.md rename to templates/zerver/api/remove-code-playground.md diff --git a/templates/zerver/help/include/rest-endpoints.md b/templates/zerver/help/include/rest-endpoints.md index 22159b6cdc..90c2b51556 100644 --- a/templates/zerver/help/include/rest-endpoints.md +++ b/templates/zerver/help/include/rest-endpoints.md @@ -61,8 +61,8 @@ * [Add a linkifier](/api/add-linkifier) * [Update a linkifier](/api/update-linkifier) * [Remove a linkifier](/api/remove-linkifier) -* [Add a playground](/api/add-playground) -* [Remove a playground](/api/remove-playground) +* [Add a code playground](/api/add-code-playground) +* [Remove a code playground](/api/remove-code-playground) * [Get all custom emoji](/api/get-custom-emoji) * [Upload custom emoji](/api/upload-custom-emoji) * [Get all custom profile fields](/api/get-custom-profile-fields) diff --git a/zerver/openapi/zulip.yaml b/zerver/openapi/zulip.yaml index 8bf3b173fb..29bf68a422 100644 --- a/zerver/openapi/zulip.yaml +++ b/zerver/openapi/zulip.yaml @@ -6989,7 +6989,7 @@ paths: $ref: "#/components/schemas/JsonSuccess" /realm/playgrounds: post: - operationId: add_realm_playground + operationId: add_code_playground tags: ["server_and_organizations"] description: | Configure [code playgrounds](/help/code-blocks#code-playgrounds) for the organization. @@ -7045,7 +7045,7 @@ paths: example: {"id": 1, "result": "success", "msg": ""} /realm/playgrounds/{playground_id}: delete: - operationId: remove_realm_playground + operationId: remove_code_playground tags: ["server_and_organizations"] description: | Remove a [code playground](/help/code-blocks#code-playgrounds) previously