mirrors/pleroma
1
0
Fork 0
mirror of https://git.pleroma.social/pleroma/pleroma.git synced 2024-05-23 20:18:07 +00:00
Code Issues Projects Releases Wiki Activity

Merge branch 'previewcard-get.remove' into 'develop'

Browse source 
Draft: Deprecate /api/v1/statuses/:id/card (Mastodon 3.0.0)

See merge request pleroma/pleroma!4067
This commit is contained in:
Haelwenn 2024-04-12 03:19:38 +00:00
parent d80e0d6873 692028b24f
commit 94392e45a3
8 changed files with 75 additions and 57 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog.d/previewcard-get.remove Normal file
View file

@ -0,0 +1 @@
Remove `/api/v1/statuses/:id/card` endpoint used for preview cards in favor of inlined in Statuses (also removed in Mastodon 3.0.0)

1
changelog.d/previewcard-void-fill.fix Normal file
View file

@ -0,0 +1 @@
Status: Fill all MastoAPI required values in preview cards

28
lib/pleroma/web/api_spec/operations/status_operation.ex
View file

@ -339,34 +339,6 @@ defmodule Pleroma.Web.ApiSpec.StatusOperation do
}
end
def card_operation do
%Operation{
tags: ["Retrieve status information"],
deprecated: true,
summary: "Preview card",
description: "Deprecated in favor of card property inlined on Status entity",
operationId: "StatusController.card",
parameters: [id_param()],
security: [%{"oAuth" => ["read:statuses"]}],
responses: %{
200 =>
Operation.response("Card", "application/json", %Schema{
type: :object,
nullable: true,
properties: %{
type: %Schema{type: :string, enum: ["link", "photo", "video", "rich"]},
provider_name: %Schema{type: :string, nullable: true},
provider_url: %Schema{type: :string, format: :uri},
url: %Schema{type: :string, format: :uri},
image: %Schema{type: :string, nullable: true, format: :uri},
title: %Schema{type: :string},
description: %Schema{type: :string}
}
})
}
}
end
def favourited_by_operation do
%Operation{
tags: ["Retrieve status information"],

49
lib/pleroma/web/api_spec/schemas/status.ex
View file

@ -34,16 +34,40 @@ defmodule Pleroma.Web.ApiSpec.Schemas.Status do
type: :object,
nullable: true,
description: "Preview card for links included within status content",
required: [:url, :title, :description, :type],
# Yeah, it's effectivelly all required in MastoAPI so far
required: [
:url,
:title,
:description,
:type,
:author_name,
:author_url,
:provider_name,
:provider_url,
:html,
:width,
:height,
:image,
:embed_url,
:blurhash
],
properties: %{
url: %Schema{type: :string, format: :uri, description: "Location of linked resource"},
title: %Schema{type: :string, description: "Title of linked resource"},
description: %Schema{type: :string, description: "Description of preview"},
type: %Schema{
type: :string,
enum: ["link", "photo", "video", "rich"],
description: "The type of the preview card"
},
author_name: %Schema{type: :string, description: "author of the original resource"},
author_url: %Schema{
type: :string,
format: :uri,
description: "link to the author of the original resource"
},
provider_name: %Schema{
type: :string,
nullable: true,
description: "The provider of the original resource"
},
provider_url: %Schema{
@ -51,15 +75,30 @@ defmodule Pleroma.Web.ApiSpec.Schemas.Status do
format: :uri,
description: "A link to the provider of the original resource"
},
url: %Schema{type: :string, format: :uri, description: "Location of linked resource"},
html: %Schema{
type: :string,
format: :html,
description: "HTML to be used for generating the preview card"
},
width: %Schema{type: :integer, description: "Width of preview, in pixels"},
height: %Schema{type: :integer, description: "Height of preview, in pixels"},
image: %Schema{
type: :string,
nullable: true,
format: :uri,
description: "Preview thumbnail"
},
title: %Schema{type: :string, description: "Title of linked resource"},
description: %Schema{type: :string, description: "Description of preview"}
embed_url: %Schema{
type: :string,
format: :uri,
description: "Used for photo embeds, instead of custom `html`"
},
blurhash: %Schema{
type: :string,
nullable: true,
description:
"A hash computed by the (BlurHash algorithm)[https://github.com/woltapp/blurhash], for generating colorful preview thumbnails when media has not been downloaded yet."
}
}
},
content: %Schema{type: :string, format: :html, description: "HTML-encoded status content"},

15
lib/pleroma/web/mastodon_api/controllers/status_controller.ex
View file

@ -473,21 +473,6 @@ defmodule Pleroma.Web.MastodonAPI.StatusController do
end
end
@doc "GET /api/v1/statuses/:id/card"
@deprecated "https://github.com/tootsuite/mastodon/pull/11213"
def card(
%{assigns: %{user: user}, private: %{open_api_spex: %{params: %{id: status_id}}}} = conn,
_
) do
with %Activity{} = activity <- Activity.get_by_id(status_id),
true <- Visibility.visible_for_user?(activity, user) do
data = Pleroma.Web.RichMedia.Helpers.fetch_data_for_activity(activity)
render(conn, "card.json", data)
else
_ -> render_error(conn, :not_found, "Record not found")
end
end
@doc "GET /api/v1/statuses/:id/favourited_by"
def favourited_by(
%{assigns: %{user: user}, private: %{open_api_spex: %{params: %{id: id}}}} = conn,

7
lib/pleroma/web/mastodon_api/views/status_view.ex
View file

@ -591,6 +591,13 @@ defmodule Pleroma.Web.MastodonAPI.StatusView do
image: image_url,
title: rich_media["title"] || "",
description: rich_media["description"] || "",
author_name: "",
author_url: "",
html: "",
width: 0,
height: 0,
embed_url: "",
blurhash: nil,
pleroma: %{
opengraph:
rich_media

1
lib/pleroma/web/router.ex
View file

@ -768,7 +768,6 @@ defmodule Pleroma.Web.Router do
get("/statuses", StatusController, :index)
get("/statuses/:id", StatusController, :show)
get("/statuses/:id/context", StatusController, :context)
get("/statuses/:id/card", StatusController, :card)
get("/statuses/:id/favourited_by", StatusController, :favourited_by)
get("/statuses/:id/reblogged_by", StatusController, :reblogged_by)
get("/statuses/:id/history", StatusController, :show_history)

30
test/pleroma/web/mastodon_api/controllers/status_controller_test.exs
View file

@ -1733,15 +1733,22 @@ defmodule Pleroma.Web.MastodonAPI.StatusControllerTest do
"description" =>
"Directed by Michael Bay. With Sean Connery, Nicolas Cage, Ed Harris, John Spencer."
}
}
},
"author_name" => "",
"author_url" => "",
"blurhash" => nil,
"embed_url" => "",
"height" => 0,
"html" => "",
"width" => 0
}
response =
conn
|> get("/api/v1/statuses/#{activity.id}/card")
|> get("/api/v1/statuses/#{activity.id}")
|> json_response_and_validate_schema(200)
assert response == card_data
assert response["card"] == card_data
# works with private posts
{:ok, activity} =
@ -1749,10 +1756,10 @@ defmodule Pleroma.Web.MastodonAPI.StatusControllerTest do
response_two =
conn
|> get("/api/v1/statuses/#{activity.id}/card")
|> get("/api/v1/statuses/#{activity.id}")
|> json_response_and_validate_schema(200)
assert response_two == card_data
assert response_two["card"] == card_data
end
test "replaces missing description with an empty string", %{conn: conn, user: user} do
@ -1762,10 +1769,10 @@ defmodule Pleroma.Web.MastodonAPI.StatusControllerTest do
response =
conn
|> get("/api/v1/statuses/#{activity.id}/card")
|> get("/api/v1/statuses/#{activity.id}")
|> json_response_and_validate_schema(:ok)
assert response == %{
assert response["card"] == %{
"type" => "link",
"title" => "Pleroma",
"description" => "",
@ -1779,7 +1786,14 @@ defmodule Pleroma.Web.MastodonAPI.StatusControllerTest do
"type" => "website",
"url" => "https://example.com/ogp-missing-data"
}
}
},
"author_name" => "",
"author_url" => "",
"blurhash" => nil,
"embed_url" => "",
"height" => 0,
"html" => "",
"width" => 0
}
end
end