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

Merge branch 'openapi/use-boolean-like-in-requests' into 'develop'

Browse Source 
[OpenAPI] Use BooleanLike in all request bodies

Closes #1782

See merge request pleroma/pleroma!2551
This commit is contained in:
rinpatch 2020-05-18 17:13:53 +00:00
commit a66da971ff
6 changed files with 39 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
lib/pleroma/web/api_spec/operations/account_operation.ex
View File

@ -393,7 +393,7 @@ defmodule Pleroma.Web.ApiSpec.AccountOperation do
format: :password format: :password
}, },
agreement: %Schema{ agreement: %Schema{
type: :boolean, allOf: [BooleanLike],
description: description:
"Whether the user agrees to the local rules, terms, and policies. These should be presented to the user in order to allow them to consent before setting this parameter to TRUE." "Whether the user agrees to the local rules, terms, and policies. These should be presented to the user in order to allow them to consent before setting this parameter to TRUE."
}, },
@ -463,7 +463,7 @@ defmodule Pleroma.Web.ApiSpec.AccountOperation do
type: :object, type: :object,
properties: %{ properties: %{
bot: %Schema{ bot: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: "Whether the account has a bot flag." description: "Whether the account has a bot flag."
}, },
@ -486,7 +486,7 @@ defmodule Pleroma.Web.ApiSpec.AccountOperation do
format: :binary format: :binary
}, },
locked: %Schema{ locked: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: "Whether manual approval of follow requests is required." description: "Whether manual approval of follow requests is required."
}, },
@ -510,37 +510,37 @@ defmodule Pleroma.Web.ApiSpec.AccountOperation do
# Pleroma-specific fields # Pleroma-specific fields
no_rich_text: %Schema{ no_rich_text: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: "html tags are stripped from all statuses requested from the API" description: "html tags are stripped from all statuses requested from the API"
}, },
hide_followers: %Schema{ hide_followers: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: "user's followers will be hidden" description: "user's followers will be hidden"
}, },
hide_follows: %Schema{ hide_follows: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: "user's follows will be hidden" description: "user's follows will be hidden"
}, },
hide_followers_count: %Schema{ hide_followers_count: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: "user's follower count will be hidden" description: "user's follower count will be hidden"
}, },
hide_follows_count: %Schema{ hide_follows_count: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: "user's follow count will be hidden" description: "user's follow count will be hidden"
}, },
hide_favorites: %Schema{ hide_favorites: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: "user's favorites timeline will be hidden" description: "user's favorites timeline will be hidden"
}, },
show_role: %Schema{ show_role: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: "user's role (e.g admin, moderator) will be exposed to anyone in the description: "user's role (e.g admin, moderator) will be exposed to anyone in the
API" API"
@ -552,12 +552,12 @@ defmodule Pleroma.Web.ApiSpec.AccountOperation do
description: "Opaque user settings to be saved on the backend." description: "Opaque user settings to be saved on the backend."
}, },
skip_thread_containment: %Schema{ skip_thread_containment: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: "Skip filtering out broken threads" description: "Skip filtering out broken threads"
}, },
allow_following_move: %Schema{ allow_following_move: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: "Allows automatically follow moved following accounts" description: "Allows automatically follow moved following accounts"
}, },
@ -568,7 +568,7 @@ defmodule Pleroma.Web.ApiSpec.AccountOperation do
format: :binary format: :binary
}, },
discoverable: %Schema{ discoverable: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: description:
"Discovery of this account in search results and other services is allowed." "Discovery of this account in search results and other services is allowed."
@ -678,7 +678,7 @@ defmodule Pleroma.Web.ApiSpec.AccountOperation do
type: :object, type: :object,
properties: %{ properties: %{
notifications: %Schema{ notifications: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: "Mute notifications in addition to statuses? Defaults to true.", description: "Mute notifications in addition to statuses? Defaults to true.",
default: true default: true

7
lib/pleroma/web/api_spec/operations/filter_operation.ex
View File

@ -6,6 +6,7 @@ defmodule Pleroma.Web.ApiSpec.FilterOperation do
alias OpenApiSpex.Operation alias OpenApiSpex.Operation
alias OpenApiSpex.Schema alias OpenApiSpex.Schema
alias Pleroma.Web.ApiSpec.Helpers alias Pleroma.Web.ApiSpec.Helpers
alias Pleroma.Web.ApiSpec.Schemas.BooleanLike
def open_api_operation(action) do def open_api_operation(action) do
operation = String.to_existing_atom("#{action}_operation") operation = String.to_existing_atom("#{action}_operation")
@ -171,7 +172,7 @@ defmodule Pleroma.Web.ApiSpec.FilterOperation do
type: :object, type: :object,
properties: %{ properties: %{
irreversible: %Schema{ irreversible: %Schema{
type: :bolean, allOf: [BooleanLike],
description: description:
"Should the server irreversibly drop matching entities from home and notifications?", "Should the server irreversibly drop matching entities from home and notifications?",
default: false default: false
@ -199,13 +200,13 @@ defmodule Pleroma.Web.ApiSpec.FilterOperation do
"Array of enumerable strings `home`, `notifications`, `public`, `thread`. At least one context must be specified." "Array of enumerable strings `home`, `notifications`, `public`, `thread`. At least one context must be specified."
}, },
irreversible: %Schema{ irreversible: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: description:
"Should the server irreversibly drop matching entities from home and notifications?" "Should the server irreversibly drop matching entities from home and notifications?"
}, },
whole_word: %Schema{ whole_word: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: "Consider word boundaries?", description: "Consider word boundaries?",
default: true default: true

3
lib/pleroma/web/api_spec/operations/report_operation.ex
View File

@ -7,6 +7,7 @@ defmodule Pleroma.Web.ApiSpec.ReportOperation do
alias OpenApiSpex.Schema alias OpenApiSpex.Schema
alias Pleroma.Web.ApiSpec.Helpers alias Pleroma.Web.ApiSpec.Helpers
alias Pleroma.Web.ApiSpec.Schemas.ApiError alias Pleroma.Web.ApiSpec.Schemas.ApiError
alias Pleroma.Web.ApiSpec.Schemas.BooleanLike
def open_api_operation(action) do def open_api_operation(action) do
operation = String.to_existing_atom("#{action}_operation") operation = String.to_existing_atom("#{action}_operation")
@ -47,7 +48,7 @@ defmodule Pleroma.Web.ApiSpec.ReportOperation do
description: "Reason for the report" description: "Reason for the report"
}, },
forward: %Schema{ forward: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
default: false, default: false,
description: description:

9
lib/pleroma/web/api_spec/operations/status_operation.ex
View File

@ -7,6 +7,7 @@ defmodule Pleroma.Web.ApiSpec.StatusOperation do
alias OpenApiSpex.Schema alias OpenApiSpex.Schema
alias Pleroma.Web.ApiSpec.AccountOperation alias Pleroma.Web.ApiSpec.AccountOperation
alias Pleroma.Web.ApiSpec.Schemas.ApiError alias Pleroma.Web.ApiSpec.Schemas.ApiError
alias Pleroma.Web.ApiSpec.Schemas.BooleanLike
alias Pleroma.Web.ApiSpec.Schemas.FlakeID alias Pleroma.Web.ApiSpec.Schemas.FlakeID
alias Pleroma.Web.ApiSpec.Schemas.ScheduledStatus alias Pleroma.Web.ApiSpec.Schemas.ScheduledStatus
alias Pleroma.Web.ApiSpec.Schemas.Status alias Pleroma.Web.ApiSpec.Schemas.Status
@ -394,12 +395,12 @@ defmodule Pleroma.Web.ApiSpec.StatusOperation do
"Duration the poll should be open, in seconds. Must be provided with `poll[options]`" "Duration the poll should be open, in seconds. Must be provided with `poll[options]`"
}, },
multiple: %Schema{ multiple: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: "Allow multiple choices?" description: "Allow multiple choices?"
}, },
hide_totals: %Schema{ hide_totals: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: "Hide vote counts until the poll ends?" description: "Hide vote counts until the poll ends?"
} }
@ -411,7 +412,7 @@ defmodule Pleroma.Web.ApiSpec.StatusOperation do
description: "ID of the status being replied to, if status is a reply" description: "ID of the status being replied to, if status is a reply"
}, },
sensitive: %Schema{ sensitive: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: "Mark status and attached media as sensitive?" description: "Mark status and attached media as sensitive?"
}, },
@ -435,7 +436,7 @@ defmodule Pleroma.Web.ApiSpec.StatusOperation do
}, },
# Pleroma-specific properties: # Pleroma-specific properties:
preview: %Schema{ preview: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: description:
"If set to `true` the post won't be actually posted, but the status entitiy would still be rendered back. This could be useful for previewing rich text/custom emoji, for example" "If set to `true` the post won't be actually posted, but the status entitiy would still be rendered back. This could be useful for previewing rich text/custom emoji, for example"

21
lib/pleroma/web/api_spec/operations/subscription_operation.ex
View File

@ -7,6 +7,7 @@ defmodule Pleroma.Web.ApiSpec.SubscriptionOperation do
alias OpenApiSpex.Schema alias OpenApiSpex.Schema
alias Pleroma.Web.ApiSpec.Helpers alias Pleroma.Web.ApiSpec.Helpers
alias Pleroma.Web.ApiSpec.Schemas.ApiError alias Pleroma.Web.ApiSpec.Schemas.ApiError
alias Pleroma.Web.ApiSpec.Schemas.BooleanLike
alias Pleroma.Web.ApiSpec.Schemas.PushSubscription alias Pleroma.Web.ApiSpec.Schemas.PushSubscription
def open_api_operation(action) do def open_api_operation(action) do
@ -117,27 +118,27 @@ defmodule Pleroma.Web.ApiSpec.SubscriptionOperation do
type: :object, type: :object,
properties: %{ properties: %{
follow: %Schema{ follow: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: "Receive follow notifications?" description: "Receive follow notifications?"
}, },
favourite: %Schema{ favourite: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: "Receive favourite notifications?" description: "Receive favourite notifications?"
}, },
reblog: %Schema{ reblog: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: "Receive reblog notifications?" description: "Receive reblog notifications?"
}, },
mention: %Schema{ mention: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: "Receive mention notifications?" description: "Receive mention notifications?"
}, },
poll: %Schema{ poll: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: "Receive poll notifications?" description: "Receive poll notifications?"
} }
@ -181,27 +182,27 @@ defmodule Pleroma.Web.ApiSpec.SubscriptionOperation do
type: :object, type: :object,
properties: %{ properties: %{
follow: %Schema{ follow: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: "Receive follow notifications?" description: "Receive follow notifications?"
}, },
favourite: %Schema{ favourite: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: "Receive favourite notifications?" description: "Receive favourite notifications?"
}, },
reblog: %Schema{ reblog: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: "Receive reblog notifications?" description: "Receive reblog notifications?"
}, },
mention: %Schema{ mention: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: "Receive mention notifications?" description: "Receive mention notifications?"
}, },
poll: %Schema{ poll: %Schema{
type: :boolean, allOf: [BooleanLike],
nullable: true, nullable: true,
description: "Receive poll notifications?" description: "Receive poll notifications?"
} }

6
test/web/mastodon_api/controllers/status_controller_test.exs
View File

@ -62,7 +62,7 @@ defmodule Pleroma.Web.MastodonAPI.StatusControllerTest do
|> post("/api/v1/statuses", %{ |> post("/api/v1/statuses", %{
"status" => "cofe", "status" => "cofe",
"spoiler_text" => "2hu", "spoiler_text" => "2hu",
"sensitive" => "false" "sensitive" => "0"
}) })
{:ok, ttl} = Cachex.ttl(:idempotency_cache, idempotency_key) {:ok, ttl} = Cachex.ttl(:idempotency_cache, idempotency_key)
@ -81,7 +81,7 @@ defmodule Pleroma.Web.MastodonAPI.StatusControllerTest do
|> post("/api/v1/statuses", %{ |> post("/api/v1/statuses", %{
"status" => "cofe", "status" => "cofe",
"spoiler_text" => "2hu", "spoiler_text" => "2hu",
"sensitive" => "false" "sensitive" => 0
}) })
assert %{"id" => second_id} = json_response(conn_two, 200) assert %{"id" => second_id} = json_response(conn_two, 200)
@ -93,7 +93,7 @@ defmodule Pleroma.Web.MastodonAPI.StatusControllerTest do
|> post("/api/v1/statuses", %{ |> post("/api/v1/statuses", %{
"status" => "cofe", "status" => "cofe",
"spoiler_text" => "2hu", "spoiler_text" => "2hu",
"sensitive" => "false" "sensitive" => "False"
}) })
assert %{"id" => third_id} = json_response_and_validate_schema(conn_three, 200) assert %{"id" => third_id} = json_response_and_validate_schema(conn_three, 200)