aboutsummaryrefslogtreecommitdiff
path: root/lib/pleroma/web/api_spec.ex
diff options
context:
space:
mode:
authorlain <lain@soykaf.club>2020-04-09 13:25:27 +0200
committerlain <lain@soykaf.club>2020-04-09 13:25:27 +0200
commitd35e114acddf339ed398aeab02bf94abe229ac36 (patch)
treee35bbf60afa823fd1fdf2b0366249a31f040cd29 /lib/pleroma/web/api_spec.ex
parent8e637ae1a7b75fa08679ae9cf424650fc105de85 (diff)
parentb87b798ca1660224a3192c32b035c19b18e11587 (diff)
downloadpleroma-d35e114acddf339ed398aeab02bf94abe229ac36.tar.gz
Merge branch 'develop' of git.pleroma.social:pleroma/pleroma into remake-remodel-dms
Diffstat (limited to 'lib/pleroma/web/api_spec.ex')
-rw-r--r--lib/pleroma/web/api_spec.ex44
1 files changed, 44 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..41e48a085
--- /dev/null
+++ b/lib/pleroma/web/api_spec.ex
@@ -0,0 +1,44 @@
+# 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),
+ components: %OpenApiSpex.Components{
+ securitySchemes: %{
+ "oAuth" => %OpenApiSpex.SecurityScheme{
+ type: "oauth2",
+ flows: %OpenApiSpex.OAuthFlows{
+ password: %OpenApiSpex.OAuthFlow{
+ authorizationUrl: "/oauth/authorize",
+ tokenUrl: "/oauth/token",
+ scopes: %{"read" => "read"}
+ }
+ }
+ }
+ }
+ }
+ }
+ # discover request/response schemas from path specs
+ |> OpenApiSpex.resolve_schema_modules()
+ end
+end