Error

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "An error.",
  "properties": {
    "detail": {
      "description": "A longer description of of the error encountered.",
      "example": "There was a problem with your request. Please see `info` for more information.",
      "type": "string"
    },
    "info": {
      "description": "Additional information that may be provided to aid in error\nresolution.",
      "properties": {
        "reason": {
          "description": "An optional reason for the error response.\n\nIn some cases, more information is required to convey information\nabout the error to the client. In these cases, one of the following\nreason slugs may be used.\n\n| Reason Slug | Description |\n| ----------- | ----------- |\n| `contract-not-ready-to-countersign` | The contract is in a state that does not allow countersigning. Its status must be `ready-to-countersign` to perform this action. |\n| `event-photo-count-limit` | The event has reached the maximum number of photos allowed. |\n| `plan-does-not-allow-uploads` | The studio is in a plan that does not allow uploads or they have reached the limit of photos the plan allows. |",
          "enum": [
            "contract-not-ready-to-countersign",
            "event-photo-count-limit",
            "plan-does-not-allow-uploads"
          ],
          "type": "string"
        }
      },
      "type": "object"
    },
    "status": {
      "description": "The HTTP status code associated with this error.",
      "example": 400,
      "type": "integer"
    },
    "title": {
      "description": "A short description of the error encountered.",
      "example": "Bad Request",
      "type": "string"
    },
    "type": {
      "description": "A namespace URI uniquely identifying the error type.",
      "example": "https://developer.shootproof.com/errors#error-bad-request",
      "format": "uri",
      "type": "string"
    }
  },
  "type": "object"
}