aboutsummaryrefslogtreecommitdiff
path: root/lib/pleroma/web/api_spec.ex
diff options
context:
space:
mode:
authorEgor Kislitsyn <egor@kislitsyn.com>2020-04-01 23:00:59 +0400
committerEgor Kislitsyn <egor@kislitsyn.com>2020-04-01 23:13:08 +0400
commit23219e6fb3163bfac07fb5fb1b2602dcd27e47c2 (patch)
tree0e878d883de8d33d86ac334b74b25543fd62dc23 /lib/pleroma/web/api_spec.ex
parent8bd5ad8664479b722e6905306f6342f35e2a84d2 (diff)
downloadpleroma-23219e6fb3163bfac07fb5fb1b2602dcd27e47c2.tar.gz
Add OpenAPI
Diffstat (limited to 'lib/pleroma/web/api_spec.ex')
-rw-r--r--lib/pleroma/web/api_spec.ex30
1 files changed, 30 insertions, 0 deletions
diff --git a/lib/pleroma/web/api_spec.ex b/lib/pleroma/web/api_spec.ex
new file mode 100644
index 000000000..22f76d4bf
--- /dev/null
+++ b/lib/pleroma/web/api_spec.ex
@@ -0,0 +1,30 @@
+# 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 do
+ alias OpenApiSpex.OpenApi
+ alias Pleroma.Web.Endpoint
+ alias Pleroma.Web.Router
+
+ @behaviour OpenApi
+
+ @impl OpenApi
+ def spec do
+ %OpenApi{
+ servers: [
+ # Populate the Server info from a phoenix endpoint
+ OpenApiSpex.Server.from_endpoint(Endpoint)
+ ],
+ info: %OpenApiSpex.Info{
+ title: "Pleroma",
+ description: Application.spec(:pleroma, :description) |> to_string(),
+ version: Application.spec(:pleroma, :vsn) |> to_string()
+ },
+ # populate the paths from a phoenix router
+ paths: OpenApiSpex.Paths.from_router(Router)
+ }
+ # discover request/response schemas from path specs
+ |> OpenApiSpex.resolve_schema_modules()
+ end
+end