v2-share-share.yaml 3.7 KB

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