v2-progress-progress.yaml 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134
  1. # 由 openapi/scripts/generate.php 生成,请勿手改;补充写到 overrides/v2-progress-progress.yaml
  2. get:
  3. summary: '获取单个 progress/{progress}'
  4. tags:
  5. - progress
  6. operationId: get_api_v2_progress_progress_
  7. description: 实现:`ProgressChapterController@show`
  8. parameters:
  9. -
  10. name: progress
  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. book:
  31. type: integer
  32. para:
  33. type: integer
  34. channel_id:
  35. type: string
  36. title:
  37. type: string
  38. 401:
  39. $ref: '../../main.yaml#/components/responses/Unauthorized'
  40. 422:
  41. $ref: '../../main.yaml#/components/responses/ValidationError'
  42. put:
  43. summary: '更新 progress/{progress}'
  44. tags:
  45. - progress
  46. operationId: put_api_v2_progress_progress_
  47. description: 实现:`ProgressChapterController@update`
  48. parameters:
  49. -
  50. name: progress
  51. in: path
  52. required: true
  53. schema:
  54. type: string
  55. responses:
  56. 200:
  57. description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
  58. content:
  59. application/json:
  60. schema:
  61. type: object
  62. properties:
  63. ok:
  64. type: boolean
  65. message:
  66. type: string
  67. data:
  68. type: object
  69. 401:
  70. $ref: '../../main.yaml#/components/responses/Unauthorized'
  71. 422:
  72. $ref: '../../main.yaml#/components/responses/ValidationError'
  73. patch:
  74. summary: '更新 progress/{progress}'
  75. tags:
  76. - progress
  77. operationId: patch_api_v2_progress_progress_
  78. description: 实现:`ProgressChapterController@update`
  79. parameters:
  80. -
  81. name: progress
  82. in: path
  83. required: true
  84. schema:
  85. type: string
  86. responses:
  87. 200:
  88. description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
  89. content:
  90. application/json:
  91. schema:
  92. type: object
  93. properties:
  94. ok:
  95. type: boolean
  96. message:
  97. type: string
  98. data:
  99. type: object
  100. 401:
  101. $ref: '../../main.yaml#/components/responses/Unauthorized'
  102. 422:
  103. $ref: '../../main.yaml#/components/responses/ValidationError'
  104. delete:
  105. summary: '删除 progress/{progress}'
  106. tags:
  107. - progress
  108. operationId: delete_api_v2_progress_progress_
  109. description: 实现:`ProgressChapterController@destroy`
  110. parameters:
  111. -
  112. name: progress
  113. in: path
  114. required: true
  115. schema:
  116. type: string
  117. responses:
  118. 200:
  119. description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
  120. content:
  121. application/json:
  122. schema:
  123. type: object
  124. properties:
  125. ok:
  126. type: boolean
  127. message:
  128. type: string
  129. data:
  130. type: object
  131. 401:
  132. $ref: '../../main.yaml#/components/responses/Unauthorized'
  133. 422:
  134. $ref: '../../main.yaml#/components/responses/ValidationError'