Setting

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/folio/main/json-schema/folio-setting-schema.json",
  "title": "Setting",
  "description": "Setting",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/folio-mod-dcb-dcb-transaction-openapi.yml#/components/schemas/Setting",
  "type": "object",
  "properties": {
    "id": {
      "description": "Setting Identifier",
      "type": "string",
      "format": "uuid"
    },
    "scope": {
      "$ref": "#/$defs/SettingScope"
    },
    "key": {
      "type": "string",
      "description": "Key within scope for this setting"
    },
    "value": {
      "type": "object",
      "description": "Settings value (any type)"
    },
    "_version": {
      "type": "integer",
      "description": "Record version for optimistic locking"
    },
    "metadata": {
      "$ref": "#/$defs/metadata"
    }
  },
  "additionalProperties": false,
  "required": [
    "id",
    "scope",
    "key",
    "value"
  ],
  "$defs": {
    "SettingScope": {
      "type": "string",
      "description": "Scope for this entry (normally a module)",
      "enum": [
        "mod-dcb"
      ]
    },
    "metadata": {
      "title": "Metadata Schema",
      "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
      "type": "object",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    }
  }
}