-
-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
make_api_doc_in_apidoc.js_for_create_request_infrastructure/add
- Loading branch information
1 parent
022398c
commit b1c43ff
Showing
1 changed file
with
17 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,17 @@ | ||
| // ------------------------------------------------------------------------------------------ | ||
| // General apiDoc documentation blocks and old history blocks. | ||
| // ------------------------------------------------------------------------------------------ | ||
|
|
||
| // ------------------------------------------------------------------------------------------ | ||
| // Current Success. | ||
| // ------------------------------------------------------------------------------------------ | ||
|
|
||
| // ------------------------------------------------------------------------------------------ | ||
| // Current Errors. | ||
| // ------------------------------------------------------------------------------------------ | ||
|
|
||
| // ------------------------------------------------------------------------------------------ | ||
| // Current Permissions. | ||
| // ------------------------------------------------------------------------------------------ | ||
|
|
||
| // ------------------------------------------------------------------------------------------ | ||
| // History. | ||
| // ------------------------------------------------------------------------------------------ | ||
| /** | ||
| * @api {post} /infrastructure/add Add Infrastructure | ||
| * @apiName AddInfrastructure | ||
| * @apiGroup Infrastructure | ||
| * | ||
| * @apiParam {String} name The name of the infrastructure. | ||
| * @apiParam {String} type The type of the infrastructure. | ||
| * @apiParam {String} wing The wing where the infrastructure is located. | ||
| * @apiParam {Number} floor The floor where the infrastructure is located. | ||
| * @apiParam {Number} capacity The capacity of the infrastructure. | ||
| * | ||
| * @apiSuccess {String} res Success message with the ID of the added infrastructure. | ||
| * | ||
| * @apiError (Error 500) DatabaseError Error while inserting in the database. | ||
| * | ||
| * @apiDescription Adds a new infrastructure to the system. | ||
| */ |