1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.Web.ApiSpec.AccountOperation do
6 alias OpenApiSpex.Operation
7 alias OpenApiSpex.Reference
8 alias OpenApiSpex.Schema
9 alias Pleroma.Web.ApiSpec.Schemas.Account
10 alias Pleroma.Web.ApiSpec.Schemas.AccountRelationship
11 alias Pleroma.Web.ApiSpec.Schemas.ActorType
12 alias Pleroma.Web.ApiSpec.Schemas.ApiError
13 alias Pleroma.Web.ApiSpec.Schemas.BooleanLike
14 alias Pleroma.Web.ApiSpec.Schemas.List
15 alias Pleroma.Web.ApiSpec.Schemas.Status
16 alias Pleroma.Web.ApiSpec.Schemas.VisibilityScope
18 import Pleroma.Web.ApiSpec.Helpers
20 @spec open_api_operation(atom) :: Operation.t()
21 def open_api_operation(action) do
22 operation = String.to_existing_atom("#{action}_operation")
23 apply(__MODULE__, operation, [])
26 @spec create_operation() :: Operation.t()
27 def create_operation do
30 summary: "Register an account",
32 "Creates a user and account records. Returns an account access token for the app that initiated the request. The app should save this token for later, and should wait for the user to confirm their account by clicking a link in their email inbox.",
33 operationId: "AccountController.create",
34 requestBody: request_body("Parameters", create_request(), required: true),
36 200 => Operation.response("Account", "application/json", create_response()),
37 400 => Operation.response("Error", "application/json", ApiError),
38 403 => Operation.response("Error", "application/json", ApiError),
39 429 => Operation.response("Error", "application/json", ApiError)
44 def verify_credentials_operation do
47 description: "Test to make sure that the user token works.",
48 summary: "Verify account credentials",
49 operationId: "AccountController.verify_credentials",
50 security: [%{"oAuth" => ["read:accounts"]}],
52 200 => Operation.response("Account", "application/json", Account)
57 def update_credentials_operation do
60 summary: "Update account credentials",
61 description: "Update the user's display and preferences.",
62 operationId: "AccountController.update_credentials",
63 security: [%{"oAuth" => ["write:accounts"]}],
64 requestBody: request_body("Parameters", update_credentials_request(), required: true),
66 200 => Operation.response("Account", "application/json", Account),
67 403 => Operation.response("Error", "application/json", ApiError)
72 def relationships_operation do
75 summary: "Check relationships to other accounts",
76 operationId: "AccountController.relationships",
77 description: "Find out whether a given account is followed, blocked, muted, etc.",
78 security: [%{"oAuth" => ["read:follows"]}],
84 oneOf: [%Schema{type: :array, items: %Schema{type: :string}}, %Schema{type: :string}]
91 200 => Operation.response("Account", "application/json", array_of_relationships())
100 operationId: "AccountController.show",
101 description: "View information about a profile.",
102 parameters: [%Reference{"$ref": "#/components/parameters/accountIdOrNickname"}],
104 200 => Operation.response("Account", "application/json", Account),
105 401 => Operation.response("Error", "application/json", ApiError),
106 404 => Operation.response("Error", "application/json", ApiError)
111 def statuses_operation do
115 operationId: "AccountController.statuses",
117 "Statuses posted to the given account. Public (for public statuses only), or user token + `read:statuses` (for private statuses the user is authorized to see)",
120 %Reference{"$ref": "#/components/parameters/accountIdOrNickname"},
121 Operation.parameter(:pinned, :query, BooleanLike, "Include only pinned statuses"),
122 Operation.parameter(:tagged, :query, :string, "With tag"),
127 "Include only statuses with media attached"
133 "Include statuses from muted acccounts."
135 Operation.parameter(:exclude_reblogs, :query, BooleanLike, "Exclude reblogs"),
136 Operation.parameter(:exclude_replies, :query, BooleanLike, "Exclude replies"),
138 :exclude_visibilities,
140 %Schema{type: :array, items: VisibilityScope},
141 "Exclude visibilities"
143 ] ++ pagination_params(),
145 200 => Operation.response("Statuses", "application/json", array_of_statuses()),
146 401 => Operation.response("Error", "application/json", ApiError),
147 404 => Operation.response("Error", "application/json", ApiError)
152 def followers_operation do
155 summary: "Followers",
156 operationId: "AccountController.followers",
157 security: [%{"oAuth" => ["read:accounts"]}],
159 "Accounts which follow the given account, if network is not hidden by the account owner.",
161 %Reference{"$ref": "#/components/parameters/accountIdOrNickname"},
162 Operation.parameter(:id, :query, :string, "ID of the resource owner"),
163 with_relationships_param() | pagination_params()
166 200 => Operation.response("Accounts", "application/json", array_of_accounts())
171 def following_operation do
174 summary: "Following",
175 operationId: "AccountController.following",
176 security: [%{"oAuth" => ["read:accounts"]}],
178 "Accounts which the given account is following, if network is not hidden by the account owner.",
180 %Reference{"$ref": "#/components/parameters/accountIdOrNickname"},
181 Operation.parameter(:id, :query, :string, "ID of the resource owner"),
182 with_relationships_param() | pagination_params()
184 responses: %{200 => Operation.response("Accounts", "application/json", array_of_accounts())}
188 def lists_operation do
191 summary: "Lists containing this account",
192 operationId: "AccountController.lists",
193 security: [%{"oAuth" => ["read:lists"]}],
194 description: "User lists that you have added this account to.",
195 parameters: [%Reference{"$ref": "#/components/parameters/accountIdOrNickname"}],
196 responses: %{200 => Operation.response("Lists", "application/json", array_of_lists())}
200 def follow_operation do
204 operationId: "AccountController.follow",
205 security: [%{"oAuth" => ["follow", "write:follows"]}],
206 description: "Follow the given account",
208 %Reference{"$ref": "#/components/parameters/accountIdOrNickname"}
218 description: "Receive this account's reblogs in home timeline? Defaults to true.",
226 200 => Operation.response("Relationship", "application/json", AccountRelationship),
227 400 => Operation.response("Error", "application/json", ApiError),
228 404 => Operation.response("Error", "application/json", ApiError)
233 def unfollow_operation do
237 operationId: "AccountController.unfollow",
238 security: [%{"oAuth" => ["follow", "write:follows"]}],
239 description: "Unfollow the given account",
240 parameters: [%Reference{"$ref": "#/components/parameters/accountIdOrNickname"}],
242 200 => Operation.response("Relationship", "application/json", AccountRelationship),
243 400 => Operation.response("Error", "application/json", ApiError),
244 404 => Operation.response("Error", "application/json", ApiError)
249 def mute_operation do
253 operationId: "AccountController.mute",
254 security: [%{"oAuth" => ["follow", "write:mutes"]}],
255 requestBody: request_body("Parameters", mute_request()),
257 "Mute the given account. Clients should filter statuses and notifications from this account, if received (e.g. due to a boost in the Home timeline).",
259 %Reference{"$ref": "#/components/parameters/accountIdOrNickname"},
263 %Schema{allOf: [BooleanLike], default: true},
264 "Mute notifications in addition to statuses? Defaults to `true`."
269 %Schema{type: :integer, default: 0},
270 "Expire the mute in `expires_in` seconds. Default 0 for infinity"
274 200 => Operation.response("Relationship", "application/json", AccountRelationship)
279 def unmute_operation do
283 operationId: "AccountController.unmute",
284 security: [%{"oAuth" => ["follow", "write:mutes"]}],
285 description: "Unmute the given account.",
286 parameters: [%Reference{"$ref": "#/components/parameters/accountIdOrNickname"}],
288 200 => Operation.response("Relationship", "application/json", AccountRelationship)
293 def block_operation do
297 operationId: "AccountController.block",
298 security: [%{"oAuth" => ["follow", "write:blocks"]}],
300 "Block the given account. Clients should filter statuses from this account if received (e.g. due to a boost in the Home timeline)",
301 parameters: [%Reference{"$ref": "#/components/parameters/accountIdOrNickname"}],
303 200 => Operation.response("Relationship", "application/json", AccountRelationship)
308 def unblock_operation do
312 operationId: "AccountController.unblock",
313 security: [%{"oAuth" => ["follow", "write:blocks"]}],
314 description: "Unblock the given account.",
315 parameters: [%Reference{"$ref": "#/components/parameters/accountIdOrNickname"}],
317 200 => Operation.response("Relationship", "application/json", AccountRelationship)
322 def follow_by_uri_operation do
325 summary: "Follow by URI",
326 operationId: "AccountController.follows",
327 security: [%{"oAuth" => ["follow", "write:follows"]}],
328 requestBody: request_body("Parameters", follow_by_uri_request(), required: true),
330 200 => Operation.response("Account", "application/json", AccountRelationship),
331 400 => Operation.response("Error", "application/json", ApiError),
332 404 => Operation.response("Error", "application/json", ApiError)
337 def mutes_operation do
340 summary: "Muted accounts",
341 operationId: "AccountController.mutes",
342 description: "Accounts the user has muted.",
343 security: [%{"oAuth" => ["follow", "read:mutes"]}],
345 200 => Operation.response("Accounts", "application/json", array_of_accounts())
350 def blocks_operation do
353 summary: "Blocked users",
354 operationId: "AccountController.blocks",
355 description: "View your blocks. See also accounts/:id/{block,unblock}",
356 security: [%{"oAuth" => ["read:blocks"]}],
358 200 => Operation.response("Accounts", "application/json", array_of_accounts())
363 def endorsements_operation do
366 summary: "Endorsements",
367 operationId: "AccountController.endorsements",
368 description: "Not implemented",
369 security: [%{"oAuth" => ["read:accounts"]}],
371 200 => empty_array_response()
376 def identity_proofs_operation do
379 summary: "Identity proofs",
380 operationId: "AccountController.identity_proofs",
381 # Validators complains about unused path params otherwise
383 %Reference{"$ref": "#/components/parameters/accountIdOrNickname"}
385 description: "Not implemented",
387 200 => empty_array_response()
392 defp create_request do
394 title: "AccountCreateRequest",
395 description: "POST body for creating an account",
397 required: [:username, :password, :agreement],
403 "Text that will be reviewed by moderators if registrations require manual approval"
405 username: %Schema{type: :string, description: "The desired username for the account"},
410 "The email address to be used for login. Required when `account_activation_required` is enabled.",
415 description: "The password to be used for login",
419 allOf: [BooleanLike],
421 "Whether the user agrees to the local rules, terms, and policies. These should be presented to the user in order to allow them to consent before setting this parameter to TRUE."
426 description: "The language of the confirmation email that will be sent"
428 # Pleroma-specific properties:
429 fullname: %Schema{type: :string, nullable: true, description: "Full name"},
430 bio: %Schema{type: :string, description: "Bio", nullable: true, default: ""},
431 captcha_solution: %Schema{
434 description: "Provider-specific captcha solution"
436 captcha_token: %Schema{
439 description: "Provider-specific captcha token"
441 captcha_answer_data: %Schema{
444 description: "Provider-specific captcha data"
449 description: "Invite token required when the registrations aren't public"
453 "username" => "cofe",
454 "email" => "cofe@example.com",
455 "password" => "secret",
456 "agreement" => "true",
462 # Note: this is a token response (if login succeeds!), but there's no oauth operation file yet.
463 defp create_response do
465 title: "AccountCreateResponse",
466 description: "Response schema for an account",
469 # The response when auto-login on create succeeds (token is issued):
470 token_type: %Schema{type: :string},
471 access_token: %Schema{type: :string},
472 refresh_token: %Schema{type: :string},
473 scope: %Schema{type: :string},
474 created_at: %Schema{type: :integer, format: :"date-time"},
475 me: %Schema{type: :string},
476 expires_in: %Schema{type: :integer},
478 # The response when registration succeeds but auto-login fails (no token):
479 identifier: %Schema{type: :string},
480 message: %Schema{type: :string}
482 # Note: example of successful registration with failed login response:
484 # "identifier" => "missing_confirmed_email",
485 # "message" => "You have been registered. Please check your email for further instructions."
488 "token_type" => "Bearer",
489 "access_token" => "i9hAVVzGld86Pl5JtLtizKoXVvtTlSCJvwaugCxvZzk",
490 "refresh_token" => "i9hAVVzGld86Pl5JtLtizKoXVvtTlSCJvwaugCxvZzz",
491 "created_at" => 1_585_918_714,
493 "scope" => "read write follow push",
494 "me" => "https://gensokyo.2hu/users/raymoo"
499 defp update_credentials_request do
501 title: "AccountUpdateCredentialsRequest",
502 description: "POST body for creating an account",
506 allOf: [BooleanLike],
508 description: "Whether the account has a bot flag."
510 display_name: %Schema{
513 description: "The display name to use for the profile."
515 note: %Schema{type: :string, description: "The account bio."},
519 description: "Avatar image encoded using multipart/form-data",
525 description: "Header image encoded using multipart/form-data",
529 allOf: [BooleanLike],
531 description: "Whether manual approval of follow requests is required."
533 accepts_chat_messages: %Schema{
534 allOf: [BooleanLike],
536 description: "Whether the user accepts receiving chat messages."
538 fields_attributes: %Schema{
541 %Schema{type: :array, items: attribute_field()},
542 %Schema{type: :object, additionalProperties: attribute_field()}
545 # NOTE: `source` field is not supported
550 # privacy: %Schema{type: :string},
551 # sensitive: %Schema{type: :boolean},
552 # language: %Schema{type: :string}
556 # Pleroma-specific fields
557 no_rich_text: %Schema{
558 allOf: [BooleanLike],
560 description: "html tags are stripped from all statuses requested from the API"
562 hide_followers: %Schema{
563 allOf: [BooleanLike],
565 description: "user's followers will be hidden"
567 hide_follows: %Schema{
568 allOf: [BooleanLike],
570 description: "user's follows will be hidden"
572 hide_followers_count: %Schema{
573 allOf: [BooleanLike],
575 description: "user's follower count will be hidden"
577 hide_follows_count: %Schema{
578 allOf: [BooleanLike],
580 description: "user's follow count will be hidden"
582 hide_favorites: %Schema{
583 allOf: [BooleanLike],
585 description: "user's favorites timeline will be hidden"
588 allOf: [BooleanLike],
590 description: "user's role (e.g admin, moderator) will be exposed to anyone in the
593 default_scope: VisibilityScope,
594 pleroma_settings_store: %Schema{
597 description: "Opaque user settings to be saved on the backend."
599 skip_thread_containment: %Schema{
600 allOf: [BooleanLike],
602 description: "Skip filtering out broken threads"
604 allow_following_move: %Schema{
605 allOf: [BooleanLike],
607 description: "Allows automatically follow moved following accounts"
609 pleroma_background_image: %Schema{
612 description: "Sets the background image of the user.",
615 discoverable: %Schema{
616 allOf: [BooleanLike],
619 "Discovery of this account in search results and other services is allowed."
621 actor_type: ActorType
625 display_name: "cofe",
627 fields_attributes: [%{name: "foo", value: "bar"}],
629 hide_followers: true,
631 hide_followers_count: false,
632 hide_follows_count: false,
633 hide_favorites: false,
635 default_scope: "private",
636 pleroma_settings_store: %{"pleroma-fe" => %{"key" => "val"}},
637 skip_thread_containment: false,
638 allow_following_move: false,
645 def array_of_accounts do
647 title: "ArrayOfAccounts",
650 example: [Account.schema().example]
654 defp array_of_relationships do
656 title: "ArrayOfRelationships",
657 description: "Response schema for account relationships",
659 items: AccountRelationship,
664 "showing_reblogs" => true,
665 "followed_by" => true,
667 "blocked_by" => true,
669 "muting_notifications" => false,
670 "requested" => false,
671 "domain_blocking" => false,
672 "subscribing" => false,
678 "showing_reblogs" => true,
679 "followed_by" => true,
681 "blocked_by" => true,
683 "muting_notifications" => false,
685 "domain_blocking" => false,
686 "subscribing" => false,
692 "showing_reblogs" => true,
693 "followed_by" => true,
695 "blocked_by" => false,
697 "muting_notifications" => false,
698 "requested" => false,
699 "domain_blocking" => true,
700 "subscribing" => true,
707 defp follow_by_uri_request do
709 title: "AccountFollowsRequest",
710 description: "POST body for muting an account",
713 uri: %Schema{type: :string, nullable: true, format: :uri}
721 title: "AccountMuteRequest",
722 description: "POST body for muting an account",
725 notifications: %Schema{
726 allOf: [BooleanLike],
728 description: "Mute notifications in addition to statuses? Defaults to true.",
734 description: "Expire the mute in `expires_in` seconds. Default 0 for infinity",
739 "notifications" => true,
740 "expires_in" => 86_400
745 defp array_of_lists do
747 title: "ArrayOfLists",
748 description: "Response schema for lists",
752 %{"id" => "123", "title" => "my list"},
753 %{"id" => "1337", "title" => "anotehr list"}
758 defp array_of_statuses do
760 title: "ArrayOfStatuses",
766 defp attribute_field do
768 title: "AccountAttributeField",
769 description: "Request schema for account custom fields",
772 name: %Schema{type: :string},
773 value: %Schema{type: :string}
775 required: [:name, :value],
778 "value" => "https://pleroma.com"