v2-group-member.yaml 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141
  1. # 由 openapi/scripts/generate.php 生成,请勿手改;补充写到 overrides/v2-group-member.yaml
  2. get:
  3. summary: '列出 group-member'
  4. tags:
  5. - group-member
  6. operationId: get_api_v2_group_member
  7. description: 实现:`GroupMemberController@index`
  8. parameters:
  9. -
  10. name: view
  11. in: query
  12. schema:
  13. type: string
  14. enum:
  15. - group
  16. - user
  17. -
  18. name: id
  19. in: query
  20. schema:
  21. type: string
  22. -
  23. name: offset
  24. in: query
  25. schema:
  26. type: string
  27. -
  28. name: limit
  29. in: query
  30. schema:
  31. type: string
  32. -
  33. name: search
  34. in: query
  35. description: 搜索关键字
  36. schema:
  37. type: string
  38. -
  39. name: order
  40. in: query
  41. description: 排序字段
  42. schema:
  43. type: string
  44. -
  45. name: dir
  46. in: query
  47. description: 排序方向
  48. schema:
  49. type: string
  50. enum:
  51. - desc
  52. - asc
  53. responses:
  54. 200:
  55. description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
  56. content:
  57. application/json:
  58. schema:
  59. type: object
  60. properties:
  61. ok:
  62. type: boolean
  63. message:
  64. type: string
  65. data:
  66. type: object
  67. properties:
  68. rows:
  69. type: array
  70. items:
  71. type: object
  72. properties: { id: { type: integer }, user_id: { type: integer }, group_id: { type: integer }, group: { type: string }, power: { type: string }, role: { type: string }, level: { type: integer }, status: { type: integer }, user: { type: string }, created_at: { type: string }, updated_at: { type: string } }
  73. count:
  74. type: integer
  75. 401:
  76. $ref: '../../main.yaml#/components/responses/Unauthorized'
  77. 422:
  78. $ref: '../../main.yaml#/components/responses/ValidationError'
  79. post:
  80. summary: '新建 group-member'
  81. tags:
  82. - group-member
  83. operationId: post_api_v2_group_member
  84. description: 实现:`GroupMemberController@store`
  85. requestBody:
  86. required: true
  87. content:
  88. application/json:
  89. schema:
  90. type: object
  91. properties:
  92. user_id:
  93. type: string
  94. description: 规则:required
  95. group_id:
  96. type: string
  97. description: 规则:required
  98. required:
  99. - user_id
  100. - group_id
  101. responses:
  102. 200:
  103. description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
  104. content:
  105. application/json:
  106. schema:
  107. type: object
  108. properties:
  109. ok:
  110. type: boolean
  111. message:
  112. type: string
  113. data:
  114. type: object
  115. properties:
  116. id:
  117. type: integer
  118. user_id:
  119. type: integer
  120. group_id:
  121. type: integer
  122. group:
  123. type: string
  124. power:
  125. type: string
  126. role:
  127. type: string
  128. level:
  129. type: integer
  130. status:
  131. type: integer
  132. user:
  133. type: string
  134. created_at:
  135. type: string
  136. updated_at:
  137. type: string
  138. 401:
  139. $ref: '../../main.yaml#/components/responses/Unauthorized'
  140. 422:
  141. $ref: '../../main.yaml#/components/responses/ValidationError'