aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorkaniini <nenolod@gmail.com>2019-05-13 18:35:45 +0000
committerkaniini <nenolod@gmail.com>2019-05-13 18:35:45 +0000
commitf3e8f5b1f208b10130c7123e68af1e38575f180b (patch)
tree523d1f1cfa399f4ee6d841ba3098ecd87d8e67e7 /docs
parent5a4d55cf910f85b07f111972647a8b4410b5eb6b (diff)
parenta2be420f940fb8f181feeb9b0fb9759d433dcae1 (diff)
downloadpleroma-f3e8f5b1f208b10130c7123e68af1e38575f180b.tar.gz
Merge branch 'features/mastoapi/2.7.0-registration' into 'develop'
Features/mastoapi/2.7.0 registration Closes #773 See merge request pleroma/pleroma!1134
Diffstat (limited to 'docs')
-rw-r--r--docs/api/differences_in_mastoapi_responses.md10
-rw-r--r--docs/config.md6
2 files changed, 16 insertions, 0 deletions
diff --git a/docs/api/differences_in_mastoapi_responses.md b/docs/api/differences_in_mastoapi_responses.md
index d3ba41b6a..36b47608e 100644
--- a/docs/api/differences_in_mastoapi_responses.md
+++ b/docs/api/differences_in_mastoapi_responses.md
@@ -87,3 +87,13 @@ Additional parameters can be added to the JSON body/Form data:
`POST /oauth/token`
Post here request with grant_type=refresh_token to obtain new access token. Returns an access token.
+
+## Account Registration
+`POST /api/v1/accounts`
+
+Has theses additionnal parameters (which are the same as in Pleroma-API):
+ * `fullname`: optional
+ * `bio`: optional
+ * `captcha_solution`: optional, contains provider-specific captcha solution,
+ * `captcha_token`: optional, contains provider-specific captcha token
+ * `token`: invite token required when the registerations aren't public.
diff --git a/docs/config.md b/docs/config.md
index 43ea24d80..470f71b7c 100644
--- a/docs/config.md
+++ b/docs/config.md
@@ -105,6 +105,12 @@ config :pleroma, Pleroma.Emails.Mailer,
* `safe_dm_mentions`: If set to true, only mentions at the beginning of a post will be used to address people in direct messages. This is to prevent accidental mentioning of people when talking about them (e.g. "@friend hey i really don't like @enemy"). (Default: `false`)
* `healthcheck`: if set to true, system data will be shown on ``/api/pleroma/healthcheck``.
+## :app_account_creation
+REST API for creating an account settings
+* `enabled`: Enable/disable registration
+* `max_requests`: Number of requests allowed for creating accounts
+* `interval`: Interval for restricting requests for one ip (seconds)
+
## :logger
* `backends`: `:console` is used to send logs to stdout, `{ExSyslogger, :ex_syslogger}` to log to syslog, and `Quack.Logger` to log to Slack