cocina-models 0.75.0 → 0.78.0

data/docs/maps/File.json

@@ -1,196 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-06/schema#",
-  "id": "http://cocina.sul.stanford.edu/schemas/File",
-  "title": "File",
-  "description": "Binaries that are the basis of what our domain manages. Binaries here do not include metadata files generated for the domain's own management purposes.",
-  "type": "object",
-  "required": ["@context", "@type", "externalIdentifier", "internalIdentifier", "label", "version", "administrative", "access", "identification", "structural"],
-  "properties": {
-    "@context": {
-      "description": "URI for the JSON-LD context definitions.",
-      "type": "string"
-    },
-    "@type": {
-      "description": "The content type of the File.",
-      "type": "string",
-      "enum": [
-        "http://cocina.sul.stanford.edu/models/file.jsonld"
-      ]
-    },
-    "depositor": {
-      "description": "The Agent (User, Group, Application, Department, other) that deposited the File into SDR.",
-      "$ref": "/Agent"
-    },
-    "externalIdentifier": {
-      "description": "Identifier for the resource within the SDR architecture but outside of the repository. UUID. Constant across resource versions. What clients will use calling the repository. Same as `identification.identifier`",
-      "type": "string"
-    },
-    "filename": {
-      "description": "Filename for a file. Can be same as label.",
-      "type": "string"
-    },
-    "format": {
-      "description": "Format of the File.",
-      "type": "string"
-    },
-    "hasMessageDigests": {
-      "description": "The output of the message digest algorithm.",
-      "type": "array",
-      "items": {
-        "required": ["type", "digest"],
-        "properties": {
-          "type": {
-            "description": "The algorithm that was used",
-            "type": "string",
-            "enum": ["md5", "sha1"]
-          },
-          "digest": {
-            "description": "The digest value",
-            "type": "string"
-          }
-        }
-      }
-    },
-    "hasMimeType": {
-      "description": "MIME Type of the File.",
-      "type": "string"
-    },
-    "label": {
-      "description": "Primary processing label (can be same as title) for a File.",
-      "type": "string"
-    },
-    "presentation": {
-      "description": "Presentation data for the File.",
-      "type": "object",
-      "properties": {
-        "height": {
-          "description": "Height in pixels",
-          "type": "integer"
-        },
-        "width": {
-          "description": "Width in pixels",
-          "type": "integer"
-        }
-      }
-    },
-    "size": {
-      "description": "Size of the File (binary) in bytes.",
-      "type": "integer"
-    },
-    "internalIdentifier": {
-      "description": "Identifier for the resource within the repository. UUID, unique for each new version of a repository resource.",
-      "type": "string"
-    },
-    "use": {
-      "description": "Use for the File.",
-      "type": "string"
-    },
-    "version": {
-      "description": "Version for the File within SDR.",
-      "type": "integer"
-    },
-    "precedingVersion": {
-      "description": "Preceding version for the File within SDR.",
-      "type": "string"
-    },
-    "followingVersion": {
-      "description": "Following version for the File within SDR.",
-      "type": "string"
-    },
-    "access": {
-      "description": "Access Metadata for the File.",
-      "type": "object",
-      "required": ["access", "download"],
-      "properties": {
-        "access": {
-          "description": "Access level for the File. If \"dark\" this won't go into public xml contentMetadata.",
-          "type": "string",
-          "enum": ["world", "stanford", "location-based", "citation-only", "dark"]
-        },
-        "download": {
-          "description": "Download level for the File binary.",
-          "type": "string",
-          "enum": ["world", "stanford", "location-based", "citation-only", "dark"]
-        }
-      }
-    },
-    "administrative": {
-      "type": "object",
-      "description": "Administrative metadata for the SDR resource.",
-      "required": ["created", "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 resource was deleted.",
-          "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"
-        },
-        "sdrPreserve": {
-          "description": "If this resource should be sent to Preservation.",
-          "type": "boolean"
-        },
-        "shelve": {
-          "description": "If this resource should be sent to Stacks.",
-          "type": "boolean"
-        },
-        "remediatedBy": {
-          "description": "The Agent (User, Group, Application, Department, other) that remediated this File in SDR.",
-          "type": "array",
-          "items": {
-            "$ref": "/Agent"
-          }
-        }
-      }
-    },
-    "identification": {
-      "description": "Identifying information for the File.",
-      "type": "object",
-      "required": ["identifier", "sdrUUID"],
-      "properties": {
-        "filename": {
-          "description": "Filename for the File from originating systems.",
-          "type": "string"
-        },
-        "identifier": {
-          "description": "Identifier for the File within the Stanford Digital Repository system",
-          "type": "string"
-        },
-        "sdrUUID": {
-          "type": "string",
-          "description": "UUID previously minted for the resource within SDR2 / Fedora 3."
-        }
-      }
-    },
-    "structural": {
-      "description": "Structural metadata for the File.",
-      "type": "object",
-      "required": ["isContainedBy"],
-      "properties": {
-        "isContainedBy": {
-          "description": "Fileset that contains this File.",
-          "type": "string"
-        },
-        "isTargetOf": {
-          "description": "An Annotation instance that applies to this File.",
-          "type": "string"
-        }
-      }
-    }
-  }
-}

data/docs/maps/Fileset.json

@@ -1,143 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-06/schema#",
-  "id": "http://cocina.sul.stanford.edu/schemas/Fileset",
-  "title": "Fileset",
-  "description": "Relevant groupings of Files. Also called a File Grouping.",
-  "type": "object",
-  "required": ["@context", "@type", "externalIdentifier", "internalIdentifier", "label", "version", "administrative", "access", "identification", "structural"],
-  "properties": {
-    "@context": {
-      "description": "URI for the JSON-LD context definitions.",
-      "type": "string"
-    },
-    "@type": {
-      "description": "The content type of the Fileset.",
-      "type": "string",
-      "enum": [
-        "http://cocina.sul.stanford.edu/models/fileset.jsonld"
-      ]
-    },
-    "depositor": {
-      "description": "The Agent (User, Group, Application, Department, other) that deposited the Fileset into SDR.",
-      "$ref": "/Agent"
-    },
-    "label": {
-      "description": "Primary processing label (can be same as title) for a Fileset.",
-      "type": "string"
-    },
-    "externalIdentifier": {
-      "description": "Identifier for the resource within the SDR architecture but outside of the repository. UUID. Constant across resource versions. What clients will use calling the repository. Same as `identification.identifier`",
-      "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 Fileset within SDR.",
-      "type": "integer"
-    },
-    "precedingVersion": {
-      "description": "Preceding version for the Fileset within SDR.",
-      "type": "string"
-    },
-    "followingVersion": {
-      "description": "Following version for the Fileset within SDR.",
-      "type": "string"
-    },
-    "access": {
-      "description": "Access Metadata for the Fileset.",
-      "type": "object",
-      "required": ["access", "download"],
-      "properties": {
-        "access": {
-          "description": "Access level for the Fileset.",
-          "type": "string",
-          "enum": ["world", "stanford", "location-based", "citation-only", "dark"]
-        },
-        "download": {
-          "description": "Download level for the Fileset metadata.",
-          "type": "string",
-          "enum": ["world", "stanford", "location-based", "citation-only", "dark"]
-        }
-      }
-    },
-    "administrative": {
-      "type": "object",
-      "description": "Administrative metadata for the SDR resource.",
-      "required": ["created", "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 resource was deleted.",
-          "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"
-        },
-        "sdrPreserve": {
-          "description": "If this resource should be sent to Preservation.",
-          "type": "boolean"
-        },
-        "remediatedBy": {
-          "description": "The Agent (User, Group, Application, Department, other) that remediated a Fileset in SDR.",
-          "type": "array",
-          "items": {
-            "$ref": "/Agent"
-          }
-        }
-      }
-    },
-    "identification": {
-      "description": "Identifying information for the Fileset.",
-      "type": "object",
-      "required": ["identifier"],
-      "properties": {
-        "identifier": {
-          "description": "Identifier for the Fileset within the Stanford Digital Repository system",
-          "type": "string"
-        },
-        "sdrUUID": {
-          "type": "string",
-          "description": "UUID previously minted for the resource within SDR2 / Fedora 3."
-        }
-      }
-    },
-    "structural": {
-      "description": "Structural metadata for the Fileset.",
-      "type": "object",
-      "required": ["isContainedBy"],
-      "properties": {
-        "contains": {
-          "description": "Files that are members of the fileset.",
-          "type": "array",
-          "items": {
-            "$ref": "/File"
-          }
-        },
-        "isContainedBy": {
-          "description": "Parent DRO that is represented by the files in this Fileset.",
-          "type": "string"
-        },
-        "isTargetOf": {
-          "description": "An Annotation instance that applies to this Fileset.",
-          "type": "string"
-        }
-      }
-    }
-  }
-}

data/docs/maps/README.md

@@ -1,7 +0,0 @@
-# COCINA Metadata Application Profiles (MAPs) 🗺️
-
-This directory contains the metadata application profiles, or MAPs, for resources managed within the Stanford Digital Repository.
-
-Ultimately, these will relate to the API specifications for resources passed in or out for resource metadata validation and management. These are also MAPs we expect to iterate on, given the nature of metadata in library digital repository systems.
-
-Fuller documentation on these MAPs and the underlying model can be found here: https://sul-dlss.github.io/taco-truck/COCINA.html#cocina-data-models--shapes

data/docs/maps/ReleaseTag.json

@@ -1,39 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-06/schema#",
-  "id": "http://cocina.sul.stanford.edu/schemas/ReleaseTag",
-  "title": "Release Tag",
-  "description": "A tag that indicates the item or collection should be released.",
-  "type": "object",
-  "required": ["to", "what", "date", "who", "release"],
-  "properties": {
-    "to": {
-      "description": "What platform is it released to",
-      "type": "string",
-      "enum": [
-        "Searchworks",
-        "Earthworks"
-      ]
-    },
-    "what": {
-      "description": "What is being released. This item or the whole collection.",
-      "type": "string",
-      "enum": [
-        "self",
-        "collection"
-      ]
-    },
-    "date": {
-      "description": "When did this action happen",
-      "type": "string",
-      "format": "date-time"
-    },
-    "who": {
-      "description": "Who did this release",
-      "type": "string"
-    },
-    "release": {
-      "description": "Should it be released or withdrawn. Release is coded as true and withdraw as false",
-      "type": "boolean"
-    }
-  }
-}

data/docs/maps/Sequence.json

@@ -1,46 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-06/schema#",
-  "id": "http://cocina.sul.stanford.edu/schemas/Sequence",
-  "title": "Resource Sequence",
-  "description": "A sequence or ordering of resources within a Collection or Object.",
-  "type": "object",
-  "required": ["@type", "label", "startMember", "members"],
-  "properties": {
-    "@context": {
-      "description": "URI for the JSON-LD context definitions.",
-      "type": "string"
-    },
-    "@type": {
-      "description": "The type of Sequence.",
-      "type": "string",
-      "enum": ["http://cocina.sul.stanford.edu/models/sequence.jsonld",
-        "http://cocina.sul.stanford.edu/models/primary-sequence.jsonld"
-      ]
-    },
-    "label": {
-      "description": "Label for the sequence or ordering.",
-      "type": "string"
-    },
-    "startMember": {
-      "description": "Identifier for the first member of the sequence.",
-      "type": "string"
-    },
-    "members": {
-      "description": "Identifiers for Members in their stated Order for the Sequence.",
-      "type": "array",
-      "items": {
-        "type": "string"
-      }
-    },
-    "viewingDirection": {
-      "description": "The direction that a sequence of canvases should be displayed to the user",
-      "type": "string",
-      "enum": [
-        "left-to-right",
-        "right-to-left",
-        "top-to-bottom",
-        "bottom-to-top"
-      ]
-    }
-  }
-}

data/docs/maps/Title.json

@@ -1,18 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-06/schema#",
-  "id": "http://cocina.sul.stanford.edu/schemas/Title",
-  "title": "Title",
-  "description": "A title of a work",
-  "type": "object",
-  "required": ["titleFull", "primary"],
-  "properties": {
-    "primary": {
-      "description": "Is this the primary title for the object",
-      "type": "boolean"
-    },
-    "titleFull": {
-      "description": "The full title for the object",
-      "type": "string"
-    }
-  }
-}