v3-invites-invite.yaml 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. # 由 openapi/scripts/generate.php 生成,请勿手改;补充写到 overrides/v3-invites-invite.yaml
  2. get:
  3. summary: 查看一条可用的注册邀请
  4. tags:
  5. - invites
  6. operationId: get_api_v3_invites_invite_
  7. description: |-
  8. 邀请注册页用它显示邮箱。不存在或已被使用都返回 404。
  9. 实现:`V3\InviteController@show`
  10. security:
  11. - { }
  12. -
  13. bearerAuth: []
  14. parameters:
  15. -
  16. name: invite
  17. in: path
  18. required: true
  19. schema:
  20. type: string
  21. description: '邀请邮件链接里的 uuid'
  22. responses:
  23. 200:
  24. description: 成功
  25. content:
  26. application/json:
  27. schema:
  28. type: object
  29. properties:
  30. data:
  31. type: object
  32. properties:
  33. id:
  34. type: string
  35. email:
  36. type: string
  37. status:
  38. type: string
  39. created_at:
  40. type: string
  41. nullable: true
  42. 404:
  43. description: 邀请不存在或已被使用
  44. content:
  45. application/problem+json:
  46. schema:
  47. $ref: '../../main.yaml#/components/schemas/ProblemDetails'
  48. 422:
  49. $ref: '../../main.yaml#/components/responses/ProblemValidation'