238 lines
6.6 KiB
Elixir
238 lines
6.6 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.ReportOperation do
|
|
alias OpenApiSpex.Operation
|
|
alias OpenApiSpex.Schema
|
|
alias Pleroma.Web.ApiSpec.Schemas.Account
|
|
alias Pleroma.Web.ApiSpec.Schemas.ApiError
|
|
alias Pleroma.Web.ApiSpec.Schemas.FlakeID
|
|
alias Pleroma.Web.ApiSpec.Schemas.Status
|
|
|
|
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", "Reports"],
|
|
summary: "Get a list of reports",
|
|
operationId: "AdminAPI.ReportController.index",
|
|
security: [%{"oAuth" => ["read:reports"]}],
|
|
parameters: [
|
|
Operation.parameter(
|
|
:state,
|
|
:query,
|
|
report_state(),
|
|
"Filter by report state"
|
|
),
|
|
Operation.parameter(
|
|
:limit,
|
|
:query,
|
|
%Schema{type: :integer},
|
|
"The number of records to retrieve"
|
|
),
|
|
Operation.parameter(
|
|
:page,
|
|
:query,
|
|
%Schema{type: :integer, default: 1},
|
|
"Page number"
|
|
),
|
|
Operation.parameter(
|
|
:page_size,
|
|
:query,
|
|
%Schema{type: :integer, default: 50},
|
|
"Number number of log entries per page"
|
|
)
|
|
],
|
|
responses: %{
|
|
200 =>
|
|
Operation.response("Response", "application/json", %Schema{
|
|
type: :object,
|
|
properties: %{
|
|
total: %Schema{type: :integer},
|
|
reports: %Schema{
|
|
type: :array,
|
|
items: report()
|
|
}
|
|
}
|
|
}),
|
|
403 => Operation.response("Forbidden", "application/json", ApiError)
|
|
}
|
|
}
|
|
end
|
|
|
|
def show_operation do
|
|
%Operation{
|
|
tags: ["Admin", "Reports"],
|
|
summary: "Get an individual report",
|
|
operationId: "AdminAPI.ReportController.show",
|
|
parameters: [id_param()],
|
|
security: [%{"oAuth" => ["read:reports"]}],
|
|
responses: %{
|
|
200 => Operation.response("Report", "application/json", report()),
|
|
404 => Operation.response("Not Found", "application/json", ApiError)
|
|
}
|
|
}
|
|
end
|
|
|
|
def update_operation do
|
|
%Operation{
|
|
tags: ["Admin", "Reports"],
|
|
summary: "Change the state of one or multiple reports",
|
|
operationId: "AdminAPI.ReportController.update",
|
|
security: [%{"oAuth" => ["write:reports"]}],
|
|
requestBody: request_body("Parameters", update_request(), required: true),
|
|
responses: %{
|
|
204 => no_content_response(),
|
|
400 => Operation.response("Bad Request", "application/json", update_400_response()),
|
|
403 => Operation.response("Forbidden", "application/json", ApiError)
|
|
}
|
|
}
|
|
end
|
|
|
|
def notes_create_operation do
|
|
%Operation{
|
|
tags: ["Admin", "Reports"],
|
|
summary: "Create report note",
|
|
operationId: "AdminAPI.ReportController.notes_create",
|
|
parameters: [id_param()],
|
|
requestBody:
|
|
request_body("Parameters", %Schema{
|
|
type: :object,
|
|
properties: %{
|
|
content: %Schema{type: :string, description: "The message"}
|
|
}
|
|
}),
|
|
security: [%{"oAuth" => ["write:reports"]}],
|
|
responses: %{
|
|
204 => no_content_response(),
|
|
404 => Operation.response("Not Found", "application/json", ApiError)
|
|
}
|
|
}
|
|
end
|
|
|
|
def notes_delete_operation do
|
|
%Operation{
|
|
tags: ["Admin", "Reports"],
|
|
summary: "Delete report note",
|
|
operationId: "AdminAPI.ReportController.notes_delete",
|
|
parameters: [
|
|
Operation.parameter(:report_id, :path, :string, "Report ID"),
|
|
Operation.parameter(:id, :path, :string, "Note ID")
|
|
],
|
|
security: [%{"oAuth" => ["write:reports"]}],
|
|
responses: %{
|
|
204 => no_content_response(),
|
|
404 => Operation.response("Not Found", "application/json", ApiError)
|
|
}
|
|
}
|
|
end
|
|
|
|
defp report_state do
|
|
%Schema{type: :string, enum: ["open", "closed", "resolved"]}
|
|
end
|
|
|
|
defp id_param do
|
|
Operation.parameter(:id, :path, FlakeID, "Report ID",
|
|
example: "9umDrYheeY451cQnEe",
|
|
required: true
|
|
)
|
|
end
|
|
|
|
defp report do
|
|
%Schema{
|
|
type: :object,
|
|
properties: %{
|
|
id: FlakeID,
|
|
state: report_state(),
|
|
account: account_admin(),
|
|
actor: account_admin(),
|
|
content: %Schema{type: :string},
|
|
created_at: %Schema{type: :string, format: :"date-time"},
|
|
statuses: %Schema{type: :array, items: Status},
|
|
notes: %Schema{
|
|
type: :array,
|
|
items: %Schema{
|
|
type: :object,
|
|
properties: %{
|
|
id: %Schema{type: :integer},
|
|
user_id: FlakeID,
|
|
content: %Schema{type: :string},
|
|
inserted_at: %Schema{type: :string, format: :"date-time"}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
end
|
|
|
|
defp account_admin do
|
|
%Schema{
|
|
title: "Account",
|
|
description: "Account view for admins",
|
|
type: :object,
|
|
properties:
|
|
Map.merge(Account.schema().properties, %{
|
|
nickname: %Schema{type: :string},
|
|
deactivated: %Schema{type: :boolean},
|
|
local: %Schema{type: :boolean},
|
|
roles: %Schema{
|
|
type: :object,
|
|
properties: %{
|
|
admin: %Schema{type: :boolean},
|
|
moderator: %Schema{type: :boolean}
|
|
}
|
|
},
|
|
confirmation_pending: %Schema{type: :boolean}
|
|
})
|
|
}
|
|
end
|
|
|
|
defp update_request do
|
|
%Schema{
|
|
type: :object,
|
|
required: [:reports],
|
|
properties: %{
|
|
reports: %Schema{
|
|
type: :array,
|
|
items: %Schema{
|
|
type: :object,
|
|
properties: %{
|
|
id: %Schema{allOf: [FlakeID], description: "Required, report ID"},
|
|
state: %Schema{
|
|
type: :string,
|
|
description:
|
|
"Required, the new state. Valid values are `open`, `closed` and `resolved`"
|
|
}
|
|
}
|
|
},
|
|
example: %{
|
|
"reports" => [
|
|
%{"id" => "123", "state" => "closed"},
|
|
%{"id" => "1337", "state" => "resolved"}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
end
|
|
|
|
defp update_400_response do
|
|
%Schema{
|
|
type: :array,
|
|
items: %Schema{
|
|
type: :object,
|
|
properties: %{
|
|
id: %Schema{allOf: [FlakeID], description: "Report ID"},
|
|
error: %Schema{type: :string, description: "Error message"}
|
|
}
|
|
}
|
|
}
|
|
end
|
|
end
|