Commit d558671e authored by Jacob Priddy's avatar Jacob Priddy 👌

Fix apidoc generation

parent 0c516fd7
Pipeline #12493 failed with stages
in 3 minutes and 58 seconds
......@@ -34,13 +34,13 @@ class DoorsController extends ApiController
* List/Search Doors
*
* This endpoint can list/search/query the list of doors. If the parameter is not given, it returns all doors
* paginated.
* paginated. If either awol_seconds or active_seconds are negative, they will be ignored.
*
* @authenticated
* @paginated
* @queryParam query Searches doors for location, name, and version. Example: bat
* @queryParam awol_seconds Filters doors that have been missing for x seconds. Example: null
* @queryParam active_seconds Filters doors that have been seen in the last x seconds. Example: 10000
* @queryParam awol_seconds Filters doors that have been missing for x seconds. Example: -1
* @queryParam active_seconds Filters doors that have been seen in the last x seconds. Example: -1
*
* @param \Source\UseCases\Doors\GetDoors\GetDoorsUseCase $getDoors
* @return \Illuminate\Http\JsonResponse
......
......@@ -272,7 +272,7 @@ class MeController extends ApiController
* Deletes a request. You cannot delete a resolved request.
*
* @authenticated
* @urlParam requestId required The id of the request to delete. Example: 7
* @urlParam requestId required The id of the request to delete. Example: 3
*
* @param string $requestId
* @param \Source\UseCases\Requests\DeleteRequest\DeleteRequestUseCase $deleteRequest
......@@ -295,7 +295,7 @@ class MeController extends ApiController
* Updates a request. You cannot update a request that is not yours, or that is resolved.
*
* @authenticated
* @urlParam requestId required The id of the request to modify. Example: 7
* @urlParam requestId required The id of the request to modify. Example: 3
* @bodyParam title string The new request title. Example: New title request.
* @bodyParam request string The new body of the request. Example: Fixed type.
*
......
......@@ -264,7 +264,7 @@ class SchedulesController extends ApiController
* This endpoint returns all the events in a schedule for a specified date range.
*
* @authenticated
* @urlParam scheduleId required The schedule to get the events for. Example: 1
* @urlParam scheduleId required The schedule to get the events for. Example: 2
* @queryParam start required The start date to view events for. Example: 2020-04-03 12:43:22
* @queryParam end required The end date to see events for. Example: 2020-04-05 12:43:22
*
......
Markdown is supported
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