aboutsummaryrefslogtreecommitdiff
path: root/lib/pleroma/web/api_spec/schemas/app_create_request.ex
diff options
context:
space:
mode:
authorEgor Kislitsyn <egor@kislitsyn.com>2020-04-10 14:20:48 +0400
committerEgor Kislitsyn <egor@kislitsyn.com>2020-04-10 14:20:48 +0400
commit7f692343c80ddf353712490edfbcdb14866f5685 (patch)
tree7ef90078d87fafb1eb25986c92af17a9eede37be /lib/pleroma/web/api_spec/schemas/app_create_request.ex
parentfc2eb1fbd6a5b38a3cf72e557cce1029d6b7f16f (diff)
parentce089615e1e89fbb63b0c0548906f3b6c22abac2 (diff)
downloadpleroma-7f692343c80ddf353712490edfbcdb14866f5685.tar.gz
Merge branch 'develop' into global-status-expiration
Diffstat (limited to 'lib/pleroma/web/api_spec/schemas/app_create_request.ex')
-rw-r--r--lib/pleroma/web/api_spec/schemas/app_create_request.ex33
1 files changed, 33 insertions, 0 deletions
diff --git a/lib/pleroma/web/api_spec/schemas/app_create_request.ex b/lib/pleroma/web/api_spec/schemas/app_create_request.ex
new file mode 100644
index 000000000..8a83abef3
--- /dev/null
+++ b/lib/pleroma/web/api_spec/schemas/app_create_request.ex
@@ -0,0 +1,33 @@
+# 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.Schemas.AppCreateRequest do
+ alias OpenApiSpex.Schema
+ require OpenApiSpex
+
+ OpenApiSpex.schema(%{
+ title: "AppCreateRequest",
+ description: "POST body for creating an app",
+ type: :object,
+ properties: %{
+ client_name: %Schema{type: :string, description: "A name for your application."},
+ redirect_uris: %Schema{
+ type: :string,
+ description:
+ "Where the user should be redirected after authorization. To display the authorization code to the user instead of redirecting to a web page, use `urn:ietf:wg:oauth:2.0:oob` in this parameter."
+ },
+ scopes: %Schema{
+ type: :string,
+ description: "Space separated list of scopes. If none is provided, defaults to `read`."
+ },
+ website: %Schema{type: :string, description: "A URL to the homepage of your app"}
+ },
+ required: [:client_name, :redirect_uris],
+ example: %{
+ "client_name" => "My App",
+ "redirect_uris" => "https://myapp.com/auth/callback",
+ "website" => "https://myapp.com/"
+ }
+ })
+end