aboutsummaryrefslogtreecommitdiff
path: root/lib/pleroma/web
diff options
context:
space:
mode:
authorEgor Kislitsyn <egor@kislitsyn.com>2020-05-14 16:18:30 +0400
committerEgor Kislitsyn <egor@kislitsyn.com>2020-05-14 16:18:30 +0400
commit0f885b4b86ad7ba738ef0dd0de7f7d0496b7e43d (patch)
treea06df314ed459bf78c752f056e4c3fb911dee4ec /lib/pleroma/web
parent099e314a1bb823a83d9c1af0cca2363487a07899 (diff)
downloadpleroma-0f885b4b86ad7ba738ef0dd0de7f7d0496b7e43d.tar.gz
Fix OpenAPI spec
Diffstat (limited to 'lib/pleroma/web')
-rw-r--r--lib/pleroma/web/api_spec/operations/media_operation.ex43
-rw-r--r--lib/pleroma/web/mastodon_api/controllers/media_controller.ex14
2 files changed, 30 insertions, 27 deletions
diff --git a/lib/pleroma/web/api_spec/operations/media_operation.ex b/lib/pleroma/web/api_spec/operations/media_operation.ex
index 0fe686efa..d9c3c42db 100644
--- a/lib/pleroma/web/api_spec/operations/media_operation.ex
+++ b/lib/pleroma/web/api_spec/operations/media_operation.ex
@@ -7,6 +7,7 @@ defmodule Pleroma.Web.ApiSpec.MediaOperation do
alias OpenApiSpex.Schema
alias Pleroma.Web.ApiSpec.Helpers
alias Pleroma.Web.ApiSpec.Schemas.ApiError
+ alias Pleroma.Web.ApiSpec.Schemas.Attachment
def open_api_operation(action) do
operation = String.to_existing_atom("#{action}_operation")
@@ -22,24 +23,24 @@ defmodule Pleroma.Web.ApiSpec.MediaOperation do
security: [%{"oAuth" => ["write:media"]}],
requestBody: Helpers.request_body("Parameters", create_request()),
responses: %{
- 200 =>
- Operation.response("Media", "application/json", Pleroma.Web.ApiSpec.Schemas.Attachment),
+ 200 => Operation.response("Media", "application/json", Attachment),
401 => Operation.response("Media", "application/json", ApiError),
422 => Operation.response("Media", "application/json", ApiError)
}
}
end
- defp create_request() do
+ defp create_request do
%Schema{
title: "MediaCreateRequest",
description: "POST body for creating an attachment",
type: :object,
+ required: [:file],
properties: %{
file: %Schema{
- type: :binary,
- description: "The file to be attached, using multipart form data.",
- required: true
+ type: :string,
+ format: :binary,
+ description: "The file to be attached, using multipart form data."
},
description: %Schema{
type: :string,
@@ -60,29 +61,26 @@ defmodule Pleroma.Web.ApiSpec.MediaOperation do
description: "Creates an attachment to be used with a new status.",
operationId: "MediaController.update",
security: [%{"oAuth" => ["write:media"]}],
+ parameters: [id_param()],
requestBody: Helpers.request_body("Parameters", update_request()),
responses: %{
- 200 =>
- Operation.response("Media", "application/json", Pleroma.Web.ApiSpec.Schemas.Attachment),
+ 200 => Operation.response("Media", "application/json", Attachment),
+ 400 => Operation.response("Media", "application/json", ApiError),
401 => Operation.response("Media", "application/json", ApiError),
422 => Operation.response("Media", "application/json", ApiError)
}
}
end
- defp update_request() do
+ defp update_request do
%Schema{
- title: "MediaCreateRequest",
- description: "POST body for creating an attachment",
+ title: "MediaUpdateRequest",
+ description: "POST body for updating an attachment",
type: :object,
properties: %{
- id: %Schema{
- type: :string,
- description: "The id of the Attachment entity to be updated",
- required: true
- },
file: %Schema{
- type: :binary,
+ type: :string,
+ format: :binary,
description: "The file to be attached, using multipart form data."
},
description: %Schema{
@@ -102,10 +100,10 @@ defmodule Pleroma.Web.ApiSpec.MediaOperation do
tags: ["media"],
summary: "Show Uploaded media attachment",
operationId: "MediaController.show",
+ parameters: [id_param()],
security: [%{"oAuth" => ["read:media"]}],
responses: %{
- 200 =>
- Operation.response("Media", "application/json", Pleroma.Web.ApiSpec.Schemas.Attachment),
+ 200 => Operation.response("Media", "application/json", Attachment),
401 => Operation.response("Media", "application/json", ApiError),
422 => Operation.response("Media", "application/json", ApiError)
}
@@ -121,11 +119,14 @@ defmodule Pleroma.Web.ApiSpec.MediaOperation do
security: [%{"oAuth" => ["write:media"]}],
requestBody: Helpers.request_body("Parameters", create_request()),
responses: %{
- 202 =>
- Operation.response("Media", "application/json", Pleroma.Web.ApiSpec.Schemas.Attachment),
+ 202 => Operation.response("Media", "application/json", Attachment),
422 => Operation.response("Media", "application/json", ApiError),
500 => Operation.response("Media", "application/json", ApiError)
}
}
end
+
+ defp id_param do
+ Operation.parameter(:id, :path, :string, "The ID of the Attachment entity")
+ end
end
diff --git a/lib/pleroma/web/mastodon_api/controllers/media_controller.ex b/lib/pleroma/web/mastodon_api/controllers/media_controller.ex
index 52e0b22d8..3b2ea751c 100644
--- a/lib/pleroma/web/mastodon_api/controllers/media_controller.ex
+++ b/lib/pleroma/web/mastodon_api/controllers/media_controller.ex
@@ -19,12 +19,12 @@ defmodule Pleroma.Web.MastodonAPI.MediaController do
defdelegate open_api_operation(action), to: Pleroma.Web.ApiSpec.MediaOperation
@doc "POST /api/v1/media"
- def create(%{assigns: %{user: user}} = conn, %{"file" => file} = data) do
+ def create(%{assigns: %{user: user}, body_params: %{file: file} = data} = conn, _) do
with {:ok, object} <-
ActivityPub.upload(
file,
actor: User.ap_id(user),
- description: Map.get(data, "description")
+ description: Map.get(data, :description)
) do
attachment_data = Map.put(object.data, "id", object.id)
@@ -35,12 +35,12 @@ defmodule Pleroma.Web.MastodonAPI.MediaController do
def create(_conn, _data), do: {:error, :bad_request}
@doc "POST /api/v2/media"
- def create2(%{assigns: %{user: user}} = conn, %{"file" => file} = data) do
+ def create2(%{assigns: %{user: user}, body_params: %{file: file} = data} = conn, _) do
with {:ok, object} <-
ActivityPub.upload(
file,
actor: User.ap_id(user),
- description: Map.get(data, "description")
+ description: Map.get(data, :description)
) do
attachment_data = Map.put(object.data, "id", object.id)
@@ -53,7 +53,9 @@ defmodule Pleroma.Web.MastodonAPI.MediaController do
def create2(_conn, _data), do: {:error, :bad_request}
@doc "PUT /api/v1/media/:id"
- def update(%{assigns: %{user: user}} = conn, %{"id" => id, "description" => description})
+ def update(%{assigns: %{user: user}, body_params: %{description: description}} = conn, %{
+ id: id
+ })
when is_binary(description) do
with %Object{} = object <- Object.get_by_id(id),
true <- Object.authorize_mutation(object, user),
@@ -67,7 +69,7 @@ defmodule Pleroma.Web.MastodonAPI.MediaController do
def update(_conn, _data), do: {:error, :bad_request}
@doc "GET /api/v1/media/:id"
- def show(conn, %{"id" => id}) do
+ def show(conn, %{id: id}) do
with %Object{data: data, id: object_id} <- Object.get_by_id(id) do
attachment_data = Map.put(data, "id", object_id)