types/openapi.yaml

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

openapi: 3.0.3
info:
    title: Card API
    version: 0.0.1
paths:
    /v1/account/create:
        post:
            tags:
                - Card
            operationId: Card_CreateAccountUser
            requestBody:
                content:
                    application/json:
                        schema:
                            $ref: '#/components/schemas/card.CreateAccountUserRequest'
                required: true
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/card.CreateAccountUserReply'
    /v1/account/login:
        post:
            tags:
                - Card
            operationId: Card_LoginAccount
            requestBody:
                content:
                    application/json:
                        schema:
                            $ref: '#/components/schemas/card.LoginAccountRequest'
                required: true
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/card.LoginAccountReply'
    /v1/account/wx/login:
        post:
            tags:
                - Card
            operationId: Card_WxRegisterLogin
            requestBody:
                content:
                    application/json:
                        schema:
                            $ref: '#/components/schemas/card.WxRegisterLoginRequest'
                required: true
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/card.WxRegisterLoginReply'
    /v1/card/create:
        post:
            tags:
                - Card
            operationId: Card_CreateCard
            requestBody:
                content:
                    application/json:
                        schema:
                            $ref: '#/components/schemas/card.CreateCardRequest'
                required: true
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/card.CreateCardReply'
    /v1/card/del:
        post:
            tags:
                - Card
            operationId: Card_DelCard
            requestBody:
                content:
                    application/json:
                        schema:
                            $ref: '#/components/schemas/card.DelCardInfoRequest'
                required: true
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/card.DelCardReply'
    /v1/card/info:
        post:
            tags:
                - Card
            operationId: Card_GetCardInfo
            requestBody:
                content:
                    application/json:
                        schema:
                            $ref: '#/components/schemas/card.GetCardInfoRequest'
                required: true
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/card.GetCardInfoReply'
    /v1/card/ocr:
        post:
            tags:
                - Card
            operationId: Card_OCRCard
            requestBody:
                content:
                    application/json:
                        schema:
                            $ref: '#/components/schemas/card.OCRCardRequest'
                required: true
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/card.OCRCardReply'
    /v1/card/ossupload:
        post:
            tags:
                - Card
            operationId: Card_OssUpload
            requestBody:
                content:
                    application/json:
                        schema:
                            $ref: '#/components/schemas/card.OssUploadRequest'
                required: true
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/card.OssUploadReplay'
    /v1/card/save:
        post:
            tags:
                - Card
            operationId: Card_SaveCard
            requestBody:
                content:
                    application/json:
                        schema:
                            $ref: '#/components/schemas/card.SaveCardInfoRequest'
                required: true
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/card.SaveCardReply'
    /v1/card/search:
        post:
            tags:
                - Card
            operationId: Card_SearchCard
            requestBody:
                content:
                    application/json:
                        schema:
                            $ref: '#/components/schemas/card.SearchCardRequest'
                required: true
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/card.SearchCardReply'
    /v1/card/templates:
        post:
            tags:
                - Card
            operationId: Card_GetTemplates
            requestBody:
                content:
                    application/json:
                        schema:
                            $ref: '#/components/schemas/card.GetTemplatesRequest'
                required: true
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/card.GetTemplatesReply'
    /v1/card/token/create:
        post:
            tags:
                - Card
            operationId: Card_CreateShareToken
            requestBody:
                content:
                    application/json:
                        schema:
                            $ref: '#/components/schemas/card.CreateShareTokenRequest'
                required: true
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/card.CreateShareTokenReply'
    /v1/card/user/bind:
        post:
            tags:
                - Card
            operationId: Card_AddCardByShareToken
            requestBody:
                content:
                    application/json:
                        schema:
                            $ref: '#/components/schemas/card.AddCardByShareTokenRequest'
                required: true
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/card.AddCardByShareTokenReply'
    /v1/cards:
        post:
            tags:
                - Card
            operationId: Card_GetMyCards
            requestBody:
                content:
                    application/json:
                        schema:
                            $ref: '#/components/schemas/card.GetMyCardsRequest'
                required: true
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/card.GetMyCardsReply'
components:
    schemas:
        card.AddCardByShareTokenReply:
            type: object
            properties:
                ok:
                    type: boolean
        card.AddCardByShareTokenRequest:
            type: object
            properties:
                token:
                    type: string
        card.CreateAccountUserReply:
            type: object
            properties:
                ok:
                    type: boolean
        card.CreateAccountUserRequest:
            type: object
            properties:
                account:
                    $ref: '#/components/schemas/common.AccountBaseBody'
        card.CreateCardReply:
            type: object
            properties:
                id:
                    type: integer
                    format: uint32
        card.CreateCardRequest:
            type: object
            properties:
                card:
                    $ref: '#/components/schemas/common.CardBaseBody'
                supplements:
                    type: array
                    items:
                        $ref: '#/components/schemas/common.CardSupplementBaseBody'
        card.CreateShareTokenReply:
            type: object
            properties:
                token:
                    type: string
                expire:
                    type: string
        card.CreateShareTokenRequest:
            type: object
            properties:
                cardId:
                    type: integer
                    format: uint32
        card.DelCardInfoRequest:
            type: object
            properties:
                cardId:
                    type: integer
                    format: uint32
        card.DelCardReply:
            type: object
            properties:
                ok:
                    type: boolean
        card.GetCardInfoReply:
            type: object
            properties:
                card:
                    $ref: '#/components/schemas/common.CardBaseBody'
                supplements:
                    type: array
                    items:
                        $ref: '#/components/schemas/common.CardSupplementBaseBody'
                template:
                    $ref: '#/components/schemas/common.CardTemplateBaseBody'
        card.GetCardInfoRequest:
            type: object
            properties:
                cardId:
                    type: integer
                    format: uint32
        card.GetMyCardsReply:
            type: object
            properties:
                cards:
                    type: array
                    items:
                        $ref: '#/components/schemas/common.CardBody'
                supplements:
                    type: array
                    items:
                        $ref: '#/components/schemas/common.CardSupplementBaseBody'
                templates:
                    type: array
                    items:
                        $ref: '#/components/schemas/common.CardTemplateBody'
        card.GetMyCardsRequest:
            type: object
            properties: {}
        card.GetTemplatesReply:
            type: object
            properties:
                templates:
                    type: array
                    items:
                        $ref: '#/components/schemas/common.CardTemplateBody'
        card.GetTemplatesRequest:
            type: object
            properties: {}
        card.LoginAccountReply:
            type: object
            properties:
                token:
                    type: string
        card.LoginAccountRequest:
            type: object
            properties:
                account:
                    $ref: '#/components/schemas/common.AccountBaseBody'
        card.OCRCardReply:
            type: object
            properties:
                body:
                    $ref: '#/components/schemas/common.CardBaseBody'
                supplements:
                    type: array
                    items:
                        $ref: '#/components/schemas/common.CardSupplementBaseBody'
        card.OCRCardRequest:
            type: object
            properties:
                url:
                    type: string
        card.OssUploadReplay:
            type: object
            properties:
                body:
                    $ref: '#/components/schemas/common.Oss'
        card.OssUploadRequest:
            type: object
            properties: {}
        card.SaveCardInfoRequest:
            type: object
            properties:
                cardId:
                    type: integer
                    format: uint32
                card:
                    $ref: '#/components/schemas/common.CardBaseBody'
                supplements:
                    type: array
                    items:
                        $ref: '#/components/schemas/common.CardSupplementBaseBody'
        card.SaveCardReply:
            type: object
            properties:
                ok:
                    type: boolean
        card.SearchCardReply:
            type: object
            properties:
                cards:
                    type: array
                    items:
                        $ref: '#/components/schemas/common.CardBody'
                supplements:
                    type: array
                    items:
                        $ref: '#/components/schemas/common.CardSupplementBaseBody'
                total:
                    type: integer
                    format: uint32
        card.SearchCardRequest:
            type: object
            properties:
                filter:
                    $ref: '#/components/schemas/common.CardFilterBody'
                page:
                    $ref: '#/components/schemas/pagination.PaginationBody'
        card.WxRegisterLoginReply:
            type: object
            properties:
                token:
                    type: string
        card.WxRegisterLoginRequest:
            type: object
            properties:
                code:
                    type: string
        common.AccountBaseBody:
            type: object
            properties:
                userId:
                    type: integer
                    format: uint32
                type:
                    type: integer
                    format: enum
                account:
                    type: string
                password:
                    type: string
                status:
                    type: integer
                    format: enum
        common.CardBaseBody:
            type: object
            properties:
                name:
                    type: string
                title:
                    type: string
                companyName:
                    type: string
                companyShortName:
                    type: string
                templateId:
                    type: integer
                    format: uint32
                userId:
                    type: integer
                    format: uint32
                status:
                    type: integer
                    format: enum
                searchKey:
                    type: string
                type:
                    type: integer
                    format: enum
                created:
                    type: integer
                    format: uint64
        common.CardBody:
            type: object
            properties:
                id:
                    type: integer
                    format: uint32
                body:
                    $ref: '#/components/schemas/common.CardBaseBody'
        common.CardFilterBody:
            type: object
            properties:
                name:
                    type: string
                title:
                    type: string
                companyName:
                    type: string
                companyShortName:
                    type: string
                searchKey:
                    type: string
                userId:
                    type: integer
                    format: uint32
                type:
                    type: integer
                    format: enum
                status:
                    type: integer
                    format: enum
        common.CardSupplementBaseBody:
            type: object
            properties:
                cardId:
                    type: integer
                    format: uint32
                keyName:
                    type: string
                keyValue:
                    type: string
        common.CardTemplateBaseBody:
            type: object
            properties:
                name:
                    type: string
                titleColor:
                    type: string
                subtitleColor:
                    type: string
                contactColor:
                    type: string
                backgroundImg:
                    type: string
        common.CardTemplateBody:
            type: object
            properties:
                id:
                    type: integer
                    format: uint32
                body:
                    $ref: '#/components/schemas/common.CardTemplateBaseBody'
        common.Oss:
            type: object
            properties:
                AccessKeyId:
                    type: string
                AccessKeySecret:
                    type: string
                SecurityToken:
                    type: string
                Region:
                    type: string
                Bucket:
                    type: string
        pagination.PaginationBody:
            type: object
            properties:
                now:
                    type: integer
                    format: uint32
                size:
                    type: integer
                    format: uint32
tags:
    - name: Card