ApiSpec.Schemas.Account: import description from differences_in_mastoapi_responses

This commit is contained in:
Haelwenn (lanodan) Monnier 2020-06-29 03:31:33 +02:00
parent efb5d64e50
commit 9f51b03eed
No known key found for this signature in database
GPG key ID: D5B7A8E43C997DEE

View file

@ -40,20 +40,53 @@ defmodule Pleroma.Web.ApiSpec.Schemas.Account do
pleroma: %Schema{ pleroma: %Schema{
type: :object, type: :object,
properties: %{ properties: %{
allow_following_move: %Schema{type: :boolean}, allow_following_move: %Schema{
background_image: %Schema{type: :string, nullable: true}, type: :boolean,
description: "whether the user allows automatically follow moved following accounts"
},
background_image: %Schema{type: :string, nullable: true, format: :uri},
chat_token: %Schema{type: :string}, chat_token: %Schema{type: :string},
confirmation_pending: %Schema{type: :boolean}, confirmation_pending: %Schema{
type: :boolean,
description:
"whether the user account is waiting on email confirmation to be activated"
},
hide_favorites: %Schema{type: :boolean}, hide_favorites: %Schema{type: :boolean},
hide_followers_count: %Schema{type: :boolean}, hide_followers_count: %Schema{
hide_followers: %Schema{type: :boolean}, type: :boolean,
hide_follows_count: %Schema{type: :boolean}, description: "whether the user has follower stat hiding enabled"
hide_follows: %Schema{type: :boolean}, },
is_admin: %Schema{type: :boolean}, hide_followers: %Schema{
is_moderator: %Schema{type: :boolean}, type: :boolean,
description: "whether the user has follower hiding enabled"
},
hide_follows_count: %Schema{
type: :boolean,
description: "whether the user has follow stat hiding enabled"
},
hide_follows: %Schema{
type: :boolean,
description: "whether the user has follow hiding enabled"
},
is_admin: %Schema{
type: :boolean,
description: "whether the user is an admin of the local instance"
},
is_moderator: %Schema{
type: :boolean,
description: "whether the user is a moderator of the local instance"
},
skip_thread_containment: %Schema{type: :boolean}, skip_thread_containment: %Schema{type: :boolean},
tags: %Schema{type: :array, items: %Schema{type: :string}}, tags: %Schema{
unread_conversation_count: %Schema{type: :integer}, type: :array,
items: %Schema{type: :string},
description:
"List of tags being used for things like extra roles or moderation(ie. marking all media as nsfw all)."
},
unread_conversation_count: %Schema{
type: :integer,
description: "The count of unread conversations. Only returned to the account owner."
},
notification_settings: %Schema{ notification_settings: %Schema{
type: :object, type: :object,
properties: %{ properties: %{
@ -66,7 +99,9 @@ defmodule Pleroma.Web.ApiSpec.Schemas.Account do
}, },
relationship: AccountRelationship, relationship: AccountRelationship,
settings_store: %Schema{ settings_store: %Schema{
type: :object type: :object,
description:
"A generic map of settings for frontends. Opaque to the backend. Only returned in `verify_credentials` and `update_credentials`"
} }
} }
}, },
@ -74,16 +109,32 @@ defmodule Pleroma.Web.ApiSpec.Schemas.Account do
type: :object, type: :object,
properties: %{ properties: %{
fields: %Schema{type: :array, items: AccountField}, fields: %Schema{type: :array, items: AccountField},
note: %Schema{type: :string}, note: %Schema{
type: :string,
description:
"Plaintext version of the bio without formatting applied by the backend, used for editing the bio."
},
privacy: VisibilityScope, privacy: VisibilityScope,
sensitive: %Schema{type: :boolean}, sensitive: %Schema{type: :boolean},
pleroma: %Schema{ pleroma: %Schema{
type: :object, type: :object,
properties: %{ properties: %{
actor_type: ActorType, actor_type: ActorType,
discoverable: %Schema{type: :boolean}, discoverable: %Schema{
no_rich_text: %Schema{type: :boolean}, type: :boolean,
show_role: %Schema{type: :boolean} description:
"whether the user allows discovery of the account in search results and other services."
},
no_rich_text: %Schema{
type: :boolean,
description:
"whether the HTML tags for rich-text formatting are stripped from all statuses requested from the API."
},
show_role: %Schema{
type: :boolean,
description:
"whether the user wants their role (e.g admin, moderator) to be shown"
}
} }
} }
} }