SDR API — component schemas

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/stanford/main/json-schema/stanford-sdr-api-schemas.json",
  "title": "SDR API \u2014 component schemas",
  "description": "JSON Schema extracted from the components.schemas block of Stanford University Libraries' first-party OpenAPI for the SDR API. Institution-operated: every server in the source contract is under stanford.edu.",
  "x-operator": "institution",
  "x-generated": "2026-08-19",
  "x-method": "derived",
  "x-source": "https://raw.githubusercontent.com/sul-dlss/sdr-api/main/openapi.yml",
  "$defs": {
    "BackgroundJobResultResponse": {
      "type": "object",
      "properties": {
        "output": {
          "type": "object",
          "description": "output from the job",
          "properties": {
            "druid": {
              "$ref": "https://raw.githubusercontent.com/sul-dlss/cocina-models/refs/tags/v0.113.0/schema.json#/$defs/Druid"
            },
            "errors": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/Error"
              }
            }
          }
        },
        "status": {
          "type": "string",
          "description": "the status of the background job",
          "enum": [
            "pending",
            "processing",
            "complete"
          ]
        },
        "try_count": {
          "type": "integer",
          "description": "the number of tries"
        }
      }
    },
    "CreateObjectResponse": {
      "type": "object",
      "properties": {
        "jobId": {
          "type": "string",
          "description": "id for the background job that is processing the create object request"
        }
      },
      "required": [
        "jobId"
      ]
    },
    "ErrorResponse": {
      "type": "object",
      "properties": {
        "errors": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "Error": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "description": "a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem.",
          "example": "Invalid Attribute"
        },
        "detail": {
          "type": "string",
          "description": "a human-readable explanation specific to this occurrence of the problem.",
          "example": "Title must contain at least three characters."
        },
        "source": {
          "type": "object",
          "properties": {
            "pointer": {
              "type": "string",
              "example": "/data/attributes/title"
            }
          }
        }
      }
    }
  }
}