Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
themeDJango
borderStyledashed
titleAuthority Source File Example (hridSettings)
collapsetrue
{
  "id": "cb58492d-018e-442d-9ce3-35aabfc524aa",
  "name": "Test",
  "type": "Subjects",
  "codes": [
    "loc"
  ],
  "hridSetting": {
    "prefix": "loc",
    "startNumber": "000000001"
  },
  "source": "local"
},

{
    "id": "cb58492d-018e-442d-9ce3-35aabfc524aa",
    "name": "Test",
    "type": "Subjects",
    "codes": [
        "loc"
    ],
    "startNumber": "000000001"
    "source": "local"
},


Code Block
themeDJango
borderStyledashed
titleAuthority Source File Schema (hridSetting)
collapsetrue
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "An Authority source file",
  "type": "object",
  "properties": {
    "id": {
      "description": "unique ID of the Authority source file; a UUID",
      "$ref": "uuid.json"
    },
    "name": {
      "type": "string",
      "description": "Authority source file name"
    },
    "codes": {
      "type" : "array",
      "description": "List of identifying prefix",
      "items": {
        "type": "string",
        "description": "identifying prefix, i.e. 'n', 'D', 'fst'"
      }
    },
    "type": {
      "type": "string",
      "description": "Type of authority records stored in source file"
    },
    "baseUrl": {
      "type": "string",
      "description": "Base URL of the source file origin"
    },
    "hridSetting": {
      "description": "The HRID settings for source file",
      "type": "object",
      "$ref": "hridsetting.json"
    },
    "source": {
      "type": "string",
      "description": "label indicating where the authority source file entry originates from, i.e. 'folio' or 'local'",
      "enum": [
        "folio",
        "local"
      ]
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "codes",
    "type",
    "source"
  ]
} 

...