v2-anthology-anthology.yaml 6.5 KB

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