darkkirb/akkoma
1
0
Fork 0
forked from mirrors/akkoma
Code Pull requests Activity

federation_status: Add ApiSpec

Browse source
This commit is contained in:
Haelwenn (lanodan) Monnier 2020-10-16 01:13:52 +02:00
parent 3b5a7a6b14
commit aafdc975bd
No known key found for this signature in database
GPG key ID: D5B7A8E43C997DEE
3 changed files with 44 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
lib/pleroma/web/api_spec/operations/pleroma_instances_operation.ex Normal file
View file

@ -0,0 +1,40 @@
# 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.PleromaInstancesOperation do
alias OpenApiSpex.Operation
alias OpenApiSpex.Schema
def open_api_operation(action) do
operation = String.to_existing_atom("#{action}_operation")
apply(__MODULE__, operation, [])
end
def show_operation do
%Operation{
tags: ["PleromaInstances"],
summary: "Instances federation status",
description: "Information about instances deemed unreachable by the server",
operationId: "PleromaInstances.show",
responses: %{
200 => Operation.response("PleromaInstances", "application/json", pleroma_instances())
}
}
end
def pleroma_instances do
%Schema{
type: :object,
properties: %{
unreachable: %Schema{
type: :object,
properties: %{hostname: %Schema{type: :string, format: :"date-time"}}
}
},
example: %{
"unreachable" => %{"consistently-unreachable.name" => "2020-10-14 22:07:58.216473"}
}
}
end
end

4
lib/pleroma/web/pleroma_api/controllers/instances_controller.ex
View file

@ -7,7 +7,9 @@ defmodule Pleroma.Web.PleromaAPI.InstancesController do
alias Pleroma.Instances
# defdelegate open_api_operation(action), to: Pleroma.Web.ApiSpec.PleromaInstancesController
plug(Pleroma.Web.ApiSpec.CastAndValidate)
defdelegate open_api_operation(action), to: Pleroma.Web.ApiSpec.PleromaInstancesOperation
def show(conn, _params) do
unreachable =

4
test/pleroma/web/pleroma_api/controllers/instances_controller_test.exs
View file

@ -31,10 +31,8 @@ defmodule Pleroma.Web.PleromaApi.InstancesControllerTest do
assert conn
|> put_req_header("content-type", "application/json")
|> get("/api/v1/pleroma/federation_status")
|> json_response(200) == %{
|> json_response_and_validate_schema(200) == %{
"unreachable" => %{constant_host => to_string(constant_unreachable)}
}
# |> json_response_and_validate_schema(200)
end
end