LianLian Global Users API

openapi: 3.2.0
info:
  title: 账户余额查询 Users API
  version: '1.0'
servers:
- url: http://localhost:3000
tags:
- name: Users
paths:
  /users/{userId}:
    parameters:
    - name: userId
      in: path
      required: true
      description: Id of an existing user.
      schema:
        type: integer
    get:
      summary: 账户余额查询
      tags:
      - Users
      responses:
        '200':
          description: User Found
          headers:
            onwayBalance:
              schema:
                type: string
            totalBalance:
              schema:
                type: string
            availableBalance:
              schema:
                type: string
            accountNo:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                  data:
                    type: object
                    properties:
                      count:
                        type: integer
                      list:
                        type: array
                        items:
                          type: object
                          properties:
                            onwayBalance:
                              type: string
                            totalBalance:
                              type: string
                            availableBalance:
                              type: string
                            accountNo:
                              type: string
                            currency:
                              type: string
                  success:
                    type: boolean
                  message:
                    type: string
                x-examples:
                  Example 1:
                    code: '000000'
                    data:
                      count: 2
                      list:
                      - onwayBalance: '0.00'
                        totalBalance: '4.00'
                        availableBalance: '4.00'
                        accountNo: 0202004762458
                        currency: USD
                      - onwayBalance: '0.00'
                        totalBalance: '12344981.04'
                        availableBalance: '12344981.04'
                        accountNo: '0202004762425'
                        currency: CNY
                    success: true
                    message: success
        '404':
          description: User Not Found
          content:
            application/json:
              schema:
                type: 'null'
      operationId: get-users-userId
      description: 通过该接口获取用户在连连的账户余额，查询无须传参，连连会全量账户返回
    patch:
      summary: Update User Information
      operationId: patch-users-userId
      responses:
        '200':
          description: User Updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '404':
          description: User Not Found
          content:
            application/json:
              schema:
                type: 'null'
        '409':
          description: Email Already Taken
          content:
            application/json:
              schema:
                type: 'null'
      description: Update the information of an existing user.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                firstName:
                  type: string
                lastName:
                  type: string
                email:
                  type: string
                  description: If a new email is given, the user's email verified property will be set to false.
                dateOfBirth:
                  type: string
        description: Patch user properties to update.
      tags:
      - Users
    post:
      summary: ''
      operationId: post-users-userId
      responses:
        '200':
          description: OK
      tags:
      - Users
components:
  schemas:
    User:
      title: User
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier for the given user.
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
          format: email
        dateOfBirth:
          type: string
          format: date
          example: '1997-10-31'
        emailVerified:
          type: boolean
          description: Set to true if the user's email has been verified.
        createDate:
          type: string
          format: date
          description: The date that the user was created.
      required:
      - id
      - firstName
      - lastName
      - email
      - emailVerified
x-stoplight:
  id: d04slm5ra253f