cocina-models 0.14.0 → 0.15.0

data/docs/schema.md

@@ -0,0 +1,220 @@
+
+## <a name="resource-Agent">Agent</a>
+
+
+An Agent - Person, Group, Organization, or other Acting body.
+
+### Attributes
+
+| Name | Type | Description | Example |
+| ------- | ------- | ------- | ------- |
+| **name** | *string* | Primary label or name for an Agent. | `"example"` |
+| **sunetID** | *string* | Stanford University NetID for the Agent. | `"example"` |
+
+
+## <a name="resource-Collection">Digital Repository Collection</a>
+
+
+A group of Digital Repository Objects that indicate some type of conceptual grouping within the domain that is worth reusing across the system.
+
+### Attributes
+
+| Name | Type | Description | Example |
+| ------- | ------- | ------- | ------- |
+| **@context** | *string* | URI for the JSON-LD context definitions. | `"example"` |
+| **@type** | *string* | The content type of the Collection. Selected from an established set of values.<br/> **one of:**`"http://cocina.sul.stanford.edu/models/collection.jsonld"` or `"http://cocina.sul.stanford.edu/models/curated-collection.jsonld"` or `"http://cocina.sul.stanford.edu/models/user-collection.jsonld"` or `"http://cocina.sul.stanford.edu/models/exhibit.jsonld"` or `"http://cocina.sul.stanford.edu/models/series.jsonld"` | `"http://cocina.sul.stanford.edu/models/collection.jsonld"` |
+| **access:access** | *string* | Access level for the Collection.<br/> **one of:**`"world"` or `"stanford"` or `"location-based"` or `"citation-only"` or `"dark"` | `"world"` |
+| **access:copyright** | *string* | The human readable copyright statement that applies to the Collection. | `"example"` |
+| **access:download** | *string* | Download level for the Collection metadata.<br/> **one of:**`"world"` or `"stanford"` or `"location-based"` or `"citation-only"` or `"dark"` | `"world"` |
+| **access:embargoReleaseDate** | *date-time* | Date when the Collection is released from an embargo, if an embargo exists. | `"2015-01-01T12:00:00Z"` |
+| **access:license** | *string* | The license governing reuse of the Collection. Should be an IRI for known licenses (i.e. CC, RightsStatement.org URI, etc.). | `"example"` |
+| **access:reuseAndReproductionStatement** | *string* | The human readable reuse and reproduction statement that applies to the Collection. | `"example"` |
+| **access:termsOfUse** | *string* | License or terms of use governing reuse of the Collection. Should be a text statement. | `"example"` |
+| **administrative:created** | *date-time* | When the resource in SDR was created. | `"2015-01-01T12:00:00Z"` |
+| **administrative:deleted** | *boolean* | If the resource has been deleted (but not purged). | `true` |
+| **administrative:gravestoneMessage** | *string* | Message describing why the object was deleted. | `"example"` |
+| **administrative:isDescribedBy** | *string* | PURL/XML file that is a traditional representation of the metadata for the Collection. | `"example"` |
+| **administrative:lastUpdated** | *date-time* | When the resource in SDR was last updated. | `"2015-01-01T12:00:00Z"` |
+| **administrative:partOfProject** | *string* | Administrative or Internal project this resource is a part of. | `"example"` |
+| **administrative:remediatedBy** | *array* | The Agent (User, Group, Application, Department, other) that remediated a Collection in SDR. | `[{"name":"example","sunetID":"example"}]` |
+| **administrative:sdrPreserve** | *boolean* | If this resource should be sent to Preservation. | `true` |
+| **citation** | *string* | Citation for the resource, including identifier, label, version, and a persistent URL to the object with SDR at the very least. | `"example"` |
+| **dedupeIdentifier** | *string* | Identifier retrieved from identification.sourceId that stands for analog or source identifier that this resource is a digital representation of. | `"example"` |
+| **depositor:name** | *string* | Primary label or name for an Agent. | `"example"` |
+| **depositor:sunetID** | *string* | Stanford University NetID for the Agent. | `"example"` |
+| **externalIdentifier** | *string* | 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` | `"example"` |
+| **followingVersion** | *string* | Following version for the Collection within SDR. | `"example"` |
+| **identification:DOI** | *string* | Digital Object Identifier (DOI) for the Collection within this repository. | `"example"` |
+| **identification:catalogLinks/catalog** | *string* | Catalog that is the source of the linked record. | `"example"` |
+| **identification:catalogLinks/catalogRecordId** | *string* | Record identifier that is unique within the context of the linked record's catalog. | `"example"` |
+| **identification:catalogLinks/deliverMetadata** | *boolean* | If the linked record should be automatically updated when the Collection descriptive metadata changes. | `true` |
+| **identification:catalogLinks/deriveMetadata** | *boolean* | If the Collection descriptive metadata should be automatically updated when the linked record changes. | `true` |
+| **identification:catalogLinks/recordSchema** | *string* | Metadata schema of the linked record. | `"example"` |
+| **identification:catalogLinks/recordScope** | *string* | Whether the linked record describes a resource that is broader than, equivalent to, or narrower than the resource the Collection represents.<br/> **one of:**`"broader"` or `"equivalent"` or `"narrower"` | `"broader"` |
+| **identification:identifier** | *string* | Identifier for the Collection within the Stanford Digital Repository system | `"example"` |
+| **identification:sameAs** | *string* | Another object, either external or internal to the system (if duplication occurs) that is the same digital resource as this Collection. | `"example"` |
+| **identification:sdrUUID** | *string* | UUID previously minted for the resource within SDR2 / Fedora 3. | `"example"` |
+| **identification:sourceId** | *string* | A source resource or object (perhaps but not necessarily analog or physical) that the Collection is a digital representation of. | `"example"` |
+| **internalIdentifier** | *string* | Identifier for the resource within the repository. UUID, unique for each new version of a repository resource. | `"example"` |
+| **label** | *string* | Primary processing label (can be same as title) for a Collection. | `"example"` |
+| **precedingVersion** | *string* | Preceding version for the Collection within SDR. | `"example"` |
+| **structural:hasAgreement** | *string* | Agreement that covers the deposit of the Collection into SDR. | `"example"` |
+| **structural:hasMember** | *array* | Component digital repository objects or collections that are a part of this collection. | `[null]` |
+| **structural:hasMemberOrders** | *array* | 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.). | `[{"@context":"example","@type":"http://cocina.sul.stanford.edu/models/sequence.jsonld","label":"example","startMember":"example","members":[null]}]` |
+| **structural:isTargetOf** | *string* | An Annotation instance that applies to the Collection. | `"example"` |
+| **version** | *integer* | Version for the Collection within SDR. | `42` |
+
+
+## <a name="resource-DRO">Digital Repository Object</a>
+
+
+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.
+
+### Attributes
+
+| Name | Type | Description | Example |
+| ------- | ------- | ------- | ------- |
+| **@context** | *string* | URI for the JSON-LD context definitions. | `"example"` |
+| **@type** | *string* | The content type of the DRO. Selected from an established set of values.<br/> **one of:**`"http://cocina.sul.stanford.edu/models/object.jsonld"` or `"http://cocina.sul.stanford.edu/models/3d.jsonld"` or `"http://cocina.sul.stanford.edu/models/agreement.jsonld"` or `"http://cocina.sul.stanford.edu/models/book.jsonld"` or `"http://cocina.sul.stanford.edu/models/document.jsonld"` or `"http://cocina.sul.stanford.edu/models/geo.jsonld"` or `"http://cocina.sul.stanford.edu/models/image.jsonld"` or `"http://cocina.sul.stanford.edu/models/page.jsonld"` or `"http://cocina.sul.stanford.edu/models/photograph.jsonld"` or `"http://cocina.sul.stanford.edu/models/manuscript.jsonld"` or `"http://cocina.sul.stanford.edu/models/map.jsonld"` or `"http://cocina.sul.stanford.edu/models/media.jsonld"` or `"http://cocina.sul.stanford.edu/models/track.jsonld"` or `"http://cocina.sul.stanford.edu/models/webarchive-binary.jsonld"` or `"http://cocina.sul.stanford.edu/models/webarchive-seed.jsonld"` | `"http://cocina.sul.stanford.edu/models/object.jsonld"` |
+| **access:access** | *string* | Access level for the DRO.<br/> **one of:**`"world"` or `"stanford"` or `"location-based"` or `"citation-only"` or `"dark"` | `"world"` |
+| **access:copyright** | *string* | The human readable copyright statement that applies to the DRO. | `"example"` |
+| **access:download** | *string* | Download level for the DRO metadata.<br/> **one of:**`"world"` or `"stanford"` or `"location-based"` or `"citation-only"` or `"dark"` | `"world"` |
+| **access:embargoReleaseDate** | *date-time* | Date when the DRO is released from an embargo, if an embargo exists. | `"2015-01-01T12:00:00Z"` |
+| **access:license** | *string* | The license governing reuse of the DRO. Should be an IRI for known licenses (i.e. CC, RightsStatement.org URI, etc.). | `"example"` |
+| **access:reuseAndReproductionStatement** | *string* | The human readable reuse and reproduction statement that applies to the DRO. | `"example"` |
+| **access:termsOfUse** | *string* | License or terms of use governing reuse of the DRO. Should be a text statement. | `"example"` |
+| **access:visibility** | *integer* | Percentage of the DRO that is visibility during an embargo period | `42` |
+| **administrative:created** | *date-time* | When the resource in SDR was created. | `"2015-01-01T12:00:00Z"` |
+| **administrative:deleted** | *boolean* | If the resource has been deleted (but not purged). | `true` |
+| **administrative:gravestoneMessage** | *string* | Message describing why the object was deleted. | `"example"` |
+| **administrative:isDescribedBy** | *string* | Pointer to the PURL/XML file that is a traditional representation of the metadata for the DRO. | `"example"` |
+| **administrative:lastUpdated** | *date-time* | When the resource in SDR was last updated. | `"2015-01-01T12:00:00Z"` |
+| **administrative:partOfProject** | *string* | Administrative or Internal project this resource is a part of. | `"example"` |
+| **administrative:remediatedBy** | *array* | The Agent (User, Group, Application, Department, other) that remediated a DRO in SDR. | `[{"name":"example","sunetID":"example"}]` |
+| **administrative:sdrPreserve** | *boolean* | If this resource should be sent to Preservation. | `true` |
+| **citation** | *string* | Citation for the resource, including identifier, label, version, and a persistent URL to the object with SDR at the very least. | `"example"` |
+| **dedupeIdentifier** | *string* | Identifier retrieved from identification.sourceId that stands for analog or source identifier that this resource is a digital representation of. | `"example"` |
+| **depositor:name** | *string* | Primary label or name for an Agent. | `"example"` |
+| **depositor:sunetID** | *string* | Stanford University NetID for the Agent. | `"example"` |
+| **externalIdentifier** | *string* | 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` | `"example"` |
+| **followingVersion** | *string* | Following version for the Object within SDR. | `"example"` |
+| **identification:catalogLinks/catalog** | *string* | Catalog that is the source of the linked record. | `"example"` |
+| **identification:catalogLinks/catalogRecordId** | *string* | Record identifier that is unique within the context of the linked record's catalog. | `"example"` |
+| **identification:catalogLinks/deliverMetadata** | *boolean* | If the linked record should be automatically updated when the DRO descriptive metadata changes. | `true` |
+| **identification:catalogLinks/deriveMetadata** | *boolean* | If the DRO descriptive metadata should be automatically updated when the linked record changes. | `true` |
+| **identification:catalogLinks/recordSchema** | *string* | Metadata schema of the linked record. | `"example"` |
+| **identification:catalogLinks/recordScope** | *string* | Whether the linked record describes a resource that is broader than, equivalent to, or narrower than the resource the DRO represents.<br/> **one of:**`"broader"` or `"equivalent"` or `"narrower"` | `"broader"` |
+| **identification:doi** | *string* | Digital Object Identifier (DOI) for the DRO within this repository. | `"example"` |
+| **identification:identifier** | *string* | Identifier for the Digital Repository Object within the Stanford Digital Repository system | `"example"` |
+| **identification:sameAs** | *string* | Another object, either external or internal to the system (if duplication occurs) that is the same digital resource as this DRO. | `"example"` |
+| **identification:sdrUUID** | *string* | UUID previously minted for the resource within SDR2 / Fedora 3. | `"example"` |
+| **identification:sourceId** | *string* | A source resource or object (perhaps but not necessarily analog or physical) that the DRO is a digital representation of. | `"example"` |
+| **internalIdentifier** | *string* | Identifier for the resource within the repository. UUID, unique for each new version of a repository resource. | `"example"` |
+| **label** | *string* | Primary processing label (can be same as title) for a DRO. | `"example"` |
+| **permissions:approvalRequired** | *boolean* | Indicates if approval is required to deposit or manage the resource in SDR. | `true` |
+| **permissions:approvers** | *array* | Agents who are required to approve deposit or management of this resource in SDR. | `[{"name":"example","sunetID":"example"}]` |
+| **precedingVersion** | *string* | Preceding version for the Object within SDR. | `"example"` |
+| **structural:contains** | *array* | Filesets that contain the digital representations (Files) of the DRO. | `[{"@context":"example","@type":"http://cocina.sul.stanford.edu/models/fileset.jsonld","depositor":{"name":"example","sunetID":"example"},"label":"example","externalIdentifier":"example","internalIdentifier":"example","version":42,"precedingVersion":"example","followingVersion":"example","access":{"access":"world","download":"world"},"administrative":{"created":"2015-01-01T12:00:00Z","deleted":true,"gravestoneMessage":"example","lastUpdated":"2015-01-01T12:00:00Z","partOfProject":"example","sdrPreserve":true,"remediatedBy":[{"name":"example","sunetID":"example"}]},"identification":{"identifier":"example","sdrUUID":"example"},"structural":{"contains":[{"@context":"example","@type":"http://cocina.sul.stanford.edu/models/file.jsonld","depositor":{"name":"example","sunetID":"example"},"externalIdentifier":"example","filename":"example","format":"example","hasMessageDigests":[{"type":"md5","digest":"example"}],"hasMimeType":"example","label":"example","presentation":{"height":42,"width":42},"size":42,"internalIdentifier":"example","use":"example","version":42,"precedingVersion":"example","followingVersion":"example","access":{"access":"world","download":"world"},"administrative":{"created":"2015-01-01T12:00:00Z","deleted":true,"gravestoneMessage":"example","lastUpdated":"2015-01-01T12:00:00Z","partOfProject":"example","sdrPreserve":true,"shelve":true,"remediatedBy":[{"name":"example","sunetID":"example"}]},"identification":{"filename":"example","identifier":"example","sdrUUID":"example"},"structural":{"isContainedBy":"example","isTargetOf":"example"}}],"isContainedBy":"example","isTargetOf":"example"}}]` |
+| **structural:hasAgreement** | *string* | Agreement that covers the deposit of the DRO into SDR. | `"example"` |
+| **structural:hasMember** | *array* | Component or 'children' digital repository objects that are a part or portion of this 'parent' or aggregate DRO. | `[null]` |
+| **structural:hasMemberOrders** | *array* | 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.). | `[{"@context":"example","@type":"http://cocina.sul.stanford.edu/models/sequence.jsonld","label":"example","startMember":"example","members":[null]}]` |
+| **structural:isTargetOf** | *string* | An Annotation instance that applies to the DRO. | `"example"` |
+| **version** | *integer* | Version for the DRO within SDR. | `42` |
+
+
+## <a name="resource-File">File</a>
+
+
+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.
+
+### Attributes
+
+| Name | Type | Description | Example |
+| ------- | ------- | ------- | ------- |
+| **@context** | *string* | URI for the JSON-LD context definitions. | `"example"` |
+| **@type** | *string* | The content type of the File.<br/> **one of:**`"http://cocina.sul.stanford.edu/models/file.jsonld"` | `"http://cocina.sul.stanford.edu/models/file.jsonld"` |
+| **access:access** | *string* | Access level for the File.<br/> **one of:**`"world"` or `"stanford"` or `"location-based"` or `"citation-only"` or `"dark"` | `"world"` |
+| **access:download** | *string* | Download level for the File binary.<br/> **one of:**`"world"` or `"stanford"` or `"location-based"` or `"citation-only"` or `"dark"` | `"world"` |
+| **administrative:created** | *date-time* | When the resource in SDR was created. | `"2015-01-01T12:00:00Z"` |
+| **administrative:deleted** | *boolean* | If the resource has been deleted (but not purged). | `true` |
+| **administrative:gravestoneMessage** | *string* | Message describing why the resource was deleted. | `"example"` |
+| **administrative:lastUpdated** | *date-time* | When the resource in SDR was last updated. | `"2015-01-01T12:00:00Z"` |
+| **administrative:partOfProject** | *string* | Administrative or Internal project this resource is a part of. | `"example"` |
+| **administrative:remediatedBy** | *array* | The Agent (User, Group, Application, Department, other) that remediated this File in SDR. | `[{"name":"example","sunetID":"example"}]` |
+| **administrative:sdrPreserve** | *boolean* | If this resource should be sent to Preservation. | `true` |
+| **administrative:shelve** | *boolean* | If this resource should be sent to Stacks. | `true` |
+| **depositor:name** | *string* | Primary label or name for an Agent. | `"example"` |
+| **depositor:sunetID** | *string* | Stanford University NetID for the Agent. | `"example"` |
+| **externalIdentifier** | *string* | 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` | `"example"` |
+| **filename** | *string* | Filename for a file. Can be same as label. | `"example"` |
+| **followingVersion** | *string* | Following version for the File within SDR. | `"example"` |
+| **format** | *string* | Format of the File. | `"example"` |
+| **hasMessageDigests/digest** | *string* | The digest value | `"example"` |
+| **hasMessageDigests/type** | *string* | The algorithm that was used<br/> **one of:**`"md5"` or `"sha1"` | `"md5"` |
+| **hasMimeType** | *string* | MIME Type of the File. | `"example"` |
+| **identification:filename** | *string* | Filename for the File from originating systems. | `"example"` |
+| **identification:identifier** | *string* | Identifier for the File within the Stanford Digital Repository system | `"example"` |
+| **identification:sdrUUID** | *string* | UUID previously minted for the resource within SDR2 / Fedora 3. | `"example"` |
+| **internalIdentifier** | *string* | Identifier for the resource within the repository. UUID, unique for each new version of a repository resource. | `"example"` |
+| **label** | *string* | Primary processing label (can be same as title) for a File. | `"example"` |
+| **precedingVersion** | *string* | Preceding version for the File within SDR. | `"example"` |
+| **presentation:height** | *integer* | Height in pixels | `42` |
+| **presentation:width** | *integer* | Width in pixels | `42` |
+| **size** | *integer* | Size of the File (binary) in bytes. | `42` |
+| **structural:isContainedBy** | *string* | Fileset that contains this File. | `"example"` |
+| **structural:isTargetOf** | *string* | An Annotation instance that applies to this File. | `"example"` |
+| **use** | *string* | Use for the File. | `"example"` |
+| **version** | *integer* | Version for the File within SDR. | `42` |
+
+
+## <a name="resource-Fileset">Fileset</a>
+
+
+Relevant groupings of Files. Also called a File Grouping.
+
+### Attributes
+
+| Name | Type | Description | Example |
+| ------- | ------- | ------- | ------- |
+| **@context** | *string* | URI for the JSON-LD context definitions. | `"example"` |
+| **@type** | *string* | The content type of the Fileset.<br/> **one of:**`"http://cocina.sul.stanford.edu/models/fileset.jsonld"` | `"http://cocina.sul.stanford.edu/models/fileset.jsonld"` |
+| **access:access** | *string* | Access level for the Fileset.<br/> **one of:**`"world"` or `"stanford"` or `"location-based"` or `"citation-only"` or `"dark"` | `"world"` |
+| **access:download** | *string* | Download level for the Fileset metadata.<br/> **one of:**`"world"` or `"stanford"` or `"location-based"` or `"citation-only"` or `"dark"` | `"world"` |
+| **administrative:created** | *date-time* | When the resource in SDR was created. | `"2015-01-01T12:00:00Z"` |
+| **administrative:deleted** | *boolean* | If the resource has been deleted (but not purged). | `true` |
+| **administrative:gravestoneMessage** | *string* | Message describing why the resource was deleted. | `"example"` |
+| **administrative:lastUpdated** | *date-time* | When the resource in SDR was last updated. | `"2015-01-01T12:00:00Z"` |
+| **administrative:partOfProject** | *string* | Administrative or Internal project this resource is a part of. | `"example"` |
+| **administrative:remediatedBy** | *array* | The Agent (User, Group, Application, Department, other) that remediated a Fileset in SDR. | `[{"name":"example","sunetID":"example"}]` |
+| **administrative:sdrPreserve** | *boolean* | If this resource should be sent to Preservation. | `true` |
+| **depositor:name** | *string* | Primary label or name for an Agent. | `"example"` |
+| **depositor:sunetID** | *string* | Stanford University NetID for the Agent. | `"example"` |
+| **externalIdentifier** | *string* | 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` | `"example"` |
+| **followingVersion** | *string* | Following version for the Fileset within SDR. | `"example"` |
+| **identification:identifier** | *string* | Identifier for the Fileset within the Stanford Digital Repository system | `"example"` |
+| **identification:sdrUUID** | *string* | UUID previously minted for the resource within SDR2 / Fedora 3. | `"example"` |
+| **internalIdentifier** | *string* | Identifier for the resource within the repository. UUID, unique for each new version of a repository resource. | `"example"` |
+| **label** | *string* | Primary processing label (can be same as title) for a Fileset. | `"example"` |
+| **precedingVersion** | *string* | Preceding version for the Fileset within SDR. | `"example"` |
+| **structural:contains** | *array* | Files that are members of the fileset. | `[{"@context":"example","@type":"http://cocina.sul.stanford.edu/models/file.jsonld","depositor":{"name":"example","sunetID":"example"},"externalIdentifier":"example","filename":"example","format":"example","hasMessageDigests":[{"type":"md5","digest":"example"}],"hasMimeType":"example","label":"example","presentation":{"height":42,"width":42},"size":42,"internalIdentifier":"example","use":"example","version":42,"precedingVersion":"example","followingVersion":"example","access":{"access":"world","download":"world"},"administrative":{"created":"2015-01-01T12:00:00Z","deleted":true,"gravestoneMessage":"example","lastUpdated":"2015-01-01T12:00:00Z","partOfProject":"example","sdrPreserve":true,"shelve":true,"remediatedBy":[{"name":"example","sunetID":"example"}]},"identification":{"filename":"example","identifier":"example","sdrUUID":"example"},"structural":{"isContainedBy":"example","isTargetOf":"example"}}]` |
+| **structural:isContainedBy** | *string* | Parent DRO that is represented by the files in this Fileset. | `"example"` |
+| **structural:isTargetOf** | *string* | An Annotation instance that applies to this Fileset. | `"example"` |
+| **version** | *integer* | Version for the Fileset within SDR. | `42` |
+
+
+## <a name="resource-Sequence">Resource Sequence</a>
+
+
+A sequence or ordering of resources within a Collection or Object.
+
+### Attributes
+
+| Name | Type | Description | Example |
+| ------- | ------- | ------- | ------- |
+| **@context** | *string* | URI for the JSON-LD context definitions. | `"example"` |
+| **@type** | *string* | The type of Sequence.<br/> **one of:**`"http://cocina.sul.stanford.edu/models/sequence.jsonld"` or `"http://cocina.sul.stanford.edu/models/primary-sequence.jsonld"` | `"http://cocina.sul.stanford.edu/models/sequence.jsonld"` |
+| **label** | *string* | Label for the sequence or ordering. | `"example"` |
+| **members** | *array* | Identifiers for Members in their stated Order for the Sequence. | `[null]` |
+| **startMember** | *string* | Identifier for the first member of the sequence. | `"example"` |
+
+

data/lib/cocina/models/admin_policy.rb

@@ -56,11 +56,16 @@ module Cocina
         # which workflow to start when registering (used by Web Archive apos to start wasCrawlPreassemblyWF)
         attribute :registration_workflow, Types::String.optional.default(nil)
 
+        # Allowing hasAdminPolicy to be omittable for now (until rolled out to consumers),
+        # but I think it's actually required for every Admin Policy
+        attribute :hasAdminPolicy, Types::Coercible::String.optional.default(nil)
+
         def self.from_dynamic(dyn)
           params = {
             default_object_rights: dyn['default_object_rights'],
             registration_workflow: dyn['registration_workflow']
           }
+          params[:hasAdminPolicy] = dyn['hasAdminPolicy']
           Administrative.new(params)
         end
       end

data/lib/cocina/models/collection.rb

@@ -26,7 +26,7 @@ module Cocina
 
       # Subschema for administrative concerns
       class Administrative < Dry::Struct
-        attribute :releaseTags, Types::Strict::Array.of(ReleaseTag).meta(omittable: true)
+        attribute :releaseTags, Types::Strict::Array.of(ReleaseTag).default([].freeze)
         # Allowing hasAdminPolicy to be omittable for now (until rolled out to consumers),
         # but I think it's actually required for every DRO
         attribute :hasAdminPolicy, Types::Coercible::String.optional.default(nil)

data/lib/cocina/models/dro.rb

@@ -39,7 +39,7 @@ module Cocina
 
       # Subschema for administrative concerns
       class Administrative < Dry::Struct
-        attribute :releaseTags, Types::Strict::Array.of(ReleaseTag).meta(omittable: true)
+        attribute :releaseTags, Types::Strict::Array.of(ReleaseTag).meta(omittable: true).default([].freeze)
         # Allowing hasAdminPolicy to be omittable for now (until rolled out to consumers),
         # but I think it's actually required for every DRO
         attribute :hasAdminPolicy, Types::Coercible::String.optional.default(nil)
@@ -58,9 +58,11 @@ module Cocina
       # Structural sub-schema for the DRO
       class Structural < Dry::Struct
         attribute :contains, Types::Strict::Array.of(FileSet).meta(omittable: true)
+        attribute :isMemberOf, Types::Strict::String.meta(omittable: true)
 
         def self.from_dynamic(dyn)
           params = {}
+          params[:isMemberOf] = dyn['isMemberOf'] if dyn['isMemberOf']
           params[:contains] = dyn['contains'].map { |fs| FileSet.from_dynamic(fs) } if dyn['contains']
           Structural.new(params)
         end

data/lib/cocina/models/file.rb

@@ -12,6 +12,37 @@ module Cocina
         Vocab.file
       ].freeze
 
+      # Represents access controls on the file
+      class Access < Dry::Struct
+        attribute :access, Types::String.default('dark')
+                                        .enum('world', 'stanford', 'location-based', 'citation-only', 'dark')
+
+        def self.from_dynamic(dyn)
+          return unless dyn
+
+          params = {}
+          params[:access] = dyn['access'] if dyn['access']
+
+          Access.new(params)
+        end
+      end
+
+      # Represents the administration of the file
+      class Administrative < Dry::Struct
+        attribute :sdrPreserve, Types::Params::Bool.optional.default(false)
+        attribute :shelve, Types::Params::Bool.optional.default(false)
+
+        def self.from_dynamic(dyn)
+          return unless dyn
+
+          params = {
+            sdrPreserve: dyn['sdrPreserve'],
+            shelve: dyn['shelve']
+          }
+          Administrative.new(params)
+        end
+      end
+
       class Identification < Dry::Struct
       end
 
@@ -39,6 +70,8 @@ module Cocina
         attribute :width, Types::Coercible::Integer.optional.default(nil)
 
         def self.from_dynamic(dyn)
+          return unless dyn
+
           params = {
             height: dyn['height'],
             width: dyn['width']
@@ -48,14 +81,16 @@ module Cocina
         end
       end
 
+      attribute(:access, Access.optional.default { Access.new })
+      attribute(:administrative, Administrative.default { Administrative.new })
       attribute :externalIdentifier, Types::Strict::String
       attribute :type, Types::String.enum(*TYPES)
       attribute :label, Types::Strict::String
       attribute :filename, Types::String.optional.default(nil)
       attribute :use, Types::String.enum('original', 'preservation', 'access').optional.default(nil)
       attribute :size, Types::Coercible::Integer.optional.default(nil)
-      attribute :hasMessageDigests, Types::Strict::Array.of(Fixity).default([])
-      attribute :presentation, Presentation.optional.default(Presentation.new)
+      attribute :hasMessageDigests, Types::Strict::Array.of(Fixity).default([].freeze)
+      attribute(:presentation, Presentation.optional.default { Presentation.new })
       attribute :version, Types::Coercible::Integer
       attribute(:identification, Identification.default { Identification.new })
       attribute(:structural, Structural.default { Structural.new })
@@ -69,10 +104,10 @@ module Cocina
           size: dyn['size'],
           use: dyn['use']
         }
-        params[:presentation] = Presentation.from_dynamic(dyn['presentation']) if dyn['presentation']
-        if dyn['hasMessageDigests']
-          params[:hasMessageDigests] = dyn['hasMessageDigests'].map { |p| Fixity.from_dynamic(p) }
-        end
+        params[:administrative] = Administrative.from_dynamic(dyn['administrative'])
+        params[:presentation] = Presentation.from_dynamic(dyn['presentation'])
+        params[:access] = Access.from_dynamic(dyn['access'])
+        params[:hasMessageDigests] = Array(dyn['hasMessageDigests']).map { |p| Fixity.from_dynamic(p) }
         File.new(params)
       end
 

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.14.0'
+    VERSION = '0.15.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-30 00:00:00.000000000 Z
+date: 2020-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -164,11 +164,15 @@ files:
 - docs/maps/File.json
 - docs/maps/Fileset.json
 - docs/maps/README.md
+- docs/maps/ReleaseTag.json
 - docs/maps/Sequence.json
+- docs/meta.json
 - docs/sampleETD/foxml-export.xml
 - docs/sampleETD/foxml.xml
 - docs/sampleETD/xn109qc9773_bibframe.ttl
 - docs/sampleETD/xn109qc9773_taco.json
+- docs/schema.json
+- docs/schema.md
 - lib/cocina/models.rb
 - lib/cocina/models/admin_policy.rb
 - lib/cocina/models/checkable.rb
@@ -198,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Data models for the SDR