v2-invite-invite.yaml 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127
  1. # 由 openapi/scripts/generate.php 生成,请勿手改;补充写到 overrides/v2-invite-invite.yaml
  2. get:
  3. summary: '获取单个 invite/{invite}'
  4. tags:
  5. - invite
  6. operationId: get_api_v2_invite_invite_
  7. description: |
  8. 已被 `GET /v3/invites/{invite}` 取代,保留仅为 dashboard-v4 兼容,待 v4 下线后删除。
  9. parameters:
  10. -
  11. name: invite
  12. in: path
  13. required: true
  14. schema:
  15. type: string
  16. responses:
  17. 200:
  18. description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
  19. content:
  20. application/json:
  21. schema:
  22. type: object
  23. properties:
  24. ok:
  25. type: boolean
  26. message:
  27. type: string
  28. data:
  29. type: object
  30. 401:
  31. $ref: '../../main.yaml#/components/responses/Unauthorized'
  32. 422:
  33. $ref: '../../main.yaml#/components/responses/ValidationError'
  34. deprecated: true
  35. put:
  36. summary: '更新 invite/{invite}'
  37. tags:
  38. - invite
  39. operationId: put_api_v2_invite_invite_
  40. description: 实现:`InviteController@update`
  41. parameters:
  42. -
  43. name: invite
  44. in: path
  45. required: true
  46. schema:
  47. type: string
  48. responses:
  49. 200:
  50. description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
  51. content:
  52. application/json:
  53. schema:
  54. type: object
  55. properties:
  56. ok:
  57. type: boolean
  58. message:
  59. type: string
  60. data:
  61. type: object
  62. 401:
  63. $ref: '../../main.yaml#/components/responses/Unauthorized'
  64. 422:
  65. $ref: '../../main.yaml#/components/responses/ValidationError'
  66. patch:
  67. summary: '更新 invite/{invite}'
  68. tags:
  69. - invite
  70. operationId: patch_api_v2_invite_invite_
  71. description: 实现:`InviteController@update`
  72. parameters:
  73. -
  74. name: invite
  75. in: path
  76. required: true
  77. schema:
  78. type: string
  79. responses:
  80. 200:
  81. description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
  82. content:
  83. application/json:
  84. schema:
  85. type: object
  86. properties:
  87. ok:
  88. type: boolean
  89. message:
  90. type: string
  91. data:
  92. type: object
  93. 401:
  94. $ref: '../../main.yaml#/components/responses/Unauthorized'
  95. 422:
  96. $ref: '../../main.yaml#/components/responses/ValidationError'
  97. delete:
  98. summary: '删除 invite/{invite}'
  99. tags:
  100. - invite
  101. operationId: delete_api_v2_invite_invite_
  102. description: 实现:`InviteController@destroy`
  103. parameters:
  104. -
  105. name: invite
  106. in: path
  107. required: true
  108. schema:
  109. type: string
  110. responses:
  111. 200:
  112. description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
  113. content:
  114. application/json:
  115. schema:
  116. type: object
  117. properties:
  118. ok:
  119. type: boolean
  120. message:
  121. type: string
  122. data:
  123. type: object
  124. 401:
  125. $ref: '../../main.yaml#/components/responses/Unauthorized'
  126. 422:
  127. $ref: '../../main.yaml#/components/responses/ValidationError'