@@ -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 |
@@ -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) | |||
@@ -30,8 +30,9 @@ defmodule Pleroma.Web.MastodonAPI.MediaControllerTest do | |||
media = | |||
conn | |||
|> put_req_header("content-type", "multipart/form-data") | |||
|> post("/api/v1/media", %{"file" => image, "description" => desc}) | |||
|> json_response(:ok) | |||
|> json_response_and_validate_schema(:ok) | |||
assert media["type"] == "image" | |||
assert media["description"] == desc | |||
@@ -46,15 +47,16 @@ defmodule Pleroma.Web.MastodonAPI.MediaControllerTest do | |||
response = | |||
conn | |||
|> put_req_header("content-type", "multipart/form-data") | |||
|> post("/api/v2/media", %{"file" => image, "description" => desc}) | |||
|> json_response(202) | |||
|> json_response_and_validate_schema(202) | |||
assert media_id = response["id"] | |||
media = | |||
conn | |||
|> get("/api/v1/media/#{media_id}") | |||
|> json_response(200) | |||
|> json_response_and_validate_schema(200) | |||
assert media["type"] == "image" | |||
assert media["description"] == desc | |||
@@ -85,8 +87,9 @@ defmodule Pleroma.Web.MastodonAPI.MediaControllerTest do | |||
test "/api/v1/media/:id good request", %{conn: conn, object: object} do | |||
media = | |||
conn | |||
|> put_req_header("content-type", "multipart/form-data") | |||
|> put("/api/v1/media/#{object.id}", %{"description" => "test-media"}) | |||
|> json_response(:ok) | |||
|> json_response_and_validate_schema(:ok) | |||
assert media["description"] == "test-media" | |||
assert refresh_record(object).data["name"] == "test-media" | |||
@@ -95,8 +98,9 @@ defmodule Pleroma.Web.MastodonAPI.MediaControllerTest do | |||
test "/api/v1/media/:id bad request", %{conn: conn, object: object} do | |||
media = | |||
conn | |||
|> put_req_header("content-type", "multipart/form-data") | |||
|> put("/api/v1/media/#{object.id}", %{}) | |||
|> json_response(400) | |||
|> json_response_and_validate_schema(400) | |||
assert media == %{"error" => "bad_request"} | |||
end | |||
@@ -124,7 +128,7 @@ defmodule Pleroma.Web.MastodonAPI.MediaControllerTest do | |||
media = | |||
conn | |||
|> get("/api/v1/media/#{object.id}") | |||
|> json_response(:ok) | |||
|> json_response_and_validate_schema(:ok) | |||
assert media["description"] == "test-media" | |||
assert media["type"] == "image" | |||