Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

BlisacheErrorResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "BlisacheErrorResponse",
  "type": "object",
  "properties": {
    "action": {
      "$ref": "#/$defs/BlisacheAction"
    },
    "caused_by": {
      "$ref": "#/$defs/ErrorDescription"
    },
    "result": {
      "$ref": "#/$defs/BlisacheActionResult"
    },
    "timestamp": {
      "type": "integer",
      "format": "uint64",
      "minimum": 0
    }
  },
  "required": [
    "timestamp",
    "action",
    "result",
    "caused_by"
  ],
  "$defs": {
    "BlisacheAction": {
      "type": "string",
      "enum": [
        "RegisterInit",
        "RegisterComplete",
        "AuthenticateInit",
        "AuthenticateComplete",
        "ListCredentials",
        "AddCredential",
        "RevokeCredentialInit",
        "RevokeCredentialComplete",
        "GetPublicKey",
        "VerifySignature"
      ]
    },
    "BlisacheActionResult": {
      "type": "string",
      "enum": [
        "Success",
        "Error"
      ]
    },
    "ErrorCategory": {
      "type": "string",
      "enum": [
        "Input",
        "Functional",
        "RateLimit",
        "Technical"
      ]
    },
    "ErrorDescription": {
      "type": "object",
      "properties": {
        "category": {
          "$ref": "#/$defs/ErrorCategory"
        },
        "detail": {
          "type": "string"
        }
      },
      "required": [
        "category",
        "detail"
      ]
    }
  }
}