cocina-models 0.75.0 → 0.78.0

data/docs/maps/Collection.json

@@ -1,240 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-06/schema#",
-  "id": "http://cocina.sul.stanford.edu/schemas/Collection",
-  "title": "Digital Repository Collection",
-  "description": "A group of Digital Repository Objects that indicate some type of conceptual grouping within the domain that is worth reusing across the system.",
-  "type": "object",
-  "required": ["@context", "@type", "externalIdentifier", "label", "internalIdentifier", "version", "administrative", "access", "description", "identification", "structural"],
-  "properties": {
-    "@context": {
-      "description": "URI for the JSON-LD context definitions.",
-      "type": "string"
-    },
-    "@type": {
-      "description": "The content type of the Collection. Selected from an established set of values.",
-      "type": "string",
-      "enum": [
-        "http://cocina.sul.stanford.edu/models/collection.jsonld",
-        "http://cocina.sul.stanford.edu/models/curated-collection.jsonld",
-        "http://cocina.sul.stanford.edu/models/user-collection.jsonld",
-        "http://cocina.sul.stanford.edu/models/exhibit.jsonld",
-        "http://cocina.sul.stanford.edu/models/series.jsonld"
-      ]
-    },
-    "citation": {
-      "description": "Citation for the resource, including identifier, label, version, and a persistent URL to the object with SDR at the very least.",
-      "type": "string"
-    },
-    "dedupeIdentifier": {
-      "description": "Identifier retrieved from identification.sourceId that stands for analog or source identifier that this resource is a digital representation of.",
-      "type": "string"
-    },
-    "depositor": {
-      "description": "The Agent (User, Group, Application, Department, other) that deposited the Collection into SDR.",
-      "$ref": "/Agent"
-    },
-    "description": {
-      "description": "Descriptive metadata for the DRO.",
-      "$ref": "/Description"
-    },
-    "externalIdentifier": {
-      "description": "Identifier for the resource within the SDR architecture but outside of the repository. DRUID or UUID depending on resource type. Constant across resource versions. What clients will use calling the repository. Same as `identification.identifier`",
-      "type": "string"
-    },
-    "label": {
-      "description": "Primary processing label (can be same as title) for a Collection.",
-      "type": "string"
-    },
-    "internalIdentifier": {
-      "description": "Identifier for the resource within the repository. UUID, unique for each new version of a repository resource.",
-      "type": "string"
-    },
-    "version": {
-      "description": "Version for the Collection within SDR.",
-      "type": "integer"
-    },
-    "precedingVersion": {
-      "description": "Preceding version for the Collection within SDR.",
-      "type": "string"
-    },
-    "followingVersion": {
-      "description": "Following version for the Collection within SDR.",
-      "type": "string"
-    },
-    "access": {
-      "description": "Access Metadata for the Collection.",
-      "type": "object",
-      "required": ["access", "download"],
-      "properties": {
-        "access": {
-          "description": "Access level for the Collection.",
-          "type": "string",
-          "enum": ["world", "stanford", "location-based", "citation-only", "dark"]
-        },
-        "copyright": {
-          "description": "The human readable copyright statement that applies to the Collection.",
-          "type": "string"
-        },
-        "download": {
-          "description": "Download level for the Collection metadata.",
-          "type": "string",
-          "enum": ["world", "stanford", "location-based", "citation-only", "dark"]
-        },
-        "embargoReleaseDate": {
-          "description": "Date when the Collection is released from an embargo, if an embargo exists.",
-          "type": "string",
-          "format": "date-time"
-        },
-        "license": {
-          "description": "The license governing reuse of the Collection. Should be an IRI for known licenses (i.e. CC, RightsStatement.org URI, etc.).",
-          "type": "string"
-        },
-        "useAndReproductionStatement": {
-          "description": "The human readable reuse and reproduction statement that applies to the Collection.",
-          "type": "string"
-        },
-        "termsOfUse": {
-          "description": "License or terms of use governing reuse of the Collection. Should be a text statement.",
-          "type": "string"
-        }
-      }
-    },
-    "administrative": {
-      "type": "object",
-      "description": "Administrative metadata for the SDR resource.",
-      "required": ["created", "isDescribedBy", "sdrPreserve"],
-      "properties": {
-        "created": {
-          "description": "When the resource in SDR was created.",
-          "type": "string",
-          "format": "date-time"
-        },
-        "deleted": {
-          "description": "If the resource has been deleted (but not purged).",
-          "type": "boolean"
-        },
-        "gravestoneMessage": {
-          "description": "Message describing why the object was deleted.",
-          "type": "string"
-        },
-        "isDescribedBy": {
-          "description": "PURL/XML file that is a traditional representation of the metadata for the Collection.",
-          "type": "string"
-        },
-        "lastUpdated": {
-          "description": "When the resource in SDR was last updated.",
-          "type": "string",
-          "format": "date-time"
-        },
-        "partOfProject": {
-          "description": "Administrative or Internal project this resource is a part of.",
-          "type": "string"
-        },
-        "releaseTags": {
-          "description": "Tags for release",
-          "type": "array",
-          "items": {
-            "$ref": "/ReleaseTag"
-          }
-        },
-        "sdrPreserve": {
-          "description": "If this resource should be sent to Preservation.",
-          "type": "boolean"
-        },
-        "remediatedBy": {
-          "description": "The Agent (User, Group, Application, Department, other) that remediated a Collection in SDR.",
-          "type": "array",
-          "items": {
-            "$ref": "/Agent"
-          }
-        }
-      }
-    },
-    "identification": {
-      "description": "Identifying information for the Collection.",
-      "type": "object",
-      "required": ["identifier"],
-      "properties": {
-        "catalogLinks": {
-          "description": "Links to catalog records for the resource that the Collection represents in whole or part.",
-          "type": "array",
-          "items": {
-            "type": "object",
-            "required": ["catalog", "catalogRecordId"],
-            "properties": {
-              "catalog": {
-                "description": "Catalog that is the source of the linked record.",
-                "type": "string"
-              },
-              "catalogRecordId": {
-                "description": "Record identifier that is unique within the context of the linked record's catalog.",
-                "type": "string"
-              },
-              "recordSchema": {
-                "description": "Metadata schema of the linked record.",
-                "type": "string"
-              },
-              "deriveMetadata": {
-                "description": "If the Collection descriptive metadata should be automatically updated when the linked record changes.",
-                "type": "boolean"
-              },
-              "deliverMetadata": {
-                "description": "If the linked record should be automatically updated when the Collection descriptive metadata changes.",
-                "type": "boolean"
-              },
-              "recordScope": {
-                "description": "Whether the linked record describes a resource that is broader than, equivalent to, or narrower than the resource the Collection represents.",
-                "type": "string",
-                "enum": ["broader", "equivalent", "narrower"]
-              }
-            }
-          }
-        },
-        "DOI": {
-          "description": "Digital Object Identifier (DOI) for the Collection within this repository.",
-          "type": "string"
-        },
-        "identifier": {
-          "description": "Identifier for the Collection within the Stanford Digital Repository system",
-          "type": "string"
-        },
-        "sameAs": {
-          "description": "Another object, either external or internal to the system (if duplication occurs) that is the same digital resource as this Collection.",
-          "type": "string"
-        },
-        "sourceId": {
-          "description": "A source resource or object (perhaps but not necessarily analog or physical) that the Collection is a digital representation of.",
-          "type": "string"
-        },
-        "sdrUUID": {
-          "type": "string",
-          "description": "UUID previously minted for the resource within SDR2 / Fedora 3."
-        }
-      }
-    },
-    "structural": {
-      "description": "Structural metadata for the Collection.",
-      "type": "object",
-      "properties": {
-        "hasMember": {
-          "description": "Component digital repository objects or collections that are a part of this collection.",
-          "type": "array",
-          "items": {
-            "type": "string"
-          }
-        },
-        "isTargetOf": {
-          "description": "An Annotation instance that applies to the Collection.",
-          "type": "string"
-        },
-        "hasMemberOrders": {
-          "description": "Provided sequences or orderings of members of the Collection, including some metadata about each sequence (i.e. sequence label, sequence type, if the sequence is primary, etc.).",
-          "type": "array",
-          "items": {
-              "$ref": "/Sequence"
-          }
-        }
-      }
-    }
-  }
-}

data/docs/maps/DRO.json

@@ -1,316 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-06/schema#",
-  "id": "http://cocina.sul.stanford.edu/schemas/DRO",
-  "title": "Digital Repository Object",
-  "description": "Domain-defined abstraction of a 'work'. Digital Repository Objects' abstraction is describable for our domain’s purposes, i.e. for management needs within our system.",
-  "type": "object",
-  "required": ["@context", "@type", "externalIdentifier", "label", "internalIdentifier", "version", "administrative", "access", "description", "identification", "structural"],
-  "properties": {
-    "@context": {
-      "description": "URI for the JSON-LD context definitions.",
-      "type": "string"
-    },
-    "@type": {
-      "description": "The content type of the DRO. Selected from an established set of values.",
-      "type": "string",
-      "enum": [
-        "http://cocina.sul.stanford.edu/models/object.jsonld",
-        "http://cocina.sul.stanford.edu/models/3d.jsonld",
-        "http://cocina.sul.stanford.edu/models/agreement.jsonld",
-        "http://cocina.sul.stanford.edu/models/book.jsonld",
-        "http://cocina.sul.stanford.edu/models/document.jsonld",
-        "http://cocina.sul.stanford.edu/models/geo.jsonld",
-        "http://cocina.sul.stanford.edu/models/image.jsonld",
-        "http://cocina.sul.stanford.edu/models/page.jsonld",
-        "http://cocina.sul.stanford.edu/models/photograph.jsonld",
-        "http://cocina.sul.stanford.edu/models/manuscript.jsonld",
-        "http://cocina.sul.stanford.edu/models/map.jsonld",
-        "http://cocina.sul.stanford.edu/models/media.jsonld",
-        "http://cocina.sul.stanford.edu/models/track.jsonld",
-        "http://cocina.sul.stanford.edu/models/webarchive-binary.jsonld",
-        "http://cocina.sul.stanford.edu/models/webarchive-seed.jsonld"
-      ]
-    },
-    "citation": {
-      "description": "Citation for the resource, including identifier, label, version, and a persistent URL to the object with SDR at the very least.",
-      "type": "string"
-    },
-    "dedupeIdentifier": {
-      "description": "Identifier retrieved from identification.sourceId that stands for analog or source identifier that this resource is a digital representation of.",
-      "type": "string"
-    },
-    "depositor": {
-      "description": "The Agent (User, Group, Application, Department, other) that deposited the DRO into SDR.",
-      "$ref": "/Agent"
-    },
-    "externalIdentifier": {
-      "description": "Identifier for the resource within the SDR architecture but outside of the repository. DRUID or UUID depending on resource type. Constant across resource versions. What clients will use calling the repository. Same as `identification.identifier`",
-      "type": "string"
-    },
-    "label": {
-      "description": "Primary processing label (can be same as title) for a DRO.",
-      "type": "string"
-    },
-    "internalIdentifier": {
-      "description": "Identifier for the resource within the repository. UUID, unique for each new version of a repository resource.",
-      "type": "string"
-    },
-    "version": {
-      "description": "Version for the DRO within SDR.",
-      "type": "integer"
-    },
-    "precedingVersion": {
-      "description": "Preceding version for the Object within SDR.",
-      "type": "string"
-    },
-    "followingVersion": {
-      "description": "Following version for the Object within SDR.",
-      "type": "string"
-    },
-    "access": {
-      "description": "Access Metadata for the DRO.",
-      "type": "object",
-      "required": ["access", "download"],
-      "properties": {
-        "access": {
-          "description": "Access level for the DRO.",
-          "type": "string",
-          "enum": ["world", "stanford", "location-based", "citation-only", "dark"]
-        },
-        "copyright": {
-          "description": "The human readable copyright statement that applies to the DRO.",
-          "type": "string"
-        },
-        "controlledDigitalLending": {
-          "description": "If the object is available for controlled digital lending.",
-          "type": "boolean"
-        },
-        "download": {
-          "description": "Download level for the DRO metadata.",
-          "type": "string",
-          "enum": ["world", "stanford", "location-based", "none"]
-        },
-        "embargo": {
-          "description": "Embargo metadata",
-          "type": "object",
-          "required": ["releaseDate", "access"],
-          "properties": {
-            "releaseDate": {
-              "description": "Date when the DRO is released from an embargo.",
-              "type": "string",
-              "format": "date-time"
-            },
-            "access": {
-              "description": "Access level for the DRO when released from embargo.",
-              "type": "string",
-              "enum": ["world", "stanford", "location-based", "citation-only", "dark"]
-            },
-            "useAndReproductionStatement": {
-              "description": "The human readable reuse and reproduction statement that applies to the DRO when released from embargo.",
-              "type": "string"
-            }
-          }
-        },
-        "license": {
-          "description": "The license governing reuse of the DRO. Should be an IRI for known licenses (i.e. CC, RightsStatement.org URI, etc.).",
-          "type": "string"
-        },
-        "useAndReproductionStatement": {
-          "description": "The human readable reuse and reproduction statement that applies to the DRO.",
-          "type": "string"
-        },
-        "termsOfUse": {
-          "description": "License or terms of use governing reuse of the DRO. Should be a text statement.",
-          "type": "string"
-        },
-        "visibility": {
-          "description": "Percentage of the DRO that is visibility during an embargo period",
-          "type": "integer"
-        }
-      }
-    },
-    "administrative": {
-      "type": "object",
-      "description": "Administrative metadata for the SDR resource.",
-      "required": ["created", "isDescribedBy", "sdrPreserve"],
-      "properties": {
-        "created": {
-          "description": "When the resource in SDR was created.",
-          "type": "string",
-          "format": "date-time"
-        },
-        "deleted": {
-          "description": "If the resource has been deleted (but not purged).",
-          "type": "boolean"
-        },
-        "gravestoneMessage": {
-          "description": "Message describing why the object was deleted.",
-          "type": "string"
-        },
-        "isDescribedBy": {
-          "description": "Pointer to the PURL/XML file that is a traditional representation of the metadata for the DRO.",
-          "type": "string"
-        },
-        "lastUpdated": {
-          "description": "When the resource in SDR was last updated.",
-          "type": "string",
-          "format": "date-time"
-        },
-        "partOfProject": {
-          "description": "Administrative or Internal project this resource is a part of.",
-          "type": "string"
-        },
-        "releaseTags": {
-          "description": "Tags for release",
-          "type": "array",
-          "items": {
-            "$ref": "/ReleaseTag"
-          }
-        },
-        "sdrPreserve": {
-          "description": "If this resource should be sent to Preservation.",
-          "type": "boolean"
-        },
-        "remediatedBy": {
-          "description": "The Agent (User, Group, Application, Department, other) that remediated a DRO in SDR.",
-          "type": "array",
-          "items": {
-            "$ref": "/Agent"
-          }
-        }
-      }
-    },
-    "description": {
-      "description": "Descriptive metadata for the DRO.",
-      "$ref": "/Description"
-    },
-    "geographic": {
-      "description": "Geographic metadata for the DRO.",
-      "type": "object",
-      "required": ["iso19139"],
-      "properties": {
-        "iso19139": {
-          "description": "Geographic ISO 19139 XML metadata",
-          "type": "string"
-        }
-      }
-    },
-    "identification": {
-      "description": "Identifying information for the DRO.",
-      "type": "object",
-      "required": ["identifier"],
-      "properties": {
-        "catalogLinks": {
-          "description": "Links to catalog records for the resource that the DRO represents in whole or part.",
-          "type": "array",
-          "items": {
-            "type": "object",
-            "required": ["catalog", "catalogRecordId"],
-            "properties": {
-              "catalog": {
-                "description": "Catalog that is the source of the linked record.",
-                "type": "string"
-              },
-              "catalogRecordId": {
-                "description": "Record identifier that is unique within the context of the linked record's catalog.",
-                "type": "string"
-              },
-              "recordSchema": {
-                "description": "Metadata schema of the linked record.",
-                "type": "string"
-              },
-              "deriveMetadata": {
-                "description": "If the DRO descriptive metadata should be automatically updated when the linked record changes.",
-                "type": "boolean"
-              },
-              "deliverMetadata": {
-                "description": "If the linked record should be automatically updated when the DRO descriptive metadata changes.",
-                "type": "boolean"
-              },
-              "recordScope": {
-                "description": "Whether the linked record describes a resource that is broader than, equivalent to, or narrower than the resource the DRO represents.",
-                "type": "string",
-                "enum": ["broader", "equivalent", "narrower"]
-              }
-            }
-          }
-        },
-        "doi": {
-          "description": "Digital Object Identifier (DOI) for the DRO within this repository.",
-          "type": "string"
-        },
-        "identifier": {
-          "description": "Identifier for the Digital Repository Object within the Stanford Digital Repository system",
-          "type": "string"
-        },
-        "sameAs": {
-          "description": "Another object, either external or internal to the system (if duplication occurs) that is the same digital resource as this DRO.",
-          "type": "string"
-        },
-        "sourceId": {
-          "description": "A source resource or object (perhaps but not necessarily analog or physical) that the DRO is a digital representation of.",
-          "type": "string"
-        },
-        "sdrUUID": {
-          "type": "string",
-          "description": "UUID previously minted for the resource within SDR2 / Fedora 3."
-        }
-      }
-    },
-    "permissions": {
-      "description": "Permissions Metadata for the DRO.",
-      "type": "object",
-      "properties": {
-        "approvalRequired": {
-          "description": "Indicates if approval is required to deposit or manage the resource in SDR.",
-          "type": "boolean"
-        },
-        "approvers": {
-          "description": "Agents who are required to approve deposit or management of this resource in SDR.",
-          "type": "array",
-          "items": {
-            "$ref": "/Agent"
-          }
-        }
-      }
-    },
-    "structural": {
-      "description": "Structural metadata for the DRO.",
-      "type": "object",
-      "properties": {
-        "contains": {
-          "description": "Filesets that contain the digital representations (Files) of the DRO.",
-          "type": "array",
-          "items": {
-            "$ref": "/Fileset"
-          }
-        },
-        "hasMember": {
-          "description": "Component or 'children' digital repository objects that are a part or portion of this 'parent' or aggregate DRO.",
-          "type": "array",
-          "items": {
-            "type": "string"
-          }
-        },
-        "isMemberOf": {
-          "description": "Collections that this DRO is a member of",
-          "type": "array",
-          "items": {
-            "type": "string"
-          }
-        },
-        "isTargetOf": {
-          "description": "An Annotation instance that applies to the DRO.",
-          "type": "string"
-        },
-        "hasMemberOrders": {
-          "description": "Provided sequences or orderings of members of the Object, including some metadata about each sequence (i.e. sequence label, sequence type, if the sequence is primary, etc.).",
-          "type": "array",
-          "items": {
-            "$ref": "/Sequence"
-          }
-        }
-      }
-    }
-  }
-}

data/docs/maps/Description.json

@@ -1,17 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-06/schema#",
-  "id": "http://cocina.sul.stanford.edu/schemas/Description",
-  "title": "Description",
-  "description": "The description of a work",
-  "type": "object",
-  "required": ["title"],
-  "properties": {
-    "title": {
-      "description": "The title of the item.",
-      "type": "array",
-      "items": {
-        "$ref": "/Title"
-      }
-    }
-  }
-}