api-shield_api-response-common-failure

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
errors	object
messages	object
result	object
success	boolean	Whether the API call was successful

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api-shield_api-response-common-failure",
  "title": "api-shield_api-response-common-failure",
  "properties": {
    "errors": {
      "allOf": [
        {
          "$ref": "#/components/schemas/api-shield_messages"
        }
      ],
      "example": [
        {
          "code": 7003,
          "message": "No route for the URI"
        }
      ],
      "minLength": 1
    },
    "messages": {
      "allOf": [
        {
          "$ref": "#/components/schemas/api-shield_messages"
        }
      ],
      "example": []
    },
    "result": {
      "enum": [
        null
      ],
      "nullable": true,
      "type": "object"
    },
    "success": {
      "description": "Whether the API call was successful",
      "enum": [
        false
      ],
      "example": false,
      "type": "boolean"
    }
  },
  "required": [
    "success",
    "errors",
    "messages",
    "result"
  ],
  "type": "object"
}