1
0
Fork 0
forked from YokaiRick/akkoma
akkoma/lib/pleroma/web/api_spec.ex

53 lines
1.6 KiB
Elixir
Raw Normal View History

2020-04-01 19:00:59 +00:00
# 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 OpenApiSpex.Operation
2020-04-01 19:00:59 +00:00
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
2020-04-02 13:33:23 +00:00
paths: OpenApiSpex.Paths.from_router(Router),
components: %OpenApiSpex.Components{
parameters: %{
"accountIdOrNickname" =>
Operation.parameter(:id, :path, :string, "Account ID or nickname",
example: "123",
required: true
)
},
2020-04-02 13:33:23 +00:00
securitySchemes: %{
"oAuth" => %OpenApiSpex.SecurityScheme{
type: "oauth2",
flows: %OpenApiSpex.OAuthFlows{
password: %OpenApiSpex.OAuthFlow{
authorizationUrl: "/oauth/authorize",
tokenUrl: "/oauth/token",
2020-04-09 11:25:24 +00:00
scopes: %{"read" => "read", "write" => "write", "follow" => "follow"}
2020-04-02 13:33:23 +00:00
}
}
}
}
}
2020-04-01 19:00:59 +00:00
}
# discover request/response schemas from path specs
|> OpenApiSpex.resolve_schema_modules()
end
end