Improve API docs formatting

This commit is contained in:
Eugen Rochko 2017-01-21 22:53:02 +01:00
parent e92a1cf436
commit 2baf0fabb4
4 changed files with 40 additions and 28 deletions

View file

@ -1,3 +1,6 @@
OAuth details
=============
We use the [Doorkeeper gem for OAuth](https://github.com/doorkeeper-gem/doorkeeper/wiki), so you can refer to their docs on specifics of the end-points.
The API is divided up into access scopes:
@ -6,4 +9,4 @@ The API is divided up into access scopes:
- `write`: Post statuses and upload media for statuses
- `follow`: Follow, unfollow, block, unblock
Multiple scopes can be requested during the authorization phase with the `scope` query param (space-separate the scopes).
Multiple scopes can be requested during the authorization phase with the `scope` query param (space-separate the scopes).