ulysia/szurubooru
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: update typos and formatting

Browse source
This commit is contained in:
rr- 2018-03-11 01:24:55 +01:00
parent 12b751f066
commit 141abf15c9
1 changed files with 18 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
API.md
View file

@ -99,11 +99,11 @@
Authentication is achieved by means of [basic HTTP Authentication is achieved by means of [basic HTTP
auth](https://en.wikipedia.org/wiki/Basic_access_authentication) or through the auth](https://en.wikipedia.org/wiki/Basic_access_authentication) or through the
use of [user token authentication](#user-token-authentication). For this reason, use of [user token authentication](#user-token-authentication). For this
it is recommended to connect through HTTPS. There are no sessions, so every reason, it is recommended to connect through HTTPS. There are no sessions, so
privileged request must be authenticated. Available privileges depend on the every privileged request must be authenticated. Available privileges depend on
user's rank. The way how rank translates to privileges is defined in the server's the user's rank. The way how rank translates to privileges is defined in the
configuration. server's configuration.
It is recommended to add `?bump-login` GET parameter to the first request in a It is recommended to add `?bump-login` GET parameter to the first request in a
client "session" (where the definition of a session is up to the client), so client "session" (where the definition of a session is up to the client), so
@ -114,8 +114,8 @@ that the user's last login time is kept up to date.
User token authentication works similarly to [basic HTTP User token authentication works similarly to [basic HTTP
auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Because it auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Because it
operates similarly to ***basic HTTP auth*** it is still recommended to connect operates similarly to ***basic HTTP auth*** it is still recommended to connect
through HTTPS. The authorization header uses the type of Token and the username through HTTPS. The authorization header uses the type of `Token` and the
and token are encoded as Base64 and sent as the second parameter. username and token are encoded as Base64 and sent as the second parameter.
Example header for user1:token-is-more-secure Example header for user1:token-is-more-secure
``` ```
@ -123,9 +123,9 @@ Authorization: Token dXNlcjE6dG9rZW4taXMtbW9yZS1zZWN1cmU=
``` ```
The benefit of token authentication is that beyond the initial login to acquire The benefit of token authentication is that beyond the initial login to acquire
the first token, there is no need to transmit the user password in plaintext via the first token, there is no need to transmit the user password in plaintext
basic auth. Additionally tokens can be revoked at anytime allowing a cleaner via basic auth. Additionally tokens can be revoked at anytime allowing a
interface for isolating clients from user credentials. cleaner interface for isolating clients from user credentials.
## Basic requests ## Basic requests
@ -1511,7 +1511,7 @@ data.
- **Description** - **Description**
Searches for users tokens for the currently logged in user. Searches for user tokens for the given user.
## Creating a user token ## Creating a user token
- **Request** - **Request**
@ -1538,7 +1538,7 @@ data.
- **Description** - **Description**
Creates a new user token that can be used for authentication of api Creates a new user token that can be used for authentication of API
endpoints instead of a password. endpoints instead of a password.
## Updating a user token ## Updating a user token
@ -1861,7 +1861,7 @@ A single user token.
- `<enabled>`: whether the token is still valid for authentication. - `<enabled>`: whether the token is still valid for authentication.
- `<expiration-time>`: time when the token expires. It must include the timezone as per RFC3339. - `<expiration-time>`: time when the token expires. It must include the timezone as per RFC3339.
- `<version>`: resource version. See [versioning](#versioning). - `<version>`: resource version. See [versioning](#versioning).
- `<creation-time>`: time the user token was created , formatted as per RFC 3339. - `<creation-time>`: time the user token was created, formatted as per RFC 3339.
- `<last-edit-time>`: time the user token was edited, formatted as per RFC 3339. - `<last-edit-time>`: time the user token was edited, formatted as per RFC 3339.
- `<last-usage-time>`: the last time this token was used during a login involving `?bump-login`, formatted as per RFC 3339. - `<last-usage-time>`: the last time this token was used during a login involving `?bump-login`, formatted as per RFC 3339.