Add spec for AccountController.show

This commit is contained in:
Egor Kislitsyn 2020-04-07 18:53:12 +04:00
parent d7d6a83233
commit 278b3fa0ad
No known key found for this signature in database
GPG Key ID: 1B49CB15B71E7805
3 changed files with 32 additions and 4 deletions

View File

@ -86,7 +86,21 @@ def relationships_operation do
end end
def show_operation do def show_operation do
:ok %Operation{
tags: ["accounts"],
summary: "Account",
operationId: "AccountController.show",
description: "View information about a profile.",
parameters: [
Operation.parameter(:id, :path, :string, "Account ID or nickname",
example: "123",
required: true
)
],
responses: %{
200 => Operation.response("Account", "application/json", Account)
}
}
end end
def statuses_operation do def statuses_operation do

View File

@ -83,7 +83,7 @@ defmodule Pleroma.Web.MastodonAPI.AccountController do
plug( plug(
OpenApiSpex.Plug.CastAndValidate, OpenApiSpex.Plug.CastAndValidate,
[render_error: Pleroma.Web.ApiSpec.RenderError] [render_error: Pleroma.Web.ApiSpec.RenderError]
when action in [:create, :verify_credentials, :update_credentials, :relationships] when action in [:create, :verify_credentials, :update_credentials, :relationships, :show]
) )
action_fallback(Pleroma.Web.MastodonAPI.FallbackController) action_fallback(Pleroma.Web.MastodonAPI.FallbackController)
@ -239,7 +239,7 @@ def relationships(%{assigns: %{user: user}} = conn, %{id: id}) do
def relationships(%{assigns: %{user: _user}} = conn, _), do: json(conn, []) def relationships(%{assigns: %{user: _user}} = conn, _), do: json(conn, [])
@doc "GET /api/v1/accounts/:id" @doc "GET /api/v1/accounts/:id"
def show(%{assigns: %{user: for_user}} = conn, %{"id" => nickname_or_id}) do def show(%{assigns: %{user: for_user}} = conn, %{id: nickname_or_id}) do
with %User{} = user <- User.get_cached_by_nickname_or_id(nickname_or_id, for: for_user), with %User{} = user <- User.get_cached_by_nickname_or_id(nickname_or_id, for: for_user),
true <- User.visible_for?(user, for_user) do true <- User.visible_for?(user, for_user) do
render(conn, "show.json", user: user, for: for_user) render(conn, "show.json", user: user, for: for_user)

View File

@ -3,7 +3,7 @@
# SPDX-License-Identifier: AGPL-3.0-only # SPDX-License-Identifier: AGPL-3.0-only
defmodule Pleroma.Web.ApiSpec.AccountOperationTest do defmodule Pleroma.Web.ApiSpec.AccountOperationTest do
use Pleroma.Web.ConnCase, async: true use Pleroma.Web.ConnCase
alias Pleroma.Web.ApiSpec alias Pleroma.Web.ApiSpec
alias Pleroma.Web.ApiSpec.Schemas.Account alias Pleroma.Web.ApiSpec.Schemas.Account
@ -108,4 +108,18 @@ test "/api/v1/accounts/relationships produces AccountRelationshipsResponse", %{
assert_schema([relationship], "AccountRelationshipsResponse", api_spec) assert_schema([relationship], "AccountRelationshipsResponse", api_spec)
end end
test "/api/v1/accounts/:id produces Account", %{
conn: conn
} do
user = insert(:user)
api_spec = ApiSpec.spec()
assert resp =
conn
|> get("/api/v1/accounts/#{user.id}")
|> json_response(:ok)
assert_schema(resp, "Account", api_spec)
end
end end