mirror of
https://github.com/mastodon/documentation
synced 2025-04-11 22:56:17 +02:00
Fix force_login
type & more (#894)
* Fix `force_login` type & more Makes `force_login` of type `bool` & moves optional parameters to bottom of table for consistency. * Fix `limit` type & provide descriptions * Fix typo
This commit is contained in:
parent
06cc977ff1
commit
0dc4745593
@ -30,9 +30,6 @@ Bearer <app token>
|
|||||||
{{< endapi-method-parameter >}}
|
{{< endapi-method-parameter >}}
|
||||||
{{< endapi-method-headers >}}
|
{{< endapi-method-headers >}}
|
||||||
{{< api-method-form-data-parameters >}}
|
{{< api-method-form-data-parameters >}}
|
||||||
{{< api-method-parameter name="reason" type="string" required=false >}}
|
|
||||||
Text that will be reviewed by moderators if registrations require manual approval.
|
|
||||||
{{< endapi-method-parameter >}}
|
|
||||||
{{< api-method-parameter name="username" type="string" required=true >}}
|
{{< api-method-parameter name="username" type="string" required=true >}}
|
||||||
The desired username for the account
|
The desired username for the account
|
||||||
{{< endapi-method-parameter >}}
|
{{< endapi-method-parameter >}}
|
||||||
@ -48,6 +45,9 @@ Whether the user agrees to the local rules, terms, and policies. These should be
|
|||||||
{{< api-method-parameter name="locale" type="string" required=true >}}
|
{{< api-method-parameter name="locale" type="string" required=true >}}
|
||||||
The language of the confirmation email that will be sent
|
The language of the confirmation email that will be sent
|
||||||
{{< endapi-method-parameter >}}
|
{{< endapi-method-parameter >}}
|
||||||
|
{{< api-method-parameter name="reason" type="string" required=false >}}
|
||||||
|
Text that will be reviewed by moderators if registrations require manual approval.
|
||||||
|
{{< endapi-method-parameter >}}
|
||||||
{{< endapi-method-form-data-parameters >}}
|
{{< endapi-method-form-data-parameters >}}
|
||||||
{{< endapi-method-request >}}
|
{{< endapi-method-request >}}
|
||||||
{{< api-method-response >}}
|
{{< api-method-response >}}
|
||||||
@ -711,10 +711,13 @@ Bearer <app token>
|
|||||||
{{< endapi-method-headers >}}
|
{{< endapi-method-headers >}}
|
||||||
{{< api-method-query-parameters >}}
|
{{< api-method-query-parameters >}}
|
||||||
{{< api-method-parameter name="max_id" type="string" required=false >}}
|
{{< api-method-parameter name="max_id" type="string" required=false >}}
|
||||||
|
**Internal parameter.** Use HTTP `Link` header for pagination.
|
||||||
{{< endapi-method-parameter >}}
|
{{< endapi-method-parameter >}}
|
||||||
{{< api-method-parameter name="since_id" type="string" required=false >}}
|
{{< api-method-parameter name="since_id" type="string" required=false >}}
|
||||||
|
**Internal parameter.** Use HTTP `Link` header for pagination.
|
||||||
{{< endapi-method-parameter >}}
|
{{< endapi-method-parameter >}}
|
||||||
{{< api-method-parameter name="limit" type="number" required=false >}}
|
{{< api-method-parameter name="limit" type="number" required=false >}}
|
||||||
|
Maximum number of results to return. Defaults to 40.
|
||||||
{{< endapi-method-parameter >}}
|
{{< endapi-method-parameter >}}
|
||||||
{{< endapi-method-query-parameters >}}
|
{{< endapi-method-query-parameters >}}
|
||||||
{{< endapi-method-request >}}
|
{{< endapi-method-request >}}
|
||||||
@ -857,7 +860,7 @@ Bearer <app token>
|
|||||||
{{< api-method-parameter name="since_id" type="string" required=false >}}
|
{{< api-method-parameter name="since_id" type="string" required=false >}}
|
||||||
**Internal parameter.** Use HTTP `Link` header for pagination.
|
**Internal parameter.** Use HTTP `Link` header for pagination.
|
||||||
{{< endapi-method-parameter >}}
|
{{< endapi-method-parameter >}}
|
||||||
{{< api-method-parameter name="limit" type="string" required=false >}}
|
{{< api-method-parameter name="limit" type="number" required=false >}}
|
||||||
Maximum number of results to return. Defaults to 40.
|
Maximum number of results to return. Defaults to 40.
|
||||||
{{< endapi-method-parameter >}}
|
{{< endapi-method-parameter >}}
|
||||||
{{< endapi-method-query-parameters >}}
|
{{< endapi-method-query-parameters >}}
|
||||||
@ -1981,7 +1984,7 @@ Bearer <user token>
|
|||||||
{{< api-method-parameter name="q" type="string" required=true >}}
|
{{< api-method-parameter name="q" type="string" required=true >}}
|
||||||
What to search for
|
What to search for
|
||||||
{{< endapi-method-parameter >}}
|
{{< endapi-method-parameter >}}
|
||||||
{{< api-method-parameter name="limit" type="string" required=false >}}
|
{{< api-method-parameter name="limit" type="number" required=false >}}
|
||||||
Maximum number of results. Defaults to 40.
|
Maximum number of results. Defaults to 40.
|
||||||
{{< endapi-method-parameter >}}
|
{{< endapi-method-parameter >}}
|
||||||
{{< api-method-parameter name="resolve" type="string" required=false >}}
|
{{< api-method-parameter name="resolve" type="string" required=false >}}
|
||||||
|
@ -16,9 +16,6 @@ Displays an authorization form to the user. If approved, it will create and retu
|
|||||||
{{< api-method-spec >}}
|
{{< api-method-spec >}}
|
||||||
{{< api-method-request >}}
|
{{< api-method-request >}}
|
||||||
{{< api-method-form-data-parameters >}}
|
{{< api-method-form-data-parameters >}}
|
||||||
{{< api-method-parameter name="force_login" type="string" required=false >}}
|
|
||||||
Added in 2.6.0. Forces the user to re-login, which is necessary for authorizing with multiple accounts from the same instance.
|
|
||||||
{{< endapi-method-parameter >}}
|
|
||||||
{{< api-method-parameter name="response_type" type="string" required=true >}}
|
{{< api-method-parameter name="response_type" type="string" required=true >}}
|
||||||
Should be set equal to `code`.
|
Should be set equal to `code`.
|
||||||
{{< endapi-method-parameter >}}
|
{{< endapi-method-parameter >}}
|
||||||
@ -31,6 +28,9 @@ Set a URI to redirect the user to. If this parameter is set to `urn:ietf:wg:oaut
|
|||||||
{{< api-method-parameter name="scope" type="string" required=false >}}
|
{{< api-method-parameter name="scope" type="string" required=false >}}
|
||||||
List of requested OAuth scopes, separated by spaces \(or by pluses, if using query parameters\). Must be a subset of scopes declared during app registration. If not provided, defaults to `read`.
|
List of requested OAuth scopes, separated by spaces \(or by pluses, if using query parameters\). Must be a subset of scopes declared during app registration. If not provided, defaults to `read`.
|
||||||
{{< endapi-method-parameter >}}
|
{{< endapi-method-parameter >}}
|
||||||
|
{{< api-method-parameter name="force_login" type="bool" required=false >}}
|
||||||
|
Added in 2.6.0. Forces the user to re-login, which is necessary for authorizing with multiple accounts from the same instance.
|
||||||
|
{{< endapi-method-parameter >}}
|
||||||
{{< endapi-method-form-data-parameters >}}
|
{{< endapi-method-form-data-parameters >}}
|
||||||
{{< endapi-method-request >}}
|
{{< endapi-method-request >}}
|
||||||
{{< api-method-response >}}
|
{{< api-method-response >}}
|
||||||
@ -71,6 +71,9 @@ Returns an access token, to be used during API calls that are not public.
|
|||||||
{{< api-method-spec >}}
|
{{< api-method-spec >}}
|
||||||
{{< api-method-request >}}
|
{{< api-method-request >}}
|
||||||
{{< api-method-form-data-parameters >}}
|
{{< api-method-form-data-parameters >}}
|
||||||
|
{{< api-method-parameter name="grant_type" type="string" required=true >}}
|
||||||
|
Set equal to `authorization_code` if `code` is provided in order to gain user-level access. Otherwise, set equal to `client_credentials` to obtain app-level access only.
|
||||||
|
{{< endapi-method-parameter >}}
|
||||||
{{< api-method-parameter name="client_id" type="string" required=true >}}
|
{{< api-method-parameter name="client_id" type="string" required=true >}}
|
||||||
Client ID, obtained during app registration
|
Client ID, obtained during app registration
|
||||||
{{< endapi-method-parameter >}}
|
{{< endapi-method-parameter >}}
|
||||||
@ -86,9 +89,6 @@ List of requested OAuth scopes, separated by spaces. Must be a subset of scopes
|
|||||||
{{< api-method-parameter name="code" type="string" required=false >}}
|
{{< api-method-parameter name="code" type="string" required=false >}}
|
||||||
A user authorization code, obtained via /oauth/authorize
|
A user authorization code, obtained via /oauth/authorize
|
||||||
{{< endapi-method-parameter >}}
|
{{< endapi-method-parameter >}}
|
||||||
{{< api-method-parameter name="grant_type" type="string" required=true >}}
|
|
||||||
Set equal to `authorization_code` if `code` is provided in order to gain user-level access. Otherwise, set equal to `client_credentials` to obtain app-level access only.
|
|
||||||
{{< endapi-method-parameter >}}
|
|
||||||
{{< endapi-method-form-data-parameters >}}
|
{{< endapi-method-form-data-parameters >}}
|
||||||
{{< endapi-method-request >}}
|
{{< endapi-method-request >}}
|
||||||
{{< api-method-response >}}
|
{{< api-method-response >}}
|
||||||
|
Loading…
x
Reference in New Issue
Block a user