Fix formatting of “Requires ROLE_*” lines.

master
Jakub Jirutka 2014-01-12 16:35:56 -08:00
parent bd2ffe133b
commit 40255ed517
1 changed files with 21 additions and 21 deletions

42
Api.md

@ -10,7 +10,7 @@ Endpoint: **`/api/clients`**
### GET /api/clients
_Requires **ROLE_USER** or **ROLE_ADMIN** access._
*Requires __ROLE_USER__ or __ROLE_ADMIN__ access.*
Get a list of all clients on the system, returns results in `application/json`.
@ -100,7 +100,7 @@ Get a list of all clients on the system, returns results in `application/json`.
### POST /api/clients
_Requires **ROLE_ADMIN** access._
*Requires __ROLE_ADMIN__ access.*
Create a new client on the system. Message body is an `application/json` object with all client parameters:
@ -174,7 +174,7 @@ The server will return an updated copy of the object in `application/json` forma
### GET /api/clients/{id}
_Requires **ROLE_USER** or **ROLE_ADMIN** access._
*Requires __ROLE_USER__ or __ROLE_ADMIN__ access.*
Get information about a specific client identified by {id} in the url, in `application/json` format.
@ -262,7 +262,7 @@ For example, the call to `/api/clients/1` would return:
### PUT /api/clients/{id}
_Requires **ROLE_ADMIN** access._
*Requires __ROLE_ADMIN__ access.*
Update the information for the client identified by {id} in the URL. The request body must be `application/json` describing the entire client object:
@ -337,7 +337,7 @@ The server will return an updated copy of the object in `application/json` forma
### DELETE /api/clients/{id}
_Requires **ROLE_ADMIN** access._
*Requires __ROLE_ADMIN__ access.*
Deletes the client with the {id} in the URL.
@ -351,7 +351,7 @@ Endpoint: **`/api/whitelist`**
### GET /api/whitelist
_Requires **ROLE_USER** or **ROLE_ADMIN** access._
*Requires __ROLE_USER__ or __ROLE_ADMIN__ access.*
Get a list of all whitelists on the system, returns results in `application/json`.
@ -372,7 +372,7 @@ Get a list of all whitelists on the system, returns results in `application/json
### POST /api/whitelist
_Requires **ROLE_ADMIN** access._
*Requires __ROLE_ADMIN__ access.*
Create a new whitelist on the system. Message body is an `application/json` object with all information:
@ -392,7 +392,7 @@ The server will return an updated copy of the object in `application/json` forma
### GET /api/whitelist/{id}
_Requires **ROLE_USER** or **ROLE_ADMIN** access._
*Requires __ROLE_USER__ or __ROLE_ADMIN__ access.*
Get information about a specific whitelist identified by {id} in the url, in `application/json` format.
@ -413,7 +413,7 @@ For example, the call to `/api/whitelist/1` would return:
### PUT /api/whitelist/{id}
_Requires **ROLE_ADMIN** access._
*Requires __ROLE_ADMIN__ access.*
Update the information for the whitelist identified by {id} in the URL. The request body must be `application/json` describing the entire whitelist object:
@ -434,7 +434,7 @@ The server will return an updated copy of the object in `application/json` forma
### DELETE /api/whitelist/{id}
_Requires **ROLE_ADMIN** access._
*Requires __ROLE_ADMIN__ access.*
Deletes the whitelist with the {id} in the URL.
@ -449,7 +449,7 @@ Endpoint: **`/api/blacklist`**
### GET /api/blacklist
_Requires **ROLE_USER** or **ROLE_ADMIN** access._
*Requires __ROLE_USER__ or __ROLE_ADMIN__ access.*
Get a list of all blacklists on the system, returns results in `application/json`.
@ -468,7 +468,7 @@ Get a list of all blacklists on the system, returns results in `application/json
### POST /api/blacklist
_Requires **ROLE_ADMIN** access._
*Requires __ROLE_ADMIN__ access.*
Create a new blacklist on the system. Message body is an `application/json` object with all information:
@ -482,7 +482,7 @@ The server will return an updated copy of the object in `application/json` forma
### GET /api/blacklist/{id}
_Requires **ROLE_USER** or **ROLE_ADMIN** access._
*Requires __ROLE_USER__ or __ROLE_ADMIN__ access.*
Get information about a specific blacklist identified by {id} in the url, in `application/json` format.
@ -496,7 +496,7 @@ For example, the call to `/api/blacklist/1` would return:
### PUT /api/blacklist/{id}
_Requires **ROLE_ADMIN** access._
*Requires __ROLE_ADMIN__ access.*
Update the information for the blacklist identified by {id} in the URL. The request body must be `application/json` describing the entire blacklist object:
@ -510,7 +510,7 @@ The server will return an updated copy of the object in `application/json` forma
### DELETE /api/blacklist/{id}
_Requires **ROLE_ADMIN** access._
*Requires __ROLE_ADMIN__ access.*
Deletes the blacklist with the {id} in the URL.
@ -524,7 +524,7 @@ Endpoint: **`/api/scopes`**
### GET /api/scopes
_Requires **ROLE_USER** or **ROLE_ADMIN** access._
*Requires __ROLE_USER__ or __ROLE_ADMIN__ access.*
Get a list of all system scopes on the system, returns results in `application/json`.
@ -583,7 +583,7 @@ Get a list of all system scopes on the system, returns results in `application/j
### POST /api/scopes
_Requires **ROLE_ADMIN** access._
*Requires __ROLE_ADMIN__ access.*
Create a new scope on the system. Message body is an `application/json` object with all information:
@ -601,7 +601,7 @@ The server will return an updated copy of the object in `application/json` forma
### GET /api/scopes/{id}
_Requires **ROLE_USER** or **ROLE_ADMIN** access._
*Requires __ROLE_USER__ or __ROLE_ADMIN__ access.*
Get information about a specific scope identified by {id} in the url, in `application/json` format.
@ -620,7 +620,7 @@ For example, the call to `/api/scope/1` would return:
### PUT /api/blacklist/{id}
_Requires **ROLE_ADMIN** access._
*Requires __ROLE_ADMIN__ access.*
Update the information for the scope identified by {id} in the URL. The request body must be `application/json` describing the entire scope object:
@ -639,7 +639,7 @@ The server will return an updated copy of the object in `application/json` forma
### DELETE /api/scope/{id}
_Requires **ROLE_ADMIN** access._
*Requires __ROLE_ADMIN__ access.*
Deletes the scope with the {id} in the URL. Any clients that are currently registered with the scope will retain this scope value but will no longer have the user-readable text or icon associated with it.
@ -653,7 +653,7 @@ Endpoint: **`/api/approved`**
### GET /api/approved
_Requires **ROLE_USER** access._
*Requires __ROLE_USER__ access.*
Gets a list of the approved sites for the current user in `application/json` format.