Commit 20e5a5c4 authored by Jacob Priddy's avatar Jacob Priddy 👌
Browse files

finish documentation on doors in case I don't get around to refactoring

parent 990acdeb
......@@ -95,7 +95,7 @@ class DoorsController extends ApiController
* This endpoint creates a new door in the system.
*
* @authenticated
* @bodyParam location string required Door Number or location describing where it is such as `CSP165`. Example: CSP165
* @bodyParam location string required Door Number or location describing where it is such as `CSP165`. Example: CSP165
* @bodyParam name string required The unique name for the door. Must be unique. Example: Engineering Lecture Hall
*
* @param \Source\UseCases\Doors\CreateDoor\CreateDoorUseCase $createDoor
......@@ -237,6 +237,14 @@ class DoorsController extends ApiController
}
/**
* Add Door to Group
*
* This endpoint attaches a door to a group.
*
* @authenticated
* @urlParam doorId required the door ID to attach. Example: 2
* @urlParam groupId required the group ID to attach to. Example: 8
*
* @param \Source\UseCases\DoorGroup\AddDoorToGroup\AddDoorToGroupUseCase $addDoorToGroup
* @param string $doorId
* @param string $groupId
......@@ -256,6 +264,14 @@ class DoorsController extends ApiController
}
/**
* Remove Door from Group
*
* This endpoint removes a door from a group.
*
* @authenticated
* @urlParam doorId required the door to detach. Example: 2
* @urlParam groupId required the group to detach from. Example: 8
*
* @param \Source\UseCases\DoorGroup\RemoveDoorFromGroup\RemoveDoorFromGroupUseCase $removeDoorFromGroup
* @param string $doorId
* @param string $groupId
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment