chris/ruwuma
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

api: Improve docs for AuthScheme variants

Browse Source
This commit is contained in:
Jonas Platte 2020-12-13 12:19:54 +01:00
parent e1d621ebd0
commit b38ae1bb76
No known key found for this signature in database
GPG Key ID: CC154DE0E30B7C67
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
ruma-api/src/lib.rs
View File

@ -280,14 +280,17 @@ pub enum AuthScheme {
/// No authentication is performed. /// No authentication is performed.
None, None,
/// Authentication is performed by including an access token in the request headers. /// Authentication is performed by including an access token in the `Authentication` http
/// header, or an `access_token` query parameter.
///
/// It is recommended to use the header over the query parameter.
AccessToken, AccessToken,
/// Authentication is performed by including X-Matrix signatures in the request headers, /// Authentication is performed by including X-Matrix signatures in the request headers,
/// as defined in the federation API. /// as defined in the federation API.
ServerSignatures, ServerSignatures,
/// Authentication is performed by including an access token in the query parameters. /// Authentication is performed by setting the `access_token` query parameter.
QueryOnlyAccessToken, QueryOnlyAccessToken,
} }