v2-article-progress-article-progress.yaml 3.5 KB

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