110 lines
3.0 KiB
Elixir
110 lines
3.0 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.Admin.MediaProxyCacheOperation do
|
|
alias OpenApiSpex.Operation
|
|
alias OpenApiSpex.Schema
|
|
alias Pleroma.Web.ApiSpec.Schemas.ApiError
|
|
|
|
import Pleroma.Web.ApiSpec.Helpers
|
|
|
|
def open_api_operation(action) do
|
|
operation = String.to_existing_atom("#{action}_operation")
|
|
apply(__MODULE__, operation, [])
|
|
end
|
|
|
|
def index_operation do
|
|
%Operation{
|
|
tags: ["Admin", "MediaProxyCache"],
|
|
summary: "Fetch a paginated list of all banned MediaProxy URLs in Cachex",
|
|
operationId: "AdminAPI.MediaProxyCacheController.index",
|
|
security: [%{"oAuth" => ["read:media_proxy_caches"]}],
|
|
parameters: [
|
|
Operation.parameter(
|
|
:page,
|
|
:query,
|
|
%Schema{type: :integer, default: 1},
|
|
"Page"
|
|
),
|
|
Operation.parameter(
|
|
:page_size,
|
|
:query,
|
|
%Schema{type: :integer, default: 50},
|
|
"Number of statuses to return"
|
|
)
|
|
],
|
|
responses: %{
|
|
200 => success_response()
|
|
}
|
|
}
|
|
end
|
|
|
|
def delete_operation do
|
|
%Operation{
|
|
tags: ["Admin", "MediaProxyCache"],
|
|
summary: "Remove a banned MediaProxy URL from Cachex",
|
|
operationId: "AdminAPI.MediaProxyCacheController.delete",
|
|
security: [%{"oAuth" => ["write:media_proxy_caches"]}],
|
|
requestBody:
|
|
request_body(
|
|
"Parameters",
|
|
%Schema{
|
|
type: :object,
|
|
required: [:urls],
|
|
properties: %{
|
|
urls: %Schema{type: :array, items: %Schema{type: :string, format: :uri}}
|
|
}
|
|
},
|
|
required: true
|
|
),
|
|
responses: %{
|
|
200 => success_response(),
|
|
400 => Operation.response("Error", "application/json", ApiError)
|
|
}
|
|
}
|
|
end
|
|
|
|
def purge_operation do
|
|
%Operation{
|
|
tags: ["Admin", "MediaProxyCache"],
|
|
summary: "Purge and optionally ban a MediaProxy URL",
|
|
operationId: "AdminAPI.MediaProxyCacheController.purge",
|
|
security: [%{"oAuth" => ["write:media_proxy_caches"]}],
|
|
requestBody:
|
|
request_body(
|
|
"Parameters",
|
|
%Schema{
|
|
type: :object,
|
|
required: [:urls],
|
|
properties: %{
|
|
urls: %Schema{type: :array, items: %Schema{type: :string, format: :uri}},
|
|
ban: %Schema{type: :boolean, default: true}
|
|
}
|
|
},
|
|
required: true
|
|
),
|
|
responses: %{
|
|
200 => success_response(),
|
|
400 => Operation.response("Error", "application/json", ApiError)
|
|
}
|
|
}
|
|
end
|
|
|
|
defp success_response do
|
|
Operation.response("Array of banned MediaProxy URLs in Cachex", "application/json", %Schema{
|
|
type: :object,
|
|
properties: %{
|
|
urls: %Schema{
|
|
type: :array,
|
|
items: %Schema{
|
|
type: :string,
|
|
format: :uri,
|
|
description: "MediaProxy URLs"
|
|
}
|
|
}
|
|
}
|
|
})
|
|
end
|
|
end
|