ErrorEnvelope

Schema: ErrorEnvelope

OpenAPI Specification

openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths: {}
components:
  schemas:
    ErrorEnvelope:
      type: object
      description: Business failure envelope (HTTP often still 200)
      required:
        - code
        - respMsg
      properties:
        code:
          type: string
          description: Failure business code
          examples:
            - auth004
        respMsg:
          type: string
          description: Failure reason text
          examples:
            - Incorrect username or password
        data:
          description: Usually null on failure
          type: 'null'
      x-apifox-orders:
        - code
        - respMsg
        - data
      x-apifox-folder: ''
  securitySchemes: {}
servers: []
security: []