OpenKF/server/docs/swagger.yaml

# Copyright © 2023 OpenIMSDK open source community. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

definitions:
  param.SendToParams:
    properties:
      email:
        type: string
    required:
    - email
    type: object
  response.Response:
    properties:
      code:
        type: integer
      data: {}
      msg:
        type: string
    type: object
info:
  contact: {}
paths:
  /api/v1/email/code:
    post:
      description: Use email to send verification code
      parameters:
      - description: Email address
        in: body
        name: data
        required: true
        schema:
          $ref: '#/definitions/param.SendToParams'
      produces:
      - application/json
      responses:
        "200":
          description: Send success
          schema:
            allOf:
            - $ref: '#/definitions/response.Response'
            - properties:
                msg:
                  type: string
              type: object
      summary: SendCode
      tags:
      - mail
swagger: "2.0"