143 lines
4.5 KiB
Elixir
143 lines
4.5 KiB
Elixir
# Pleroma: A lightweight social networking server
|
|
# Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
|
|
# SPDX-License-Identifier: AGPL-3.0-only
|
|
|
|
defmodule Pleroma.Web.ApiSpec.PleromaAccountOperation do
|
|
alias OpenApiSpex.Operation
|
|
alias OpenApiSpex.Schema
|
|
alias Pleroma.Web.ApiSpec.Schemas.Account
|
|
alias Pleroma.Web.ApiSpec.Schemas.AccountRelationship
|
|
alias Pleroma.Web.ApiSpec.Schemas.ApiError
|
|
alias Pleroma.Web.ApiSpec.Schemas.FlakeID
|
|
alias Pleroma.Web.ApiSpec.StatusOperation
|
|
|
|
import Pleroma.Web.ApiSpec.Helpers
|
|
|
|
def open_api_operation(action) do
|
|
operation = String.to_existing_atom("#{action}_operation")
|
|
apply(__MODULE__, operation, [])
|
|
end
|
|
|
|
def confirmation_resend_operation do
|
|
%Operation{
|
|
tags: ["Accounts"],
|
|
summary: "Resend confirmation email. Expects `email` or `nickname`",
|
|
operationId: "PleromaAPI.AccountController.confirmation_resend",
|
|
parameters: [
|
|
Operation.parameter(:email, :query, :string, "Email of that needs to be verified",
|
|
example: "cofe@cofe.io"
|
|
),
|
|
Operation.parameter(
|
|
:nickname,
|
|
:query,
|
|
:string,
|
|
"Nickname of user that needs to be verified",
|
|
example: "cofefe"
|
|
)
|
|
],
|
|
responses: %{
|
|
204 => no_content_response()
|
|
}
|
|
}
|
|
end
|
|
|
|
def favourites_operation do
|
|
%Operation{
|
|
tags: ["Accounts"],
|
|
summary: "Returns favorites timeline of any user",
|
|
operationId: "PleromaAPI.AccountController.favourites",
|
|
parameters: [id_param() | pagination_params()],
|
|
security: [%{"oAuth" => ["read:favourites"]}],
|
|
responses: %{
|
|
200 =>
|
|
Operation.response(
|
|
"Array of Statuses",
|
|
"application/json",
|
|
StatusOperation.array_of_statuses()
|
|
),
|
|
403 => Operation.response("Forbidden", "application/json", ApiError),
|
|
404 => Operation.response("Not Found", "application/json", ApiError)
|
|
}
|
|
}
|
|
end
|
|
|
|
def subscribe_operation do
|
|
%Operation{
|
|
tags: ["Accounts"],
|
|
summary: "Subscribe to receive notifications for all statuses posted by a user",
|
|
operationId: "PleromaAPI.AccountController.subscribe",
|
|
parameters: [id_param()],
|
|
security: [%{"oAuth" => ["follow", "write:follows"]}],
|
|
responses: %{
|
|
200 => Operation.response("Relationship", "application/json", AccountRelationship),
|
|
404 => Operation.response("Not Found", "application/json", ApiError)
|
|
}
|
|
}
|
|
end
|
|
|
|
def unsubscribe_operation do
|
|
%Operation{
|
|
tags: ["Accounts"],
|
|
summary: "Unsubscribe to stop receiving notifications from user statuses",
|
|
operationId: "PleromaAPI.AccountController.unsubscribe",
|
|
parameters: [id_param()],
|
|
security: [%{"oAuth" => ["follow", "write:follows"]}],
|
|
responses: %{
|
|
200 => Operation.response("Relationship", "application/json", AccountRelationship),
|
|
404 => Operation.response("Not Found", "application/json", ApiError)
|
|
}
|
|
}
|
|
end
|
|
|
|
def add_aliases_operation do
|
|
%Operation{
|
|
tags: ["Accounts"],
|
|
summary: "Add ActivityPub aliases",
|
|
operationId: "PleromaAPI.AccountController.add_aliases",
|
|
requestBody: request_body("Parameters", alias_request(), required: true),
|
|
security: [%{"oAuth" => ["write:accounts"]}],
|
|
responses: %{
|
|
200 => Operation.response("Account", "application/json", Account),
|
|
403 => Operation.response("Forbidden", "application/json", ApiError)
|
|
}
|
|
}
|
|
end
|
|
|
|
def delete_aliases_operation do
|
|
%Operation{
|
|
tags: ["Accounts"],
|
|
summary: "Delete ActivityPub aliases",
|
|
operationId: "PleromaAPI.AccountController.delete_aliases",
|
|
requestBody: request_body("Parameters", alias_request(), required: true),
|
|
security: [%{"oAuth" => ["write:accounts"]}],
|
|
responses: %{
|
|
200 => Operation.response("Account", "application/json", Account)
|
|
}
|
|
}
|
|
end
|
|
|
|
defp id_param do
|
|
Operation.parameter(:id, :path, FlakeID, "Account ID",
|
|
example: "9umDrYheeY451cQnEe",
|
|
required: true
|
|
)
|
|
end
|
|
|
|
defp alias_request do
|
|
%Schema{
|
|
title: "AccountAliasRequest",
|
|
description: "POST body for adding/deleting AP aliases",
|
|
type: :object,
|
|
properties: %{
|
|
aliases: %Schema{
|
|
type: :array,
|
|
items: %Schema{type: :string}
|
|
}
|
|
},
|
|
example: %{
|
|
"aliases" => ["https://beepboop.social/users/beep", "https://mushroom.kingdom/users/toad"]
|
|
}
|
|
}
|
|
end
|
|
end
|