worst/akkoma
1
0
Fork 0
forked from AkkomaGang/akkoma
Code Issues Pull requests Projects Releases Packages Wiki Activity

[#2456] Changed embed_relationships param to with_relationships.

Browse source
This commit is contained in:
Ivan Tashkinov 2020-05-13 15:08:07 +03:00
parent 33b798425f
commit 59b6d5f2aa
7 changed files with 77 additions and 85 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
lib/pleroma/web/api_spec/helpers.ex
View file

@ -5,6 +5,7 @@
defmodule Pleroma.Web.ApiSpec.Helpers do
alias OpenApiSpex.Operation
alias OpenApiSpex.Schema
alias Pleroma.Web.ApiSpec.Schemas.BooleanLike
def request_body(description, schema_ref, opts \\ []) do
media_types = ["application/json", "multipart/form-data", "application/x-www-form-urlencoded"]
@ -47,13 +48,8 @@ def pagination_params do
]
end
def embed_relationships_param do
Operation.parameter(
:embed_relationships,
:query,
:boolean,
"Embed relationships into accounts (Pleroma extension)"
)
def with_relationships_param do
Operation.parameter(:with_relationships, :query, BooleanLike, "Include relationships")
end
def empty_object_response do

14
lib/pleroma/web/api_spec/operations/account_operation.ex
View file

@ -155,9 +155,10 @@ def followers_operation do
security: [%{"oAuth" => ["read:accounts"]}],
description:
"Accounts which follow the given account, if network is not hidden by the account owner.",
parameters:
[%Reference{"$ref": "#/components/parameters/accountIdOrNickname"}] ++
pagination_params() ++ [embed_relationships_param()],
parameters: [
%Reference{"$ref": "#/components/parameters/accountIdOrNickname"},
with_relationships_param() | pagination_params()
],
responses: %{
200 => Operation.response("Accounts", "application/json", array_of_accounts())
}
@ -172,9 +173,10 @@ def following_operation do
security: [%{"oAuth" => ["read:accounts"]}],
description:
"Accounts which the given account is following, if network is not hidden by the account owner.",
parameters:
[%Reference{"$ref": "#/components/parameters/accountIdOrNickname"}] ++
pagination_params() ++ [embed_relationships_param()],
parameters: [
%Reference{"$ref": "#/components/parameters/accountIdOrNickname"},
with_relationships_param() | pagination_params()
],
responses: %{200 => Operation.response("Accounts", "application/json", array_of_accounts())}
}
end

20
lib/pleroma/web/api_spec/operations/search_operation.ex
View file

@ -24,8 +24,7 @@ def account_search_operation do
tags: ["Search"],
summary: "Search for matching accounts by username or display name",
operationId: "SearchController.account_search",
parameters:
[
parameters: [
Operation.parameter(:q, :query, %Schema{type: :string}, "What to search for",
required: true
),
@ -46,8 +45,9 @@ def account_search_operation do
:query,
%Schema{allOf: [BooleanLike], default: false},
"Only include accounts that the user is following"
)
] ++ [embed_relationships_param()],
),
with_relationships_param()
],
responses: %{
200 =>
Operation.response(
@ -66,8 +66,7 @@ def search_operation do
security: [%{"oAuth" => ["read:search"]}],
operationId: "SearchController.search",
deprecated: true,
parameters:
[
parameters: [
Operation.parameter(
:account_id,
:query,
@ -80,9 +79,7 @@ def search_operation do
%Schema{type: :string, enum: ["accounts", "hashtags", "statuses"]},
"Search type"
),
Operation.parameter(:q, :query, %Schema{type: :string}, "The search query",
required: true
),
Operation.parameter(:q, :query, %Schema{type: :string}, "The search query", required: true),
Operation.parameter(
:resolve,
:query,
@ -100,8 +97,9 @@ def search_operation do
:query,
%Schema{type: :integer},
"Offset"
)
] ++ pagination_params() ++ [embed_relationships_param()],
),
with_relationships_param() | pagination_params()
],
responses: %{
200 => Operation.response("Results", "application/json", results())
}

4
lib/pleroma/web/api_spec/operations/timeline_operation.ex
View file

@ -153,10 +153,6 @@ defp array_of_statuses do
}
end
defp with_relationships_param do
Operation.parameter(:with_relationships, :query, BooleanLike, "Include relationships")
end
defp local_param do
Operation.parameter(
:local,

6
lib/pleroma/web/controller_helper.ex
View file

@ -104,8 +104,8 @@ def put_if_exist(map, _key, nil), do: map
def put_if_exist(map, key, value), do: Map.put(map, key, value)
def embed_relationships?(params) do
# To do: change to `truthy_param?(params["embed_relationships"])` once PleromaFE supports it
not explicitly_falsy_param?(params["embed_relationships"])
def with_relationships?(params) do
# To do: change to `truthy_param?(params["with_relationships"])` once PleromaFE supports it
not explicitly_falsy_param?(params["with_relationships"])
end
end

6
lib/pleroma/web/mastodon_api/controllers/account_controller.ex
View file

@ -10,7 +10,7 @@ defmodule Pleroma.Web.MastodonAPI.AccountController do
add_link_headers: 2,
truthy_param?: 1,
assign_account_by_id: 2,
embed_relationships?: 1,
with_relationships?: 1,
json_response: 3
]
@ -275,7 +275,7 @@ def followers(%{assigns: %{user: for_user, account: user}} = conn, params) do
for: for_user,
users: followers,
as: :user,
embed_relationships: embed_relationships?(params)
embed_relationships: with_relationships?(params)
)
end
@ -300,7 +300,7 @@ def following(%{assigns: %{user: for_user, account: user}} = conn, params) do
for: for_user,
users: followers,
as: :user,
embed_relationships: embed_relationships?(params)
embed_relationships: with_relationships?(params)
)
end

4
lib/pleroma/web/mastodon_api/controllers/search_controller.ex
View file

@ -38,7 +38,7 @@ def account_search(%{assigns: %{user: user}} = conn, %{q: query} = params) do
users: accounts,
for: user,
as: :user,
embed_relationships: ControllerHelper.embed_relationships?(params)
embed_relationships: ControllerHelper.with_relationships?(params)
)
end
@ -82,7 +82,7 @@ defp search_options(params, user) do
offset: params[:offset],
type: params[:type],
author: get_author(params),
embed_relationships: ControllerHelper.embed_relationships?(params),
embed_relationships: ControllerHelper.with_relationships?(params),
for_user: user
]
|> Enum.filter(&elem(&1, 1))