2
0

v2-chapter-content-chapter-content.yaml 4.1 KB

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