routes.php 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  1. <?php
  2. //
  3. // Allow indentation with tab(s).
  4. //
  5. // http://www.doctrine-project.org/jira/browse/DCOM-255
  6. // https://github.com/zircote/swagger-php/issues/168
  7. // https://github.com/zircote/swagger-php/issues/203
  8. //
  9. // @codingStandardsIgnoreStart
  10. //
  11. /**
  12. *
  13. * @OA\Put(
  14. * path="/users/{id}",
  15. * tags={"users"},
  16. * operationId="updateUser",
  17. * summary="Update user entry",
  18. * @OA\Parameter(
  19. * name="id",
  20. * in="path",
  21. * required=true,
  22. * description="UUID",
  23. * ),
  24. * @OA\Parameter(
  25. * name="user",
  26. * in="cookie",
  27. * required=true,
  28. * @OA\Schema(ref="#/components/schemas/User"),
  29. * ),
  30. * @OA\Response(
  31. * response=200,
  32. * description="success",
  33. * ),
  34. * @OA\Response(
  35. * response="default",
  36. * description="error",
  37. * @OA\Schema(ref="#/components/schemas/Error"),
  38. * ),
  39. * )
  40. * @OA\Options(
  41. * path="/users/{id}",
  42. * @OA\Response(response=200,description="Some CORS stuff"),
  43. * @OA\Response(response="4XX",description="Some Client Error response"),
  44. * @OA\Response(response="5XX",description="Some Server Error response")
  45. * )
  46. */
  47. Route::put('/users/{user_id}', 'UserController@update');
  48. /**
  49. *
  50. * @OA\Delete(
  51. * path="/users/{id}",
  52. * tags={"users"},
  53. * operationId="deleteUser",
  54. * summary="Remove user entry",
  55. * @OA\Parameter(
  56. * name="id",
  57. * in="path",
  58. * required=true,
  59. * description="UUID",
  60. * ),
  61. * @OA\Response(
  62. * response=200,
  63. * description="success",
  64. * ),
  65. * @OA\Response(
  66. * response="default",
  67. * description="error",
  68. * @OA\Schema(ref="#/components/schemas/Error"),
  69. * ),
  70. * )
  71. *
  72. */
  73. Route::delete('/users/{user_id}', 'UserController@destroy');
  74. /**
  75. *@OA\Head(path="/users/{id}",@OA\Response(response=200,description="Only checking if it exists"))
  76. */
  77. Route::get('/users/{user_id}', 'UserController@show');
  78. /**
  79. * @OA\Schema(schema="Error")
  80. * @OA\Schema(schema="User")
  81. */
  82. //
  83. // @codingStandardsIgnoreEnd
  84. //