v2-nav-article-nav-article.yaml 4.2 KB

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