diff options
| author | Egor Kislitsyn <egor@kislitsyn.com> | 2020-05-01 19:53:00 +0400 |
|---|---|---|
| committer | Egor Kislitsyn <egor@kislitsyn.com> | 2020-05-05 17:05:35 +0400 |
| commit | f2bf4390f4231d25486b803d426199975996f175 (patch) | |
| tree | 9be7c28de3fc19af2e82360769bee52b56b1b5b0 | |
| parent | 5ec6aad5670cf0888942a13e83b9ffd16e97dd18 (diff) | |
Fix descriptions for List API spec
| -rw-r--r-- | lib/pleroma/web/api_spec/operations/list_operation.ex | 5 | ||||
| -rw-r--r-- | lib/pleroma/web/api_spec/schemas/list.ex | 2 |
2 files changed, 3 insertions, 4 deletions
diff --git a/lib/pleroma/web/api_spec/operations/list_operation.ex b/lib/pleroma/web/api_spec/operations/list_operation.ex index bb903a379..c88ed5dd0 100644 --- a/lib/pleroma/web/api_spec/operations/list_operation.ex +++ b/lib/pleroma/web/api_spec/operations/list_operation.ex @@ -33,7 +33,7 @@ defmodule Pleroma.Web.ApiSpec.ListOperation do def create_operation do %Operation{ tags: ["Lists"], - summary: "Show a single list", + summary: "Create a list", description: "Fetch the list with the given ID. Used for verifying the title of a list.", operationId: "ListController.create", requestBody: create_update_request(), @@ -111,8 +111,7 @@ defmodule Pleroma.Web.ApiSpec.ListOperation do %Operation{ tags: ["Lists"], summary: "Add accounts to list", - description: - "Add accounts to the given list. Note that the user must be following these accounts.", + description: "Add accounts to the given list.", operationId: "ListController.add_to_list", parameters: [id_param()], requestBody: add_remove_accounts_request(), diff --git a/lib/pleroma/web/api_spec/schemas/list.ex b/lib/pleroma/web/api_spec/schemas/list.ex index 78aa0736f..b7d1685c9 100644 --- a/lib/pleroma/web/api_spec/schemas/list.ex +++ b/lib/pleroma/web/api_spec/schemas/list.ex @@ -9,7 +9,7 @@ defmodule Pleroma.Web.ApiSpec.Schemas.List do OpenApiSpex.schema(%{ title: "List", - description: "Represents a list of some users that the authenticated user follows", + description: "Represents a list of users", type: :object, properties: %{ id: %Schema{type: :string, description: "The internal database ID of the list"}, |