fix(mastodon-api): finish preview card compatibility
This commit is contained in:
Lain Soykaf
parent
7a741736ea
commit
c591ca518c
6 changed files with 174 additions and 115 deletions
|
|
@ -5,6 +5,7 @@
|
|||
defmodule Pleroma.Web.ApiSpec.Schemas.ChatMessage do
|
||||
alias OpenApiSpex.Schema
|
||||
alias Pleroma.Web.ApiSpec.Schemas.Emoji
|
||||
alias Pleroma.Web.ApiSpec.Schemas.PreviewCard
|
||||
|
||||
require OpenApiSpex
|
||||
|
||||
|
|
@ -22,36 +23,8 @@ defmodule Pleroma.Web.ApiSpec.Schemas.ChatMessage do
|
|||
emojis: %Schema{type: :array, items: Emoji},
|
||||
attachment: %Schema{type: :object, nullable: true},
|
||||
card: %Schema{
|
||||
type: :object,
|
||||
nullable: true,
|
||||
description: "Preview card for links included within status content",
|
||||
required: [:url, :title, :description, :type],
|
||||
properties: %{
|
||||
type: %Schema{
|
||||
type: :string,
|
||||
enum: ["link", "photo", "video", "rich"],
|
||||
description: "The type of the preview card"
|
||||
},
|
||||
provider_name: %Schema{
|
||||
type: :string,
|
||||
nullable: true,
|
||||
description: "The provider of the original resource"
|
||||
},
|
||||
provider_url: %Schema{
|
||||
type: :string,
|
||||
format: :uri,
|
||||
description: "A link to the provider of the original resource"
|
||||
},
|
||||
url: %Schema{type: :string, format: :uri, description: "Location of linked resource"},
|
||||
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"}
|
||||
}
|
||||
allOf: [PreviewCard],
|
||||
nullable: true
|
||||
},
|
||||
unread: %Schema{type: :boolean, description: "Whether a message has been marked as read."}
|
||||
},
|
||||
|
|
|
|||
109
lib/pleroma/web/api_spec/schemas/preview_card.ex
Normal file
109
lib/pleroma/web/api_spec/schemas/preview_card.ex
Normal file
|
|
@ -0,0 +1,109 @@
|
|||
# Pleroma: A lightweight social networking server
|
||||
# Copyright © 2017-2022 Pleroma Authors <https://pleroma.social/>
|
||||
# SPDX-License-Identifier: AGPL-3.0-only
|
||||
|
||||
defmodule Pleroma.Web.ApiSpec.Schemas.PreviewCard do
|
||||
alias OpenApiSpex.Schema
|
||||
alias Pleroma.Web.ApiSpec.Schemas.Account
|
||||
|
||||
require OpenApiSpex
|
||||
|
||||
OpenApiSpex.schema(%{
|
||||
title: "PreviewCard",
|
||||
description: "Preview card for a link included within status or chat message content",
|
||||
type: :object,
|
||||
required: [
|
||||
:url,
|
||||
:title,
|
||||
:description,
|
||||
:language,
|
||||
:type,
|
||||
:authors,
|
||||
:author_name,
|
||||
:author_url,
|
||||
:provider_name,
|
||||
:provider_url,
|
||||
:html,
|
||||
:width,
|
||||
:height,
|
||||
:image,
|
||||
:image_description,
|
||||
:embed_url,
|
||||
:blurhash,
|
||||
:published_at
|
||||
],
|
||||
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"},
|
||||
language: %Schema{
|
||||
type: :string,
|
||||
nullable: true,
|
||||
description: "Language of the linked resource"
|
||||
},
|
||||
type: %Schema{
|
||||
type: :string,
|
||||
enum: ["link", "photo", "video", "rich"],
|
||||
description: "The type of the preview card"
|
||||
},
|
||||
authors: %Schema{
|
||||
type: :array,
|
||||
description: "Fediverse accounts of the authors of the original resource",
|
||||
items: %Schema{
|
||||
type: :object,
|
||||
required: [:name, :url, :account],
|
||||
properties: %{
|
||||
name: %Schema{type: :string},
|
||||
url: %Schema{type: :string},
|
||||
account: %Schema{allOf: [Account], nullable: true}
|
||||
}
|
||||
}
|
||||
},
|
||||
author_name: %Schema{type: :string, description: "Author of the original resource"},
|
||||
author_url: %Schema{
|
||||
type: :string,
|
||||
description: "Link to the author of the original resource"
|
||||
},
|
||||
provider_name: %Schema{
|
||||
type: :string,
|
||||
description: "The provider of the original resource"
|
||||
},
|
||||
provider_url: %Schema{
|
||||
type: :string,
|
||||
description: "A link to the provider of the original 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"
|
||||
},
|
||||
image_description: %Schema{
|
||||
type: :string,
|
||||
description: "Alternate text that describes what is in the thumbnail"
|
||||
},
|
||||
embed_url: %Schema{
|
||||
type: :string,
|
||||
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."
|
||||
},
|
||||
published_at: %Schema{
|
||||
type: :string,
|
||||
nullable: true,
|
||||
description: "Publication date of the linked resource"
|
||||
}
|
||||
}
|
||||
})
|
||||
end
|
||||
|
|
@ -9,6 +9,7 @@ defmodule Pleroma.Web.ApiSpec.Schemas.Status do
|
|||
alias Pleroma.Web.ApiSpec.Schemas.Emoji
|
||||
alias Pleroma.Web.ApiSpec.Schemas.FlakeID
|
||||
alias Pleroma.Web.ApiSpec.Schemas.Poll
|
||||
alias Pleroma.Web.ApiSpec.Schemas.PreviewCard
|
||||
alias Pleroma.Web.ApiSpec.Schemas.Tag
|
||||
alias Pleroma.Web.ApiSpec.Schemas.VisibilityScope
|
||||
|
||||
|
|
@ -31,79 +32,8 @@ defmodule Pleroma.Web.ApiSpec.Schemas.Status do
|
|||
},
|
||||
bookmarked: %Schema{type: :boolean, description: "Have you bookmarked this status?"},
|
||||
card: %Schema{
|
||||
type: :object,
|
||||
nullable: true,
|
||||
description: "Preview card for links included within status content",
|
||||
# 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,
|
||||
description: "The provider of the original resource"
|
||||
},
|
||||
provider_url: %Schema{
|
||||
type: :string,
|
||||
format: :uri,
|
||||
description: "A link to the provider of the original 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"
|
||||
},
|
||||
image_description: %Schema{
|
||||
type: :string,
|
||||
description: "Alternate text that describes what is in the thumbnail"
|
||||
},
|
||||
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."
|
||||
}
|
||||
}
|
||||
allOf: [PreviewCard],
|
||||
nullable: true
|
||||
},
|
||||
content: %Schema{type: :string, format: :html, description: "HTML-encoded status content"},
|
||||
text: %Schema{
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue