Mods-for-HESK-Netsyms/api/common_api_doc.php

18 lines
454 B
PHP
Raw Normal View History

2015-11-28 22:25:51 -05:00
<?php
/**
* @apiDefine public Public
* A public API can be utilized by anyone, without the use of an `X-Auth-Token`.
*
*/
/**
* @apiDefine protected Protected
* A protected API can only be utilized by those with a valid `X-Auth-Token`.
*/
/**
* @apiDefine invalidXAuthToken 401 Unauthorized
* The `X-Auth-Token` provided is invalid.
*/
/**
* @apiDefine noTokenProvided 400 Bad Request
* No `X-Auth-Token` was provided.
*/