Skip to content

Commit

Permalink
Merge pull request #183 from Abhishekgoyal007/168-update_create_apido…
Browse files Browse the repository at this point in the history
…c_for_infrastructure

Update create apidoc for infrastructure
  • Loading branch information
Hitansh159 authored Jul 8, 2023
2 parents 87698a3 + fdf505c commit b1ea6eb
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions _apidoc.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@


// ------------------------------------------------------------------------------------------
// General apiDoc documentation blocks and old history blocks.
// ------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -140,3 +138,24 @@
* @apiError (Error 500) ServerError Something went wrong.
*/

// ------------------------------------------------------------------------------------------
// Infrastructure.
// ------------------------------------------------------------------------------------------

/**
* @api {post} /infrastructure/add Add Infrastructure
* @apiName AddInfrastructure
* @apiGroup Infrastructure
*
* @apiBody {String} name The name of the infrastructure.
* @apiBody {String} type The type of the infrastructure.
* @apiBody {String} wing The wing where the infrastructure is located.
* @apiBody {Number} floor The floor where the infrastructure is located.
* @apiBody {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.
*/

0 comments on commit b1ea6eb

Please sign in to comment.