squeegily/pleroma
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix descriptions for List API spec

Browse Source
This commit is contained in:
Egor Kislitsyn 2020-05-01 19:53:00 +04:00
parent 5ec6aad567
commit f2bf4390f4
No known key found for this signature in database
GPG Key ID: 1B49CB15B71E7805
2 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
lib/pleroma/web/api_spec/operations/list_operation.ex
View File

@ -33,7 +33,7 @@ defmodule Pleroma.Web.ApiSpec.ListOperation do
def create_operation do def create_operation do
%Operation{ %Operation{
tags: ["Lists"], 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.", description: "Fetch the list with the given ID. Used for verifying the title of a list.",
operationId: "ListController.create", operationId: "ListController.create",
requestBody: create_update_request(), requestBody: create_update_request(),
@ -111,8 +111,7 @@ defmodule Pleroma.Web.ApiSpec.ListOperation do
%Operation{ %Operation{
tags: ["Lists"], tags: ["Lists"],
summary: "Add accounts to list", summary: "Add accounts to list",
description: description: "Add accounts to the given list.",
"Add accounts to the given list. Note that the user must be following these accounts.",
operationId: "ListController.add_to_list", operationId: "ListController.add_to_list",
parameters: [id_param()], parameters: [id_param()],
requestBody: add_remove_accounts_request(), requestBody: add_remove_accounts_request(),

2
lib/pleroma/web/api_spec/schemas/list.ex
View File

@ -9,7 +9,7 @@ defmodule Pleroma.Web.ApiSpec.Schemas.List do
OpenApiSpex.schema(%{ OpenApiSpex.schema(%{
title: "List", title: "List",
description: "Represents a list of some users that the authenticated user follows", description: "Represents a list of users",
type: :object, type: :object,
properties: %{ properties: %{
id: %Schema{type: :string, description: "The internal database ID of the list"}, id: %Schema{type: :string, description: "The internal database ID of the list"},