Fix descriptions for List API spec
authorEgor Kislitsyn <egor@kislitsyn.com>
Fri, 1 May 2020 15:53:00 +0000 (19:53 +0400)
committerEgor Kislitsyn <egor@kislitsyn.com>
Tue, 5 May 2020 13:05:35 +0000 (17:05 +0400)
lib/pleroma/web/api_spec/operations/list_operation.ex
lib/pleroma/web/api_spec/schemas/list.ex

index bb903a379860017def82b86fa3dbe52048128ec7..c88ed5dd0ebd51cb29720a07ebc571474e51a5d4 100644 (file)
@@ -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(),
index 78aa0736f9d8b362b304b211804e4cd63c4ab6f3..b7d1685c9281445a5ce943ef5211c95a234efb5f 100644 (file)
@@ -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"},