v2-transfer-transfer.yaml 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220
  1. # 由 openapi/scripts/generate.php 生成,请勿手改;补充写到 overrides/v2-transfer-transfer.yaml
  2. get:
  3. summary: '获取单个 transfer/{transfer}'
  4. tags:
  5. - transfer
  6. operationId: get_api_v2_transfer_transfer_
  7. description: 实现:`TransferController@show`
  8. parameters:
  9. -
  10. name: transfer
  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. id:
  31. type: integer
  32. origin_owner:
  33. type: string
  34. res_type:
  35. type: string
  36. res_id:
  37. type: integer
  38. transferor:
  39. type: string
  40. new_owner:
  41. type: string
  42. status:
  43. type: integer
  44. updated_at:
  45. type: string
  46. created_at:
  47. type: string
  48. editor:
  49. type: string
  50. channel:
  51. type: string
  52. 401:
  53. $ref: '../../main.yaml#/components/responses/Unauthorized'
  54. 422:
  55. $ref: '../../main.yaml#/components/responses/ValidationError'
  56. put:
  57. summary: '更新 transfer/{transfer}'
  58. tags:
  59. - transfer
  60. operationId: put_api_v2_transfer_transfer_
  61. description: 实现:`TransferController@update`
  62. parameters:
  63. -
  64. name: transfer
  65. in: path
  66. required: true
  67. schema:
  68. type: string
  69. requestBody:
  70. required: false
  71. content:
  72. application/json:
  73. schema:
  74. type: object
  75. properties:
  76. status:
  77. type: string
  78. enum:
  79. - accept
  80. - refuse
  81. - cancel
  82. responses:
  83. 200:
  84. description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
  85. content:
  86. application/json:
  87. schema:
  88. type: object
  89. properties:
  90. ok:
  91. type: boolean
  92. message:
  93. type: string
  94. data:
  95. type: object
  96. properties:
  97. id:
  98. type: integer
  99. origin_owner:
  100. type: string
  101. res_type:
  102. type: string
  103. res_id:
  104. type: integer
  105. transferor:
  106. type: string
  107. new_owner:
  108. type: string
  109. status:
  110. type: integer
  111. updated_at:
  112. type: string
  113. created_at:
  114. type: string
  115. editor:
  116. type: string
  117. channel:
  118. type: string
  119. 401:
  120. $ref: '../../main.yaml#/components/responses/Unauthorized'
  121. 422:
  122. $ref: '../../main.yaml#/components/responses/ValidationError'
  123. patch:
  124. summary: '更新 transfer/{transfer}'
  125. tags:
  126. - transfer
  127. operationId: patch_api_v2_transfer_transfer_
  128. description: 实现:`TransferController@update`
  129. parameters:
  130. -
  131. name: transfer
  132. in: path
  133. required: true
  134. schema:
  135. type: string
  136. requestBody:
  137. required: false
  138. content:
  139. application/json:
  140. schema:
  141. type: object
  142. properties:
  143. status:
  144. type: string
  145. enum:
  146. - accept
  147. - refuse
  148. - cancel
  149. responses:
  150. 200:
  151. description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
  152. content:
  153. application/json:
  154. schema:
  155. type: object
  156. properties:
  157. ok:
  158. type: boolean
  159. message:
  160. type: string
  161. data:
  162. type: object
  163. properties:
  164. id:
  165. type: integer
  166. origin_owner:
  167. type: string
  168. res_type:
  169. type: string
  170. res_id:
  171. type: integer
  172. transferor:
  173. type: string
  174. new_owner:
  175. type: string
  176. status:
  177. type: integer
  178. updated_at:
  179. type: string
  180. created_at:
  181. type: string
  182. editor:
  183. type: string
  184. channel:
  185. type: string
  186. 401:
  187. $ref: '../../main.yaml#/components/responses/Unauthorized'
  188. 422:
  189. $ref: '../../main.yaml#/components/responses/ValidationError'
  190. delete:
  191. summary: '删除 transfer/{transfer}'
  192. tags:
  193. - transfer
  194. operationId: delete_api_v2_transfer_transfer_
  195. description: 实现:`TransferController@destroy`
  196. parameters:
  197. -
  198. name: transfer
  199. in: path
  200. required: true
  201. schema:
  202. type: string
  203. responses:
  204. 200:
  205. description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
  206. content:
  207. application/json:
  208. schema:
  209. type: object
  210. properties:
  211. ok:
  212. type: boolean
  213. message:
  214. type: string
  215. data:
  216. type: object
  217. 401:
  218. $ref: '../../main.yaml#/components/responses/Unauthorized'
  219. 422:
  220. $ref: '../../main.yaml#/components/responses/ValidationError'