v2-group-group.yaml 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168
  1. # 由 openapi/scripts/generate.php 生成,请勿手改;补充写到 overrides/v2-group-group.yaml
  2. get:
  3. summary: '获取单个 group/{group}'
  4. tags:
  5. - group
  6. operationId: get_api_v2_group_group_
  7. description: 实现:`GroupController@show`
  8. parameters:
  9. -
  10. name: group
  11. in: path
  12. required: true
  13. schema:
  14. type: string
  15. responses:
  16. 200:
  17. description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
  18. content:
  19. application/json:
  20. schema:
  21. type: object
  22. properties:
  23. ok:
  24. type: boolean
  25. message:
  26. type: string
  27. data:
  28. type: object
  29. properties:
  30. uid:
  31. type: string
  32. name:
  33. type: string
  34. description:
  35. type: string
  36. owner:
  37. type: string
  38. studio:
  39. type: string
  40. updated_at:
  41. type: string
  42. created_at:
  43. type: string
  44. role:
  45. type: string
  46. 401:
  47. $ref: '../../main.yaml#/components/responses/Unauthorized'
  48. 422:
  49. $ref: '../../main.yaml#/components/responses/ValidationError'
  50. put:
  51. summary: '更新 group/{group}'
  52. tags:
  53. - group
  54. operationId: put_api_v2_group_group_
  55. description: 实现:`GroupController@update`
  56. parameters:
  57. -
  58. name: group
  59. in: path
  60. required: true
  61. schema:
  62. type: string
  63. requestBody:
  64. required: false
  65. content:
  66. application/json:
  67. schema:
  68. type: object
  69. properties:
  70. name:
  71. type: string
  72. description:
  73. type: string
  74. status:
  75. type: string
  76. responses:
  77. 200:
  78. description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
  79. content:
  80. application/json:
  81. schema:
  82. type: object
  83. properties:
  84. ok:
  85. type: boolean
  86. message:
  87. type: string
  88. data:
  89. type: object
  90. 401:
  91. $ref: '../../main.yaml#/components/responses/Unauthorized'
  92. 422:
  93. $ref: '../../main.yaml#/components/responses/ValidationError'
  94. patch:
  95. summary: '更新 group/{group}'
  96. tags:
  97. - group
  98. operationId: patch_api_v2_group_group_
  99. description: 实现:`GroupController@update`
  100. parameters:
  101. -
  102. name: group
  103. in: path
  104. required: true
  105. schema:
  106. type: string
  107. requestBody:
  108. required: false
  109. content:
  110. application/json:
  111. schema:
  112. type: object
  113. properties:
  114. name:
  115. type: string
  116. description:
  117. type: string
  118. status:
  119. type: string
  120. responses:
  121. 200:
  122. description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
  123. content:
  124. application/json:
  125. schema:
  126. type: object
  127. properties:
  128. ok:
  129. type: boolean
  130. message:
  131. type: string
  132. data:
  133. type: object
  134. 401:
  135. $ref: '../../main.yaml#/components/responses/Unauthorized'
  136. 422:
  137. $ref: '../../main.yaml#/components/responses/ValidationError'
  138. delete:
  139. summary: '删除 group/{group}'
  140. tags:
  141. - group
  142. operationId: delete_api_v2_group_group_
  143. description: 实现:`GroupController@destroy`
  144. parameters:
  145. -
  146. name: group
  147. in: path
  148. required: true
  149. schema:
  150. type: string
  151. responses:
  152. 200:
  153. description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
  154. content:
  155. application/json:
  156. schema:
  157. type: object
  158. properties:
  159. ok:
  160. type: boolean
  161. message:
  162. type: string
  163. data:
  164. type: object
  165. 401:
  166. $ref: '../../main.yaml#/components/responses/Unauthorized'
  167. 422:
  168. $ref: '../../main.yaml#/components/responses/ValidationError'