v2-article-map-article-map.yaml 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180
  1. # 由 openapi/scripts/generate.php 生成,请勿手改;补充写到 overrides/v2-article-map-article-map.yaml
  2. get:
  3. summary: '获取单个 article-map/{article_map}'
  4. tags:
  5. - article-map
  6. operationId: get_api_v2_article_map_article_map_
  7. description: 实现:`ArticleMapController@show`
  8. parameters:
  9. -
  10. name: article_map
  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. collect_id:
  33. type: integer
  34. article_id:
  35. type: integer
  36. level:
  37. type: integer
  38. title:
  39. type: string
  40. editor:
  41. type: string
  42. children:
  43. type: string
  44. status:
  45. type: integer
  46. deleted_at:
  47. type: string
  48. created_at:
  49. type: string
  50. updated_at:
  51. type: string
  52. format:
  53. type: string
  54. title_text:
  55. type: string
  56. 401:
  57. $ref: '../../main.yaml#/components/responses/Unauthorized'
  58. 422:
  59. $ref: '../../main.yaml#/components/responses/ValidationError'
  60. put:
  61. summary: '更新 article-map/{article_map}'
  62. tags:
  63. - article-map
  64. operationId: put_api_v2_article_map_article_map_
  65. description: 实现:`ArticleMapController@update`
  66. parameters:
  67. -
  68. name: article_map
  69. in: path
  70. required: true
  71. schema:
  72. type: string
  73. requestBody:
  74. required: true
  75. content:
  76. application/json:
  77. schema:
  78. type: object
  79. properties:
  80. operation:
  81. type: string
  82. description: 规则:required
  83. data:
  84. type: string
  85. required:
  86. - operation
  87. responses:
  88. 200:
  89. description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
  90. content:
  91. application/json:
  92. schema:
  93. type: object
  94. properties:
  95. ok:
  96. type: boolean
  97. message:
  98. type: string
  99. data:
  100. type: object
  101. 401:
  102. $ref: '../../main.yaml#/components/responses/Unauthorized'
  103. 422:
  104. $ref: '../../main.yaml#/components/responses/ValidationError'
  105. patch:
  106. summary: '更新 article-map/{article_map}'
  107. tags:
  108. - article-map
  109. operationId: patch_api_v2_article_map_article_map_
  110. description: 实现:`ArticleMapController@update`
  111. parameters:
  112. -
  113. name: article_map
  114. in: path
  115. required: true
  116. schema:
  117. type: string
  118. requestBody:
  119. required: true
  120. content:
  121. application/json:
  122. schema:
  123. type: object
  124. properties:
  125. operation:
  126. type: string
  127. description: 规则:required
  128. data:
  129. type: string
  130. required:
  131. - operation
  132. responses:
  133. 200:
  134. description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
  135. content:
  136. application/json:
  137. schema:
  138. type: object
  139. properties:
  140. ok:
  141. type: boolean
  142. message:
  143. type: string
  144. data:
  145. type: object
  146. 401:
  147. $ref: '../../main.yaml#/components/responses/Unauthorized'
  148. 422:
  149. $ref: '../../main.yaml#/components/responses/ValidationError'
  150. delete:
  151. summary: '删除 article-map/{article_map}'
  152. tags:
  153. - article-map
  154. operationId: delete_api_v2_article_map_article_map_
  155. description: 实现:`ArticleMapController@destroy`
  156. parameters:
  157. -
  158. name: article_map
  159. in: path
  160. required: true
  161. schema:
  162. type: string
  163. responses:
  164. 200:
  165. description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
  166. content:
  167. application/json:
  168. schema:
  169. type: object
  170. properties:
  171. ok:
  172. type: boolean
  173. message:
  174. type: string
  175. data:
  176. type: object
  177. 401:
  178. $ref: '../../main.yaml#/components/responses/Unauthorized'
  179. 422:
  180. $ref: '../../main.yaml#/components/responses/ValidationError'