SpecDefinition referenceView source

Catalog Records

Embedded records of one kind, keyed by id. The key is the record's id; an embedded record carries no '$schema', 'id', origin or digest. Catalog display metadata ('x-*' members) is stripped when a record is embedded.

Metadata

Definition: #/$defs/CatalogRecords
Form: Dictionary
Source: spec/schemas/opf.schema.json

Field index

This definition uses the forms or value constraints below.

Complete definition constraints

Exact schema constraints

{
  "type": "object",
  "description": "Embedded records of one kind, keyed by id. The key is the record's id; an embedded record carries no '$schema', 'id', origin or digest. Catalog display metadata ('x-*' members) is stripped when a record is embedded.",
  "propertyNames": {
    "pattern": "^[a-z][a-z0-9-]*$"
  },
  "additionalProperties": {
    "type": "object",
    "not": {
      "anyOf": [
        {
          "required": [
            "$schema"
          ]
        },
        {
          "required": [
            "id"
          ]
        }
      ]
    },
    "description": "One embedded record: the fields of the kind's companion schema without '$schema' and 'id'."
  }
}