aboutsummaryrefslogtreecommitdiff
path: root/lib/pleroma/web/api_spec/schemas/app_create_request.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/schemas/app_create_request.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/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