v2-email-certification-email-certification.yaml 3.8 KB

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