cocina-models 0.31.0 → 0.34.1

data/lib/cocina/models/sequence.rb

@@ -3,6 +3,7 @@
 module Cocina
   module Models
     class Sequence < Struct
+      attribute :members, Types::Strict::Array.of(Types::Strict::String).meta(omittable: true)
       # The direction that a sequence of canvases should be displayed to the user
       attribute :viewingDirection, Types::Strict::String.enum('right-to-left', 'left-to-right').meta(omittable: true)
     end

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.31.0'
+    VERSION = '0.34.1'
   end
 end

data/openapi.yml

@@ -96,6 +96,7 @@ components:
     Access:
       description: Access metadata
       type: object
+      additionalProperties: false
       properties:
         access:
           description: Access level
@@ -107,8 +108,28 @@ components:
             - 'citation-only'
             - 'dark'
           default: 'dark'
+        download:
+          description: Download access level for a file
+          type: string
+          enum:
+            - 'world'
+            - 'stanford'
+            - 'location-based'
+            - 'none'
+          default: 'none'
+        readLocation:
+          description: If access is "location-based", which location should have access.
+          type: string
+          enum:
+            - 'spec'
+            - 'music'
+            - 'ars'
+            - 'art'
+            - 'hoover'
+            - 'm&m'
     Administrative:
       type: object
+      additionalProperties: false
       properties:
         hasAdminPolicy:
           $ref: '#/components/schemas/Druid'
@@ -121,8 +142,11 @@ components:
           description: Administrative or Internal project this resource is a part of
           example: Google Books
           type: string
+      required:
+        - hasAdminPolicy
     AdminPolicy:
       type: object
+      additionalProperties: false
       properties:
         type:
           type: string
@@ -140,13 +164,14 @@ components:
         description:
           $ref: '#/components/schemas/Description'
       required:
+        - administrative
         - externalIdentifier
         - label
         - type
         - version
-        - administrative
     AdminPolicyAdministrative:
       type: object
+      additionalProperties: false
       properties:
         defaultObjectRights:
           type: string
@@ -155,10 +180,13 @@ components:
           type: string
         hasAdminPolicy:
           type: string
+      required:
+        - hasAdminPolicy
     AppliesTo:
       description: Property model for indicating the parts, aspects, or versions of the resource to which a
         descriptive element is applicable.
       type: object
+      additionalProperties: false
       properties:
         appliesTo:
           type: array
@@ -166,6 +194,7 @@ components:
             $ref: "#/components/schemas/DescriptiveBasicValue"
     CatalogLink:
       type: object
+      additionalProperties: false
       required:
         - catalog
         - catalogRecordId
@@ -181,6 +210,7 @@ components:
     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
+      additionalProperties: false
       properties:
         type:
           description: The content type of the Collection. Selected from an established set of values.
@@ -216,6 +246,7 @@ components:
         - access
     CollectionIdentification:
       type: object
+      additionalProperties: false
       properties:
         catalogLinks:
           type: array
@@ -225,6 +256,7 @@ components:
       description: Property model for describing agents contributing in some way to
         the creation and history of the resource
       type: object
+      additionalProperties: false
       properties:
         name:
           description: Names associated with a contributor.
@@ -246,6 +278,7 @@ components:
     DescriptiveAdminMetadata:
       description: Information about this description of the resource.
       type: object
+      additionalProperties: false
       properties:
         contributor:
           type: array
@@ -266,6 +299,7 @@ components:
     DescriptiveBasicValue:
       description: Value model for descriptive elements without recursive properties.
       type: object
+      additionalProperties: false
       properties:
         value:
           description: String value of the descriptive element.
@@ -299,6 +333,7 @@ components:
     DescriptiveStructuredValue:
       description: Value model for descriptive elements structured as typed values.
       type: object
+      additionalProperties: false
       properties:
         structuredValue:
           type: array
@@ -307,12 +342,14 @@ components:
     DescriptiveValue:
       description: Default value model for descriptive elements.
       type: object
+      additionalProperties: false
       allOf:
         - $ref: "#/components/schemas/DescriptiveBasicValue"
         - $ref: "#/components/schemas/DescriptiveStructuredValue"
         - $ref: "#/components/schemas/AppliesTo"
     DescriptiveValueRequired:
       type: object
+      additionalProperties: false
       allOf:
         - $ref: "#/components/schemas/DescriptiveValue"
         - anyOf:
@@ -320,10 +357,11 @@ components:
               required:
                 - value
             - type: object
-            - required:
+              required:
                 - structuredValue
     Description:
       type: object
+      additionalProperties: false
       properties:
         title:
           description: Titles of the resource.
@@ -384,6 +422,7 @@ components:
     DRO:
       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
+      additionalProperties: false
       properties:
         type:
           description: The content type of the DRO. Selected from an established set of values.
@@ -426,13 +465,15 @@ components:
         geographic:
           $ref: '#/components/schemas/Geographic'
       required:
+        - access
+        - administrative
         - externalIdentifier
         - label
         - type
         - version
-        - access
     DROAccess:
       type: object
+      additionalProperties: false
       properties:
         access:
           type: string
@@ -447,15 +488,43 @@ components:
           description: The human readable copyright statement that applies
           example: Copyright World Trade Organization
           type: string
+        embargo:
+          $ref: '#/components/schemas/Embargo'
+        download:
+          description: >
+            Download access level. This is used in the transition from Fedora as
+            a way to set a default download level at registration that is copied
+            down to all the files.
+
+          type: string
+          enum:
+            - 'world'
+            - 'stanford'
+            - 'location-based'
+            - 'none'
+          default: 'none'
+        readLocation:
+          description: >
+            If access is "location-based", which location should have access.
+            This is used in the transition from Fedora as a way to set a default
+            readLocation at registration that is copied down to all the files.
+
+          type: string
+          enum:
+            - 'spec'
+            - 'music'
+            - 'ars'
+            - 'art'
+            - 'hoover'
+            - 'm&m'
         useAndReproductionStatement:
           description: The human readable use and reproduction statement that applies
           example: Property rights reside with the repository. Literary rights reside with the creators of the documents or their heirs. To obtain permission to publish or reproduce, please contact the Public Services Librarian of the Dept. of Special Collections (http://library.stanford.edu/spc).
           type: string
-        embargo:
-          $ref: '#/components/schemas/Embargo'
     DROStructural:
       description: Structural metadata
       type: object
+      additionalProperties: false
       properties:
         contains:
           description: Filesets that contain the digital representations (Files)
@@ -478,6 +547,7 @@ components:
       example: 'druid:bc123df4567'
     Embargo:
       type: object
+      additionalProperties: false
       properties:
         releaseDate:
           description: Date when the Collection is released from an embargo.
@@ -503,35 +573,39 @@ components:
     Event:
       description: Property model for describing events in the history of the resource.
       type: object
-      properties:
-        type:
-          description: Description of the event (creation, publication, etc.).
-          type: string
-        date:
-          description: Dates associated with the event.
-          type: array
-          items:
-            $ref: "#/components/schemas/DescriptiveValue"
-        contributor:
-          description: Contributors associated with the event.
-          type: array
-          items:
-            $ref: "#/components/schemas/Contributor"
-        location:
-          description: Locations associated with the event.
-          type: array
-          items:
-            $ref: "#/components/schemas/DescriptiveValue"
-        note:
-          description: Other information about the event.
-          type: array
-          items:
-            $ref: "#/components/schemas/DescriptiveValue"
+      additionalProperties: false
       allOf:
         - $ref: "#/components/schemas/DescriptiveStructuredValue"
+        - type: object
+          additionalProperties: false
+          properties:
+            type:
+              description: Description of the event (creation, publication, etc.).
+              type: string
+            date:
+              description: Dates associated with the event.
+              type: array
+              items:
+                $ref: "#/components/schemas/DescriptiveValue"
+            contributor:
+              description: Contributors associated with the event.
+              type: array
+              items:
+                $ref: "#/components/schemas/Contributor"
+            location:
+              description: Locations associated with the event.
+              type: array
+              items:
+                $ref: "#/components/schemas/DescriptiveValue"
+            note:
+              description: Other information about the event.
+              type: array
+              items:
+                $ref: "#/components/schemas/DescriptiveValue"
     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
+      additionalProperties: false
       properties:
         type:
           description: The content type of the File.
@@ -572,6 +646,7 @@ components:
       required:
         - externalIdentifier
         - label
+        - filename
         - type
         - version
         - access
@@ -579,6 +654,7 @@ components:
         - hasMessageDigests
     FileAdministrative:
       type: object
+      additionalProperties: false
       properties:
         sdrPreserve:
           type: boolean
@@ -592,6 +668,7 @@ components:
     FileSet:
       description: Relevant groupings of Files. Also called a File Grouping.
       type: object
+      additionalProperties: false
       properties:
         type:
           description: The content type of the Fileset.
@@ -616,6 +693,7 @@ components:
     FileSetStructural:
       description: Structural metadata
       type: object
+      additionalProperties: false
       properties:
         contains:
           type: array
@@ -624,6 +702,7 @@ components:
     Geographic:
       description: Geographic metadata
       type: object
+      additionalProperties: false
       properties:
         iso19139:
           description: Geographic ISO 19139 XML metadata
@@ -632,9 +711,17 @@ components:
         - iso19139
     Identification:
       type: object
+      additionalProperties: false
       properties:
         sourceId:
           type: string
+          description: >
+            Unique identifier in some other system. This is because a large proportion of what is deposited in SDR,
+            historically and currently, are representations of objects that are also represented in other systems.
+            For example, digitized paper and A/V collections have physical manifestations, and those physical objects are managed
+            in systems that have their own identifiers. Similarly, books have barcodes, archival materials have collection numbers
+            and physical locations, etc. The sourceId allows determining if an item has been deposited before and where to
+            look for the original item if you're looking at its SDR representation.
           example: 'sul:PC0170_s3_Fiesta_Bowl_2012-01-02_210609_2026'
         catalogLinks:
           type: array
@@ -643,6 +730,7 @@ components:
     MessageDigest:
       description: The output of the message digest algorithm.
       type: object
+      additionalProperties: false
       properties:
         type:
           description: The algorithm that was used
@@ -659,6 +747,7 @@ components:
     Presentation:
       description: Presentation data for the File.
       type: object
+      additionalProperties: false
       properties:
         height:
           description: Height in pixels
@@ -669,6 +758,7 @@ components:
     ReleaseTag:
       description: A tag that indicates the item or collection should be released.
       type: object
+      additionalProperties: false
       required:
         - release
       properties:
@@ -696,6 +786,7 @@ components:
     RequestAdminPolicy:
       description: Same as an AdminPolicy, but doesn't have an externalIdentifier as one will be created
       type: object
+      additionalProperties: false
       properties:
         type:
           type: string
@@ -711,13 +802,14 @@ components:
         description:
           $ref: '#/components/schemas/Description'
       required:
+        - administrative
         - label
         - type
         - version
-        - administrative
     RequestCollection:
       description: Same as a Collection, but doesn't have an externalIdentifier as one will be created
       type: object
+      additionalProperties: false
       properties:
         type:
           type: string
@@ -741,13 +833,15 @@ components:
         identification:
           $ref: '#/components/schemas/CollectionIdentification'
       required:
+        - access
+        - administrative
         - label
         - type
         - version
-        - access
     RequestDRO:
       description: A request to create a DRO.  This has the same general structure as a DRO but doesn't have externalIdentifier and doesn't require the access subschema. If no access subschema is provided, these values will be inherited from the AdminPolicy.
       type: object
+      additionalProperties: false
       properties:
         type:
           type: string
@@ -779,18 +873,21 @@ components:
         description:
           $ref: '#/components/schemas/Description'
         identification:
-          $ref: '#/components/schemas/Identification'
+          $ref: '#/components/schemas/RequestIdentification'
         structural:
           $ref: '#/components/schemas/RequestDROStructural'
         geographic:
           $ref: '#/components/schemas/Geographic'
       required:
+        - administrative
+        - identification
         - label
         - type
         - version
     RequestDROStructural:
       description: Structural metadata
       type: object
+      additionalProperties: false
       properties:
         contains:
           type: array
@@ -806,6 +903,7 @@ components:
           type: string
     RequestFile:
       type: object
+      additionalProperties: false
       properties:
         type:
           type: string
@@ -845,6 +943,7 @@ components:
         - hasMessageDigests
     RequestFileSet:
       type: object
+      additionalProperties: false
       properties:
         type:
           type: string
@@ -864,15 +963,43 @@ components:
     RequestFileSetStructural:
       description: Structural metadata
       type: object
+      additionalProperties: false
       properties:
         contains:
           type: array
           items:
             $ref: '#/components/schemas/RequestFile'
+    RequestIdentification:
+      description: Same as a Identification, but requires a sourceId.
+      type: object
+      additionalProperties: false
+      properties:
+        sourceId:
+          type: string
+          description: >
+            Unique identifier in some other system. This is because a large proportion of what is deposited in SDR,
+            historically and currently, are representations of objects that are also represented in other systems.
+            For example, digitized paper and A/V collections have physical manifestations, and those physical objects are managed
+            in systems that have their own identifiers. Similarly, books have barcodes, archival materials have collection numbers
+            and physical locations, etc. The sourceId allows determining if an item has been deposited before and where to
+            look for the original item if you're looking at its SDR representation.
+          example: 'sul:PC0170_s3_Fiesta_Bowl_2012-01-02_210609_2026'
+        catalogLinks:
+          type: array
+          items:
+            $ref: '#/components/schemas/CatalogLink'
+      required:
+        - sourceId
     Sequence:
       description: A sequence or ordering of resources within a Collection or Object.
       type: object
+      additionalProperties: false
       properties:
+        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
@@ -883,6 +1010,7 @@ components:
       description: Property model for indicating the vocabulary, authority, or other
         origin for a term, code, or identifier.
       type: object
+      additionalProperties: false
       properties:
         code:
           description: Code representing the value source.