mirrors/pleroma
1
0
Fork 0
mirror of https://git.pleroma.social/pleroma/pleroma.git synced 2024-05-02 09:58:43 +00:00
Code Issues Projects Releases Wiki Activity

Status: Fill all MastoAPI required values in preview cards

Browse source
This commit is contained in:
Haelwenn (lanodan) Monnier 2024-02-15 00:57:34 +01:00
parent 626c22961f
commit 44faf9bb62
4 changed files with 68 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

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

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"},

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

@ -575,6 +575,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

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

@ -1739,7 +1739,14 @@ 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 =
@ -1785,7 +1792,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