561e1f2470
Pulled from https://git.pleroma.social/pleroma/pleroma/-/merge_requests/3721. This makes backups require its own scope (`read:backups`) instead of the `read:accounts` scope. Co-authored-by: Tusooa Zhu <tusooa@kazv.moe> Reviewed-on: https://akkoma.dev/AkkomaGang/akkoma/pulls/218 Co-authored-by: Norm <normandy@biribiri.dev> Co-committed-by: Norm <normandy@biribiri.dev>
79 lines
2.2 KiB
Elixir
79 lines
2.2 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.PleromaBackupOperation do
|
|
alias OpenApiSpex.Operation
|
|
alias OpenApiSpex.Schema
|
|
alias Pleroma.Web.ApiSpec.Schemas.ApiError
|
|
|
|
def open_api_operation(action) do
|
|
operation = String.to_existing_atom("#{action}_operation")
|
|
apply(__MODULE__, operation, [])
|
|
end
|
|
|
|
def index_operation do
|
|
%Operation{
|
|
tags: ["Backups"],
|
|
summary: "List backups",
|
|
security: [%{"oAuth" => ["read:backups"]}],
|
|
operationId: "PleromaAPI.BackupController.index",
|
|
responses: %{
|
|
200 =>
|
|
Operation.response(
|
|
"An array of backups",
|
|
"application/json",
|
|
%Schema{
|
|
type: :array,
|
|
items: backup()
|
|
}
|
|
),
|
|
400 => Operation.response("Bad Request", "application/json", ApiError)
|
|
}
|
|
}
|
|
end
|
|
|
|
def create_operation do
|
|
%Operation{
|
|
tags: ["Backups"],
|
|
summary: "Create a backup",
|
|
security: [%{"oAuth" => ["read:backups"]}],
|
|
operationId: "PleromaAPI.BackupController.create",
|
|
responses: %{
|
|
200 =>
|
|
Operation.response(
|
|
"An array of backups",
|
|
"application/json",
|
|
%Schema{
|
|
type: :array,
|
|
items: backup()
|
|
}
|
|
),
|
|
400 => Operation.response("Bad Request", "application/json", ApiError)
|
|
}
|
|
}
|
|
end
|
|
|
|
defp backup do
|
|
%Schema{
|
|
title: "Backup",
|
|
description: "Response schema for a backup",
|
|
type: :object,
|
|
properties: %{
|
|
inserted_at: %Schema{type: :string, format: :"date-time"},
|
|
content_type: %Schema{type: :string},
|
|
file_name: %Schema{type: :string},
|
|
file_size: %Schema{type: :integer},
|
|
processed: %Schema{type: :boolean}
|
|
},
|
|
example: %{
|
|
"content_type" => "application/zip",
|
|
"file_name" =>
|
|
"https://cofe.fe:4000/media/backups/archive-foobar-20200908T164207-Yr7vuT5Wycv-sN3kSN2iJ0k-9pMo60j9qmvRCdDqIew.zip",
|
|
"file_size" => 4105,
|
|
"inserted_at" => "2020-09-08T16:42:07.000Z",
|
|
"processed" => true
|
|
}
|
|
}
|
|
end
|
|
end
|