page-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/page-shield_api-response-common-failure",
  "title": "page-shield_api-response-common-failure",
  "properties": {
    "errors": {
      "$ref": "#/components/schemas/page-shield_messages"
    },
    "messages": {
      "$ref": "#/components/schemas/page-shield_messages"
    },
    "result": {
      "enum": [
        null
      ],
      "nullable": true,
      "type": "object"
    },
    "success": {
      "description": "Whether the API call was successful",
      "enum": [
        false
      ],
      "example": false,
      "type": "boolean"
    }
  },
  "required": [
    "success",
    "errors"
  ],
  "type": "object"
}