cocina-models 0.63.0 → 0.65.1

data/lib/cocina/models/request_collection.rb

@@ -11,12 +11,15 @@ module Cocina
                'http://cocina.sul.stanford.edu/models/exhibit.jsonld',
                'http://cocina.sul.stanford.edu/models/series.jsonld'].freeze
 
+      # The version of Cocina with which this object conforms.
+      # example: 1.2.3
+      attribute :cocinaVersion, Types::Strict::String.default(Cocina::Models::VERSION)
       attribute :type, Types::Strict::String.enum(*RequestCollection::TYPES)
       attribute :label, Types::Strict::String
       attribute :version, Types::Strict::Integer
       attribute(:access, CollectionAccess.default { CollectionAccess.new })
       attribute(:administrative, Administrative.default { Administrative.new })
-      attribute :description, Description.optional.meta(omittable: true)
+      attribute :description, RequestDescription.optional.meta(omittable: true)
       attribute :identification, CollectionIdentification.optional.meta(omittable: true)
 
       def self.new(attributes = default_attributes, safe = false, validate = true, &block)

data/lib/cocina/models/request_description.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class RequestDescription < Struct
+      attribute :title, Types::Strict::Array.of(Title).default([].freeze)
+      attribute :contributor, Types::Strict::Array.of(Contributor).default([].freeze)
+      attribute :event, Types::Strict::Array.of(Event).default([].freeze)
+      attribute :form, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      attribute :geographic, Types::Strict::Array.of(DescriptiveGeographicMetadata).default([].freeze)
+      attribute :language, Types::Strict::Array.of(Language).default([].freeze)
+      attribute :note, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      attribute :identifier, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      attribute :subject, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      attribute :access, DescriptiveAccessMetadata.optional.meta(omittable: true)
+      attribute :relatedResource, Types::Strict::Array.of(RelatedResource).default([].freeze)
+      attribute :marcEncodedData, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      attribute :adminMetadata, DescriptiveAdminMetadata.optional.meta(omittable: true)
+      # URL or other pointer to the location of the resource description.
+      attribute :valueAt, Types::Strict::String.meta(omittable: true)
+
+      def self.new(attributes = default_attributes, safe = false, validate = true, &block)
+        Validator.validate(self, attributes.with_indifferent_access) if validate && name
+        super(attributes, safe, &block)
+      end
+    end
+  end
+end

data/lib/cocina/models/request_dro.rb

@@ -21,12 +21,15 @@ module Cocina
                'http://cocina.sul.stanford.edu/models/webarchive-binary.jsonld',
                'http://cocina.sul.stanford.edu/models/webarchive-seed.jsonld'].freeze
 
+      # The version of Cocina with which this object conforms.
+      # example: 1.2.3
+      attribute :cocinaVersion, Types::Strict::String.default(Cocina::Models::VERSION)
       attribute :type, Types::Strict::String.enum(*RequestDRO::TYPES)
       attribute :label, Types::Strict::String
       attribute :version, Types::Strict::Integer
       attribute :access, DROAccess.optional.meta(omittable: true)
       attribute(:administrative, Administrative.default { Administrative.new })
-      attribute :description, Description.optional.meta(omittable: true)
+      attribute :description, RequestDescription.optional.meta(omittable: true)
       attribute(:identification, RequestIdentification.default { RequestIdentification.new })
       attribute :structural, RequestDROStructural.optional.meta(omittable: true)
       attribute :geographic, Geographic.optional.meta(omittable: true)

data/lib/cocina/models/request_dro_structural.rb

@@ -3,10 +3,9 @@
 module Cocina
   module Models
     class RequestDROStructural < Struct
-      attribute :contains, Types::Strict::Array.of(RequestFileSet).default([])
-      attribute :hasMemberOrders, Types::Strict::Array.of(Sequence).default([])
-      attribute :isMemberOf, Types::Strict::Array.of(Druid).default([])
-      attribute :hasAgreement, Types::Strict::String.meta(omittable: true)
+      attribute :contains, Types::Strict::Array.of(RequestFileSet).default([].freeze)
+      attribute :hasMemberOrders, Types::Strict::Array.of(Sequence).default([].freeze)
+      attribute :isMemberOf, Types::Strict::Array.of(Druid).default([].freeze)
     end
   end
 end

data/lib/cocina/models/request_file.rb

@@ -15,7 +15,7 @@ module Cocina
       attribute :hasMimeType, Types::Strict::String.meta(omittable: true)
       attribute :externalIdentifier, Types::Strict::String.meta(omittable: true)
       attribute :use, Types::Strict::String.meta(omittable: true)
-      attribute :hasMessageDigests, Types::Strict::Array.of(MessageDigest).default([])
+      attribute :hasMessageDigests, Types::Strict::Array.of(MessageDigest).default([].freeze)
       attribute(:access, FileAccess.default { FileAccess.new })
       attribute(:administrative, FileAdministrative.default { FileAdministrative.new })
       attribute :presentation, Presentation.optional.meta(omittable: true)

data/lib/cocina/models/request_file_set_structural.rb

@@ -3,7 +3,7 @@
 module Cocina
   module Models
     class RequestFileSetStructural < Struct
-      attribute :contains, Types::Strict::Array.of(RequestFile).default([])
+      attribute :contains, Types::Strict::Array.of(RequestFile).default([].freeze)
     end
   end
 end

data/lib/cocina/models/request_identification.rb

@@ -5,7 +5,7 @@ module Cocina
     class RequestIdentification < Struct
       # A barcode
       attribute :barcode, Types::Nominal::Any.meta(omittable: true)
-      attribute :catalogLinks, Types::Strict::Array.of(CatalogLink).default([])
+      attribute :catalogLinks, Types::Strict::Array.of(CatalogLink).default([].freeze)
       # 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. The format is: "namespace:identifier"
 
       # example: sul:PC0170_s3_Fiesta_Bowl_2012-01-02_210609_2026

data/lib/cocina/models/sequence.rb

@@ -3,7 +3,7 @@
 module Cocina
   module Models
     class Sequence < Struct
-      attribute :members, Types::Strict::Array.of(Types::Strict::String).default([])
+      attribute :members, Types::Strict::Array.of(Types::Strict::String).default([].freeze)
       # 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/source.rb

@@ -9,7 +9,7 @@ module Cocina
       attribute :uri, Types::Strict::String.meta(omittable: true)
       # String describing the value source.
       attribute :value, Types::Strict::String.meta(omittable: true)
-      attribute :note, Types::Strict::Array.of(DescriptiveValue).default([])
+      attribute :note, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
       # The version of the value source.
       attribute :version, Types::Strict::String.meta(omittable: true)
     end

data/lib/cocina/models/standard.rb

@@ -9,7 +9,7 @@ module Cocina
       attribute :uri, Types::Strict::String.meta(omittable: true)
       # String describing the standard or encoding.
       attribute :value, Types::Strict::String.meta(omittable: true)
-      attribute :note, Types::Strict::Array.of(DescriptiveValue).default([])
+      attribute :note, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
       # The version of the standard or encoding.
       attribute :version, Types::Strict::String.meta(omittable: true)
       attribute :source, Source.optional.meta(omittable: true)

data/lib/cocina/models/title.rb

@@ -3,9 +3,9 @@
 module Cocina
   module Models
     class Title < Struct
-      attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).default([])
-      attribute :parallelValue, Types::Strict::Array.of(DescriptiveValue).default([])
-      attribute :groupedValue, Types::Strict::Array.of(DescriptiveValue).default([])
+      attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      attribute :parallelValue, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      attribute :groupedValue, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
       # String or integer value of the descriptive element.
       attribute :value, Types::Nominal::Any.meta(omittable: true)
       # Type of value provided by the descriptive element.
@@ -18,17 +18,17 @@ module Cocina
       attribute :uri, Types::Strict::String.meta(omittable: true)
       attribute :standard, Standard.optional.meta(omittable: true)
       attribute :encoding, Standard.optional.meta(omittable: true)
-      attribute :identifier, Types::Strict::Array.of(DescriptiveValue).default([])
+      attribute :identifier, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
       attribute :source, Source.optional.meta(omittable: true)
       # The preferred display label to use for the descriptive element in access systems.
       attribute :displayLabel, Types::Strict::String.meta(omittable: true)
       # A term providing information about the circumstances of the statement (e.g., approximate dates).
       attribute :qualifier, Types::Strict::String.meta(omittable: true)
-      attribute :note, Types::Strict::Array.of(DescriptiveValue).default([])
+      attribute :note, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
       attribute :valueLanguage, DescriptiveValueLanguage.optional.meta(omittable: true)
       # URL or other pointer to the location of the value of the descriptive element.
       attribute :valueAt, Types::Strict::String.meta(omittable: true)
-      attribute :appliesTo, Types::Strict::Array.of(DescriptiveBasicValue).default([])
+      attribute :appliesTo, Types::Strict::Array.of(DescriptiveBasicValue).default([].freeze)
     end
   end
 end

data/lib/cocina/models/validator.rb

@@ -7,12 +7,32 @@ module Cocina
       def self.validate(clazz, attributes)
         method_name = clazz.name.split('::').last
         request_operation = root.request_operation(:post, "/validate/#{method_name}")
+
         # JSON.parse forces serialization of objects like DateTime.
-        request_operation.validate_request_body('application/json', JSON.parse(attributes.to_json))
+        json_attributes = JSON.parse(attributes.to_json)
+        # Inject cocinaVersion if needed and not present.
+        if operation_has_cocina_version?(request_operation) && !json_attributes.include?('cocinaVersion')
+          json_attributes['cocinaVersion'] = Cocina::Models::VERSION
+        end
+
+        request_operation.validate_request_body('application/json', json_attributes)
       rescue OpenAPIParser::OpenAPIError => e
         raise ValidationError, e.message
       end
 
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def self.operation_has_cocina_version?(request_operation)
+        schema = request_operation.operation_object.request_body.content['application/json'].schema
+        all_of_properties = Array(schema.all_of&.flat_map { |all_of| all_of.properties&.keys }).compact
+        one_of_properties = Array(schema.one_of&.flat_map { |one_of| one_of.properties&.keys }).compact
+        properties = Array(schema.properties&.keys)
+        (properties + all_of_properties + one_of_properties).include?('cocinaVersion')
+      end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/CyclomaticComplexity
+      private_class_method :operation_has_cocina_version?
+
       # rubocop:disable Style/ClassVars
       def self.root
         @@root ||= OpenAPIParser.parse(YAML.load_file(openapi_path))

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.63.0'
+    VERSION = '0.65.1'
   end
 end

data/openapi.yml

@@ -91,6 +91,18 @@ paths:
       responses:
         '200':
           description: noop
+  /validate/RequestDescription:
+    post:
+      summary: Validate a Request Description
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/RequestDescription'
+      responses:
+        '200':
+          description: noop
 components:
   schemas:
     Access:
@@ -172,6 +184,8 @@ components:
       type: object
       additionalProperties: false
       properties:
+        cocinaVersion:
+          $ref: '#/components/schemas/CocinaVersion'
         type:
           type: string
           enum:
@@ -187,6 +201,7 @@ components:
         description:
           $ref: '#/components/schemas/Description'
       required:
+        - cocinaVersion
         - administrative
         - externalIdentifier
         - label
@@ -220,7 +235,7 @@ components:
             type: string
         hasAdminPolicy:
           $ref: '#/components/schemas/Druid'
-        referencesAgreement:
+        hasAgreement:
           $ref: '#/components/schemas/Druid'
         roles:
           description: The access roles conferred by this AdminPolicy (used by Argo)
@@ -229,6 +244,7 @@ components:
             $ref: '#/components/schemas/AccessRole'
       required:
         - hasAdminPolicy
+        - hasAgreement
     AdminPolicyDefaultAccess:
       description: 'Provides the default access settings for an AdminPolicy. This is almost the same as DROAccess, but it provides no defaults and has no embargo.'
       type: object
@@ -360,11 +376,18 @@ components:
       required:
         - access
         - download
+    CocinaVersion:
+      description: The version of Cocina with which this object conforms.
+      type: string
+      pattern: '^\d+\.\d+\.\d+$'
+      example: '1.2.3'
     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:
+        cocinaVersion:
+            $ref: '#/components/schemas/CocinaVersion'
         type:
           description: The content type of the Collection. Selected from an established set of values.
           type: string
@@ -391,6 +414,7 @@ components:
         identification:
           $ref: '#/components/schemas/CollectionIdentification'
       required:
+        - cocinaVersion
         - externalIdentifier
         - label
         - type
@@ -529,77 +553,15 @@ components:
     Description:
       type: object
       additionalProperties: false
-      properties:
-        title:
-          description: Titles of the resource.
-          type: array
-          minItems: 1
-          items:
-            $ref: "#/components/schemas/Title"
-        contributor:
-          description: Agents contributing in some way to the creation and history of the
-            resource.
-          type: array
-          items:
-            $ref: "#/components/schemas/Contributor"
-        event:
-          description: Events in the history of the resource.
-          type: array
-          items:
-            $ref: "#/components/schemas/Event"
-        form:
-          description: Characteristics of the resource's physical, digital, and intellectual
-            form and genre, and of its process of creation.
-          type: array
-          items:
-            $ref: "#/components/schemas/DescriptiveValue"
-        geographic:
-          description: Geographic description for items with coordinates or bounding boxes.
-          type: array
-          items:
-            $ref: "#/components/schemas/DescriptiveGeographicMetadata"
-        language:
-          description: Languages, scripts, symbolic systems, and notations used in all or
-            part of a resource.
-          type: array
-          items:
-            $ref: "#/components/schemas/Language"
-        note:
-          description: Additional information relevant to a resource.
-          type: array
-          items:
-            $ref: "#/components/schemas/DescriptiveValue"
-        identifier:
-          description: Identifiers and URIs associated with the resource.
-          type: array
-          items:
-            $ref: "#/components/schemas/DescriptiveValue"
-        subject:
-          description: Terms associated with the intellectual content of the resource.
-          type: array
-          items:
-            $ref: "#/components/schemas/DescriptiveValue"
-        purl:
-          $ref: "#/components/schemas/Purl"
-        access:
-          $ref: "#/components/schemas/DescriptiveAccessMetadata"
-        relatedResource:
-          description: Other resources associated with the described resource.
-          type: array
-          items:
-            $ref: "#/components/schemas/RelatedResource"
-        marcEncodedData:
-          description: Data about the resource represented in MARC fixed fields and codes.
-          type: array
-          items:
-            $ref: "#/components/schemas/DescriptiveValue"
-        adminMetadata:
-          $ref: "#/components/schemas/DescriptiveAdminMetadata"
-        valueAt:
-          description: URL or other pointer to the location of the resource description.
-          type: string
-      required:
-        - title
+      allOf:
+        - $ref: "#/components/schemas/RequestDescription"
+        - type: object
+          additionalProperties: false
+          properties:
+            purl:
+              $ref: "#/components/schemas/Purl"
+          required:
+            - purl
     DescriptiveAccessMetadata:
       description: Information about how to access digital and physical versions of the object.
       type: object
@@ -886,6 +848,8 @@ components:
       type: object
       additionalProperties: false
       properties:
+        cocinaVersion:
+          $ref: '#/components/schemas/CocinaVersion'
         type:
           description: The content type of the DRO. Selected from an established set of values.
           type: string
@@ -926,6 +890,7 @@ components:
         geographic:
           $ref: '#/components/schemas/Geographic'
       required:
+        - cocinaVersion
         - access
         - administrative
         - externalIdentifier
@@ -953,6 +918,7 @@ components:
             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
+              nullable: true
               enum:
                 - 'https://www.gnu.org/licenses/agpl.txt'
                 - 'https://www.apache.org/licenses/LICENSE-2.0'
@@ -1004,9 +970,6 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/Druid'
-        hasAgreement:
-          description: Agreement that covers the deposit of the DRO into SDR.
-          type: string
     Druid:
       type: string
       pattern: '^druid:[b-df-hjkmnp-tv-z]{2}[0-9]{3}[b-df-hjkmnp-tv-z]{2}[0-9]{4}$'
@@ -1508,6 +1471,8 @@ components:
       type: object
       additionalProperties: false
       properties:
+        cocinaVersion:
+          $ref: '#/components/schemas/CocinaVersion'
         type:
           type: string
           enum:
@@ -1519,8 +1484,9 @@ components:
         administrative:
           $ref: '#/components/schemas/AdminPolicyAdministrative'
         description:
-          $ref: '#/components/schemas/Description'
+          $ref: '#/components/schemas/RequestDescription'
       required:
+        - cocinaVersion
         - administrative
         - label
         - type
@@ -1530,6 +1496,8 @@ components:
       type: object
       additionalProperties: false
       properties:
+        cocinaVersion:
+          $ref: '#/components/schemas/CocinaVersion'
         type:
           type: string
           enum:
@@ -1547,20 +1515,96 @@ components:
         administrative:
           $ref: '#/components/schemas/Administrative'
         description:
-          $ref: '#/components/schemas/Description'
+          $ref: '#/components/schemas/RequestDescription'
         identification:
           $ref: '#/components/schemas/CollectionIdentification'
       required:
+        - cocinaVersion
         - access
         - administrative
         - label
         - type
         - version
+    RequestDescription:
+      description: Description that is included in a request to create a DRO. This is the same as a Description, except excludes PURL.
+      type: object
+      additionalProperties: false
+      properties:
+        title:
+          description: Titles of the resource.
+          type: array
+          minItems: 1
+          items:
+            $ref: "#/components/schemas/Title"
+        contributor:
+          description: Agents contributing in some way to the creation and history of the
+            resource.
+          type: array
+          items:
+            $ref: "#/components/schemas/Contributor"
+        event:
+          description: Events in the history of the resource.
+          type: array
+          items:
+            $ref: "#/components/schemas/Event"
+        form:
+          description: Characteristics of the resource's physical, digital, and intellectual
+            form and genre, and of its process of creation.
+          type: array
+          items:
+            $ref: "#/components/schemas/DescriptiveValue"
+        geographic:
+          description: Geographic description for items with coordinates or bounding boxes.
+          type: array
+          items:
+            $ref: "#/components/schemas/DescriptiveGeographicMetadata"
+        language:
+          description: Languages, scripts, symbolic systems, and notations used in all or
+            part of a resource.
+          type: array
+          items:
+            $ref: "#/components/schemas/Language"
+        note:
+          description: Additional information relevant to a resource.
+          type: array
+          items:
+            $ref: "#/components/schemas/DescriptiveValue"
+        identifier:
+          description: Identifiers and URIs associated with the resource.
+          type: array
+          items:
+            $ref: "#/components/schemas/DescriptiveValue"
+        subject:
+          description: Terms associated with the intellectual content of the resource.
+          type: array
+          items:
+            $ref: "#/components/schemas/DescriptiveValue"
+        access:
+          $ref: "#/components/schemas/DescriptiveAccessMetadata"
+        relatedResource:
+          description: Other resources associated with the described resource.
+          type: array
+          items:
+            $ref: "#/components/schemas/RelatedResource"
+        marcEncodedData:
+          description: Data about the resource represented in MARC fixed fields and codes.
+          type: array
+          items:
+            $ref: "#/components/schemas/DescriptiveValue"
+        adminMetadata:
+          $ref: "#/components/schemas/DescriptiveAdminMetadata"
+        valueAt:
+          description: URL or other pointer to the location of the resource description.
+          type: string
+      required:
+        - title
     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:
+        cocinaVersion:
+          $ref: '#/components/schemas/CocinaVersion'
         type:
           type: string
           enum:
@@ -1588,7 +1632,7 @@ components:
         administrative:
           $ref: '#/components/schemas/Administrative'
         description:
-          $ref: '#/components/schemas/Description'
+          $ref: '#/components/schemas/RequestDescription'
         identification:
           $ref: '#/components/schemas/RequestIdentification'
         structural:
@@ -1596,6 +1640,7 @@ components:
         geographic:
           $ref: '#/components/schemas/Geographic'
       required:
+        - cocinaVersion
         - administrative
         - identification
         - label
@@ -1619,8 +1664,6 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/Druid'
-        hasAgreement:
-          type: string
     RequestFile:
       type: object
       additionalProperties: false
@@ -1801,6 +1844,7 @@ components:
     StandardBarcode:
       description: The standard barcode associated with a DRO object, prefixed with 36105
       type: string
+      nullable: true
       pattern: '^36105[0-9]{9}$'
       example: '36105010362304'
     Title:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.63.0
+  version: 0.65.1
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-19 00:00:00.000000000 Z
+date: 2022-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -280,6 +280,7 @@ files:
 - lib/cocina/models/catkey_barcode.rb
 - lib/cocina/models/checkable.rb
 - lib/cocina/models/citation_only_access.rb
+- lib/cocina/models/cocina_version.rb
 - lib/cocina/models/collection.rb
 - lib/cocina/models/collection_access.rb
 - lib/cocina/models/collection_identification.rb
@@ -323,6 +324,7 @@ files:
 - lib/cocina/models/release_tag.rb
 - lib/cocina/models/request_admin_policy.rb
 - lib/cocina/models/request_collection.rb
+- lib/cocina/models/request_description.rb
 - lib/cocina/models/request_dro.rb
 - lib/cocina/models/request_dro_structural.rb
 - lib/cocina/models/request_file.rb
@@ -360,7 +362,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.4
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Data models for the SDR