mirror of
https://akkoma.dev/AkkomaGang/akkoma.git
synced 2024-12-15 06:39:05 +00:00
bd74ad9ce4
This brings it in line with its documentation and akkoma-fe’s expectations. For backwards compatibility URL parameters are still accept with lower priority. Unfortunately this means duplicating parameters and descriptions in the API spec. Usually Plug already pre-merges parameters from different sources into the plain 'params' parameter which then gets forwarded by Phoenix. However, OpenApiSpex 3.x prevents this; 4.x is set to change this https://github.com/open-api-spex/open_api_spex/issues/334 https://github.com/open-api-spex/open_api_spex/issues/92 Fixes: https://akkoma.dev/AkkomaGang/akkoma/issues/691 Fixes: https://akkoma.dev/AkkomaGang/akkoma/issues/722
454 lines
14 KiB
Elixir
454 lines
14 KiB
Elixir
# Pleroma: A lightweight social networking server
|
|
# Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
|
|
# SPDX-License-Identifier: AGPL-3.0-only
|
|
|
|
defmodule Pleroma.Web.ApiSpec.TwitterUtilOperation do
|
|
alias OpenApiSpex.Operation
|
|
alias OpenApiSpex.Schema
|
|
alias Pleroma.Web.ApiSpec.Schemas.ApiError
|
|
alias Pleroma.Web.ApiSpec.Schemas.BooleanLike
|
|
|
|
import Pleroma.Web.ApiSpec.Helpers
|
|
|
|
def open_api_operation(action) do
|
|
operation = String.to_existing_atom("#{action}_operation")
|
|
apply(__MODULE__, operation, [])
|
|
end
|
|
|
|
def emoji_operation do
|
|
%Operation{
|
|
tags: ["Emojis"],
|
|
summary: "List all custom emojis",
|
|
operationId: "UtilController.emoji",
|
|
parameters: [],
|
|
responses: %{
|
|
200 =>
|
|
Operation.response("List", "application/json", %Schema{
|
|
type: :object,
|
|
additionalProperties: %Schema{
|
|
type: :object,
|
|
properties: %{
|
|
image_url: %Schema{type: :string},
|
|
tags: %Schema{type: :array, items: %Schema{type: :string}}
|
|
}
|
|
},
|
|
example: %{
|
|
"firefox" => %{
|
|
"image_url" => "/emoji/firefox.png",
|
|
"tag" => ["Fun"]
|
|
}
|
|
}
|
|
})
|
|
}
|
|
}
|
|
end
|
|
|
|
def frontend_configurations_operation do
|
|
%Operation{
|
|
tags: ["Configuration"],
|
|
summary: "Dump frontend configurations",
|
|
operationId: "UtilController.frontend_configurations",
|
|
parameters: [],
|
|
responses: %{
|
|
200 =>
|
|
Operation.response("List", "application/json", %Schema{
|
|
type: :object,
|
|
additionalProperties: %Schema{type: :object}
|
|
})
|
|
}
|
|
}
|
|
end
|
|
|
|
def change_password_operation do
|
|
%Operation{
|
|
tags: ["Account credentials"],
|
|
summary: "Change account password",
|
|
security: [%{"oAuth" => ["write:accounts"]}],
|
|
operationId: "UtilController.change_password",
|
|
requestBody: request_body("Parameters", change_password_request(), required: true),
|
|
responses: %{
|
|
200 =>
|
|
Operation.response("Success", "application/json", %Schema{
|
|
type: :object,
|
|
properties: %{status: %Schema{type: :string, example: "success"}}
|
|
}),
|
|
400 => Operation.response("Error", "application/json", ApiError),
|
|
403 => Operation.response("Error", "application/json", ApiError)
|
|
}
|
|
}
|
|
end
|
|
|
|
defp change_password_request do
|
|
%Schema{
|
|
title: "ChangePasswordRequest",
|
|
description: "POST body for changing the account's password",
|
|
type: :object,
|
|
required: [:password, :new_password, :new_password_confirmation],
|
|
properties: %{
|
|
password: %Schema{type: :string, description: "Current password"},
|
|
new_password: %Schema{type: :string, description: "New password"},
|
|
new_password_confirmation: %Schema{
|
|
type: :string,
|
|
description: "New password, confirmation"
|
|
}
|
|
}
|
|
}
|
|
end
|
|
|
|
def change_email_operation do
|
|
%Operation{
|
|
tags: ["Account credentials"],
|
|
summary: "Change account email",
|
|
security: [%{"oAuth" => ["write:accounts"]}],
|
|
operationId: "UtilController.change_email",
|
|
requestBody: request_body("Parameters", change_email_request(), required: true),
|
|
responses: %{
|
|
200 =>
|
|
Operation.response("Success", "application/json", %Schema{
|
|
type: :object,
|
|
properties: %{status: %Schema{type: :string, example: "success"}}
|
|
}),
|
|
400 => Operation.response("Error", "application/json", ApiError),
|
|
403 => Operation.response("Error", "application/json", ApiError)
|
|
}
|
|
}
|
|
end
|
|
|
|
defp change_email_request do
|
|
%Schema{
|
|
title: "ChangeEmailRequest",
|
|
description: "POST body for changing the account's email",
|
|
type: :object,
|
|
required: [:email, :password],
|
|
properties: %{
|
|
email: %Schema{
|
|
type: :string,
|
|
description: "New email. Set to blank to remove the user's email."
|
|
},
|
|
password: %Schema{type: :string, description: "Current password"}
|
|
}
|
|
}
|
|
end
|
|
|
|
def update_notificaton_settings_operation do
|
|
%Operation{
|
|
tags: ["Accounts"],
|
|
summary: "Update Notification Settings",
|
|
security: [%{"oAuth" => ["write:accounts"]}],
|
|
operationId: "UtilController.update_notificaton_settings",
|
|
parameters: [
|
|
Operation.parameter(
|
|
:block_from_strangers,
|
|
:query,
|
|
BooleanLike,
|
|
"blocks notifications from accounts you do not follow"
|
|
),
|
|
Operation.parameter(
|
|
:hide_notification_contents,
|
|
:query,
|
|
BooleanLike,
|
|
"removes the contents of a message from the push notification"
|
|
)
|
|
],
|
|
requestBody: request_body("Parameters", update_notification_settings_request()),
|
|
responses: %{
|
|
200 =>
|
|
Operation.response("Success", "application/json", %Schema{
|
|
type: :object,
|
|
properties: %{status: %Schema{type: :string, example: "success"}}
|
|
}),
|
|
400 => Operation.response("Error", "application/json", ApiError)
|
|
}
|
|
}
|
|
end
|
|
|
|
def disable_account_operation do
|
|
%Operation{
|
|
tags: ["Account credentials"],
|
|
summary: "Disable Account",
|
|
security: [%{"oAuth" => ["write:accounts"]}],
|
|
operationId: "UtilController.disable_account",
|
|
parameters: [
|
|
Operation.parameter(:password, :query, :string, "Password")
|
|
],
|
|
responses: %{
|
|
200 =>
|
|
Operation.response("Success", "application/json", %Schema{
|
|
type: :object,
|
|
properties: %{status: %Schema{type: :string, example: "success"}}
|
|
}),
|
|
403 => Operation.response("Error", "application/json", ApiError)
|
|
}
|
|
}
|
|
end
|
|
|
|
def delete_account_operation do
|
|
%Operation{
|
|
tags: ["Account credentials"],
|
|
summary: "Delete Account",
|
|
security: [%{"oAuth" => ["write:accounts"]}],
|
|
operationId: "UtilController.delete_account",
|
|
parameters: [
|
|
Operation.parameter(:password, :query, :string, "Password")
|
|
],
|
|
requestBody: request_body("Parameters", delete_account_request(), required: false),
|
|
responses: %{
|
|
200 =>
|
|
Operation.response("Success", "application/json", %Schema{
|
|
type: :object,
|
|
properties: %{status: %Schema{type: :string, example: "success"}}
|
|
}),
|
|
403 => Operation.response("Error", "application/json", ApiError)
|
|
}
|
|
}
|
|
end
|
|
|
|
def captcha_operation do
|
|
%Operation{
|
|
summary: "Get a captcha",
|
|
operationId: "UtilController.captcha",
|
|
parameters: [],
|
|
responses: %{
|
|
200 => Operation.response("Success", "application/json", %Schema{type: :object})
|
|
}
|
|
}
|
|
end
|
|
|
|
def move_account_operation do
|
|
%Operation{
|
|
tags: ["Account credentials"],
|
|
summary: "Move account",
|
|
security: [%{"oAuth" => ["write:accounts"]}],
|
|
operationId: "UtilController.move_account",
|
|
requestBody: request_body("Parameters", move_account_request(), required: true),
|
|
responses: %{
|
|
200 =>
|
|
Operation.response("Success", "application/json", %Schema{
|
|
type: :object,
|
|
properties: %{status: %Schema{type: :string, example: "success"}}
|
|
}),
|
|
400 => Operation.response("Error", "application/json", ApiError),
|
|
403 => Operation.response("Error", "application/json", ApiError),
|
|
404 => Operation.response("Error", "application/json", ApiError)
|
|
}
|
|
}
|
|
end
|
|
|
|
defp move_account_request do
|
|
%Schema{
|
|
title: "MoveAccountRequest",
|
|
description: "POST body for moving the account",
|
|
type: :object,
|
|
required: [:password, :target_account],
|
|
properties: %{
|
|
password: %Schema{type: :string, description: "Current password"},
|
|
target_account: %Schema{
|
|
type: :string,
|
|
description: "The nickname of the target account to move to"
|
|
}
|
|
}
|
|
}
|
|
end
|
|
|
|
def list_aliases_operation do
|
|
%Operation{
|
|
tags: ["Account credentials"],
|
|
summary: "List account aliases",
|
|
security: [%{"oAuth" => ["read:accounts"]}],
|
|
operationId: "UtilController.list_aliases",
|
|
responses: %{
|
|
200 =>
|
|
Operation.response("Success", "application/json", %Schema{
|
|
type: :object,
|
|
properties: %{
|
|
aliases: %Schema{
|
|
type: :array,
|
|
items: %Schema{type: :string},
|
|
example: ["foo@example.org"]
|
|
}
|
|
}
|
|
}),
|
|
400 => Operation.response("Error", "application/json", ApiError),
|
|
403 => Operation.response("Error", "application/json", ApiError)
|
|
}
|
|
}
|
|
end
|
|
|
|
def add_alias_operation do
|
|
%Operation{
|
|
tags: ["Account credentials"],
|
|
summary: "Add an alias to this account",
|
|
security: [%{"oAuth" => ["write:accounts"]}],
|
|
operationId: "UtilController.add_alias",
|
|
requestBody: request_body("Parameters", add_alias_request(), required: true),
|
|
responses: %{
|
|
200 =>
|
|
Operation.response("Success", "application/json", %Schema{
|
|
type: :object,
|
|
properties: %{
|
|
status: %Schema{
|
|
type: :string,
|
|
example: "success"
|
|
}
|
|
}
|
|
}),
|
|
400 => Operation.response("Error", "application/json", ApiError),
|
|
403 => Operation.response("Error", "application/json", ApiError),
|
|
404 => Operation.response("Error", "application/json", ApiError)
|
|
}
|
|
}
|
|
end
|
|
|
|
defp add_alias_request do
|
|
%Schema{
|
|
title: "AddAliasRequest",
|
|
description: "PUT body for adding aliases",
|
|
type: :object,
|
|
required: [:alias],
|
|
properties: %{
|
|
alias: %Schema{
|
|
type: :string,
|
|
description: "The nickname of the account to add to aliases"
|
|
}
|
|
}
|
|
}
|
|
end
|
|
|
|
def delete_alias_operation do
|
|
%Operation{
|
|
tags: ["Account credentials"],
|
|
summary: "Delete an alias from this account",
|
|
security: [%{"oAuth" => ["write:accounts"]}],
|
|
operationId: "UtilController.delete_alias",
|
|
requestBody: request_body("Parameters", delete_alias_request(), required: true),
|
|
responses: %{
|
|
200 =>
|
|
Operation.response("Success", "application/json", %Schema{
|
|
type: :object,
|
|
properties: %{
|
|
status: %Schema{
|
|
type: :string,
|
|
example: "success"
|
|
}
|
|
}
|
|
}),
|
|
400 => Operation.response("Error", "application/json", ApiError),
|
|
403 => Operation.response("Error", "application/json", ApiError),
|
|
404 => Operation.response("Error", "application/json", ApiError)
|
|
}
|
|
}
|
|
end
|
|
|
|
defp delete_alias_request do
|
|
%Schema{
|
|
title: "DeleteAliasRequest",
|
|
description: "PUT body for deleting aliases",
|
|
type: :object,
|
|
required: [:alias],
|
|
properties: %{
|
|
alias: %Schema{
|
|
type: :string,
|
|
description: "The nickname of the account to delete from aliases"
|
|
}
|
|
}
|
|
}
|
|
end
|
|
|
|
def healthcheck_operation do
|
|
%Operation{
|
|
tags: ["Accounts"],
|
|
summary: "Quick status check on the instance",
|
|
security: [%{"oAuth" => ["write:accounts"]}],
|
|
operationId: "UtilController.healthcheck",
|
|
parameters: [],
|
|
responses: %{
|
|
200 => Operation.response("Healthy", "application/json", %Schema{type: :object}),
|
|
503 =>
|
|
Operation.response("Disabled or Unhealthy", "application/json", %Schema{type: :object})
|
|
}
|
|
}
|
|
end
|
|
|
|
def remote_subscribe_operation do
|
|
%Operation{
|
|
tags: ["Accounts"],
|
|
summary: "Remote Subscribe",
|
|
operationId: "UtilController.remote_subscribe",
|
|
parameters: [],
|
|
responses: %{200 => Operation.response("Web Page", "test/html", %Schema{type: :string})}
|
|
}
|
|
end
|
|
|
|
def remote_interaction_operation do
|
|
%Operation{
|
|
tags: ["Accounts"],
|
|
summary: "Remote interaction",
|
|
operationId: "UtilController.remote_interaction",
|
|
requestBody: request_body("Parameters", remote_interaction_request(), required: true),
|
|
responses: %{
|
|
200 =>
|
|
Operation.response("Remote interaction URL", "application/json", %Schema{type: :object})
|
|
}
|
|
}
|
|
end
|
|
|
|
defp remote_interaction_request do
|
|
%Schema{
|
|
title: "RemoteInteractionRequest",
|
|
description: "POST body for remote interaction",
|
|
type: :object,
|
|
required: [:ap_id, :profile],
|
|
properties: %{
|
|
ap_id: %Schema{type: :string, description: "Profile or status ActivityPub ID"},
|
|
profile: %Schema{type: :string, description: "Remote profile webfinger"}
|
|
}
|
|
}
|
|
end
|
|
|
|
def show_subscribe_form_operation do
|
|
%Operation{
|
|
tags: ["Accounts"],
|
|
summary: "Show remote subscribe form",
|
|
operationId: "UtilController.show_subscribe_form",
|
|
parameters: [],
|
|
responses: %{200 => Operation.response("Web Page", "test/html", %Schema{type: :string})}
|
|
}
|
|
end
|
|
|
|
defp delete_account_request do
|
|
%Schema{
|
|
title: "AccountDeleteRequest",
|
|
description: "POST body for deleting one's own account",
|
|
type: :object,
|
|
properties: %{
|
|
password: %Schema{
|
|
type: :string,
|
|
description: "The user's own password for confirmation.",
|
|
format: :password
|
|
}
|
|
},
|
|
example: %{
|
|
"password" => "prettyp0ony1313"
|
|
}
|
|
}
|
|
end
|
|
|
|
defp update_notification_settings_request do
|
|
%Schema{
|
|
title: "UpdateNotificationSettings",
|
|
description: "PUT paramenters (query, form or JSON) for updating notification settings",
|
|
type: :object,
|
|
properties: %{
|
|
block_from_strangers: %Schema{
|
|
type: :boolean,
|
|
description: "blocks notifications from accounts you do not follow"
|
|
},
|
|
hide_notification_contents: %Schema{
|
|
type: :boolean,
|
|
description: "removes the contents of a message from the push notification"
|
|
}
|
|
}
|
|
}
|
|
end
|
|
end
|