notify-service/openapi.yaml

# Generated with protoc-gen-openapi
# https://github.com/google/gnostic/tree/master/cmd/protoc-gen-openapi

openapi: 3.0.3
info:
    title: ""
    version: 0.0.1
paths:
    /ping:
        get:
            tags:
                - Greeter
            description: Sends a greeting
            operationId: Greeter_Ping
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/api.PingReply'
    /ping2:
        get:
            tags:
                - Greeter
            operationId: Greeter_Ping2
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/api.PingReply'
    email/send:
        post:
            tags:
                - Email
            description: 发送一个邮件
            operationId: Email_SendEmail
            requestBody:
                content:
                    application/json:
                        schema:
                            $ref: '#/components/schemas/api.SendRequest'
                required: true
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/api.SendEmailReply'
    sms/code-verify:
        post:
            tags:
                - Sms
            description: 校验短信code
            operationId: Sms_VerifyCode
            requestBody:
                content:
                    application/json:
                        schema:
                            $ref: '#/components/schemas/api.SmsCodeVerifyRequest'
                required: true
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/api.SendSmsReply'
    sms/send:
        post:
            tags:
                - Sms
            description: 发送一条短信
            operationId: Sms_SendMessage
            requestBody:
                content:
                    application/json:
                        schema:
                            $ref: '#/components/schemas/api.SendSmsRequest'
                required: true
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/api.SendSmsReply'
components:
    schemas:
        api.PingReply:
            type: object
            properties:
                message:
                    type: string
            description: The response message containing the greetings
        api.SendEmailReply:
            type: object
            properties:
                code:
                    type: integer
                    format: int32
                message:
                    type: string
            description: The response message containing the greetings
        api.SendRequest:
            type: object
            properties:
                to:
                    type: array
                    items:
                        type: string
                    description: 收件人 必填参数
                subject:
                    type: string
                    description: 邮件主题，必填参数
                body:
                    type: string
                    description: 消息体，支持富文本
                files:
                    type: array
                    items:
                        type: string
                    description: 附件地址
        api.SendSmsReply:
            type: object
            properties:
                code:
                    type: integer
                    format: int32
                message:
                    type: string
            description: 短信发送回复
        api.SendSmsRequest:
            type: object
            properties:
                phone:
                    type: string
                    description: 手机号码，必填
                smsType:
                    type: integer
                    description: 短信场景值 1,2,3,4
                    format: int32
                areaCode:
                    type: string
                    description: 国际区号 86 中国 1美国
        api.SmsCodeVerifyRequest:
            type: object
            properties:
                phone:
                    type: string
                    description: 手机号码，必填
                code:
                    type: string
                    description: 短信验证码
tags:
    - name: Email
      description: The Email service definition.
    - name: Greeter
      description: The greeting service definition.
    - name: Sms
      description: The Email service definition.