Skip to content

Commit

Permalink
Remove deprecated annotations.
Browse files Browse the repository at this point in the history
  • Loading branch information
rottmann committed May 7, 2015
1 parent 5864c89 commit 4a24d42
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 16 deletions.
16 changes: 8 additions & 8 deletions example/_apidoc.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@
// Current Errors.
// ------------------------------------------------------------------------------------------
/**
* @apiDefineErrorStructure CreateUserError
* @apiDefine CreateUserError
* @apiVersion 0.2.0
*
*
* @apiError NoAccessRight Only authenticated Admins can access the data.
* @apiError UserNameTooShort Minimum of 5 characters required.
*
*
* @apiErrorExample Response (example):
* HTTP/1.1 400 Bad Request
* {
Expand All @@ -29,7 +29,7 @@
// Current Permissions.
// ------------------------------------------------------------------------------------------
/**
* @apiDefinePermission admin Admin access rights needed.
* @apiDefine admin Admin access rights needed.
* Optionally you can write here further Informations about the permission.
*
* An "apiDefinePermission"-block can have an "apiVersion", so you can attach the block to a specific version.
Expand All @@ -42,7 +42,7 @@
// History.
// ------------------------------------------------------------------------------------------
/**
* @apiDefinePermission admin This title is visible in version 0.1.0 and 0.2.0
* @apiDefine admin This title is visible in version 0.1.0 and 0.2.0
* @apiVersion 0.1.0
*/

Expand Down Expand Up @@ -91,10 +91,10 @@
*
* @apiDescription In this case "apiErrorStructure" is defined and used.
* Define blocks with params that will be used in several functions, so you dont have to rewrite them.
*
*
* @apiParam {String} name Name of the User.
*
* @apiSuccess {String} id The Users-ID.
*
* @apiErrorStructure CreateUserError
*/
* @apiUse CreateUserError
*/
2 changes: 1 addition & 1 deletion example/apidoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@
"withCompare": true,
"withGenerator": true
}
}
}
14 changes: 7 additions & 7 deletions example/example.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
* @apiPermission admin
*
* @apiDescription Compare Verison 0.3.0 with 0.2.0 and you will see the green markers with new items in version 0.3.0 and red markers with removed items since 0.2.0.
*
*
* @apiParam {Number} id The Users-ID.
*
* @apiExample Example usage:
* curl -i http://localhost/user/4711
*
* @apiSuccess {Number} id The Users-ID.
* @apiSuccess {Date} registered Registration Date.
* @apiSuccess {Date} registered Registration Date.
* @apiSuccess {Date} name Fullname of the User.
* @apiSuccess {String[]} nicknames List of Users nicknames (Array of Strings).
* @apiSuccess {Object} profile Profile data (example for an Object)
Expand All @@ -25,7 +25,7 @@
*
* @apiError NoAccessRight Only authenticated Admins can access the data.
* @apiError UserNotFound The <code>id</code> of the User was not found.
*
*
* @apiErrorExample Response (example):
* HTTP/1.1 401 Not Authenticated
* {
Expand All @@ -43,12 +43,12 @@ function getUser() { return; }
*
* @apiDescription In this case "apiErrorStructure" is defined and used.
* Define blocks with params that will be used in several functions, so you dont have to rewrite them.
*
*
* @apiParam {String} name Name of the User.
*
* @apiSuccess {Number} id The new Users-ID.
*
* @apiErrorStructure CreateUserError
* @apiUse CreateUserError
*/
function postUser() { return; }

Expand All @@ -63,6 +63,6 @@ function postUser() { return; }
*
* @apiParam {String} name Name of the User.
*
* @apiErrorStructure CreateUserError
* @apiUse CreateUserError
*/
function putUser() { return; }
function putUser() { return; }

0 comments on commit 4a24d42

Please sign in to comment.