cocina-models 0.45.0 → 0.48.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5009424cf5bd827da8766eb5e0ecee739931123bad8f233342280908b4dac436
-  data.tar.gz: '084f2ed351b54e1c792df48116bb55e51fd3e9d27921167aa80f1768b595f9ac'
+  metadata.gz: 7fa9efc7d9b5938ce148a3c66bce454d5f6ff3f1de439907b8b50b9170349f94
+  data.tar.gz: 0a00359d3fca6c9672d814b95a5bd20b25411090f8274d64cab791e3c5c17546
 SHA512:
-  metadata.gz: 3097db674f1c8da72a88296cda09ca06fc8c1dc1cfecdfa5fcd0d94e4585f017433e77a3f8e38495371dfb4c3c1dec6955f5380de3e7e81b9318abe16a326972
-  data.tar.gz: 571a4ca0471f75fe22d7f943f9c79f9db19a324f0aeef402d237aa8d5c00899ba4ff1407efe465b2470c3d9c382084058cb69d4093b3233470105fad2a1b530c
+  metadata.gz: 7525f4ce056ef73d07a3d674abdf9bcdf0eabe0ce1368b24714e8f41bdf255474727729cafc82aa4d36eb52397a3bfefa15d97512473fa0fd9d21d752726fa80
+  data.tar.gz: af24b2e5e06828819a9f9a9a3cea9b091b19a250121d2f14c1e95027e8a1ad68bb5dee53ff235aeb7d6107bb8bf195617f9cbe604d06d9f18657bd012ee32dd5

data/README.md

@@ -59,6 +59,7 @@ Once the above listed gems are updated all the following services that use cocin
 * sul-dlss/hydrus
 * sul-dlss/happy-heron
 * sul-dlss/infrastructure-integration-test
+* sul-dlss/dor_indexing_app
 
 ## Using this gem
 

data/lib/cocina/models/admin_policy_administrative.rb

@@ -5,6 +5,7 @@ module Cocina
     class AdminPolicyAdministrative < Struct
       attribute :defaultObjectRights, Types::Strict::String.default('<?xml version="1.0" encoding="UTF-8"?><rightsMetadata><access type="discover"><machine><world/></machine></access><access type="read"><machine><world/></machine></access><use><human type="useAndReproduction"/><human type="creativeCommons"/><machine type="creativeCommons" uri=""/><human type="openDataCommons"/><machine type="openDataCommons" uri=""/></use><copyright><human/></copyright></rightsMetadata>').meta(omittable: true)
       attribute :registrationWorkflow, Types::Strict::String.meta(omittable: true)
+      attribute :collectionsForRegistration, Types::Strict::Array.of(Types::Strict::String).meta(omittable: true)
       attribute :hasAdminPolicy, Types::Strict::String
     end
   end

data/lib/cocina/models/collection_identification.rb

@@ -3,6 +3,10 @@
 module Cocina
   module Models
     class CollectionIdentification < Struct
+      # 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
+      attribute :sourceId, Types::Strict::String.meta(omittable: true)
       attribute :catalogLinks, Types::Strict::Array.of(CatalogLink).meta(omittable: true)
     end
   end

data/lib/cocina/models/contributor.rb

@@ -11,6 +11,8 @@ module Cocina
       attribute :role, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       attribute :identifier, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      # URL or other pointer to the location of the contributor information.
+      attribute :valueAt, Types::Strict::String.meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/description.rb

@@ -18,6 +18,8 @@ module Cocina
       attribute :relatedResource, Types::Strict::Array.of(RelatedResource).meta(omittable: true)
       attribute :marcEncodedData, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       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

data/lib/cocina/models/descriptive_basic_value.rb

@@ -5,6 +5,7 @@ module Cocina
     class DescriptiveBasicValue < Struct
       attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       attribute :parallelValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :groupedValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       # String or integer value of the descriptive element.
       attribute :value, Types::Nominal::Any.meta(omittable: true)
       # Type of value provided by the descriptive element.
@@ -25,6 +26,8 @@ module Cocina
       attribute :qualifier, Types::Strict::String.meta(omittable: true)
       attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       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)
     end
   end
 end

data/lib/cocina/models/descriptive_grouped_value.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class DescriptiveGroupedValue < Struct
+      attribute :groupedValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/descriptive_value.rb

@@ -5,6 +5,7 @@ module Cocina
     class DescriptiveValue < Struct
       attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       attribute :parallelValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :groupedValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       # String or integer value of the descriptive element.
       attribute :value, Types::Nominal::Any.meta(omittable: true)
       # Type of value provided by the descriptive element.
@@ -25,6 +26,8 @@ module Cocina
       attribute :qualifier, Types::Strict::String.meta(omittable: true)
       attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       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).meta(omittable: true)
     end
   end

data/lib/cocina/models/language.rb

@@ -9,6 +9,7 @@ module Cocina
       # The preferred display label to use for the descriptive element in access systems.
       attribute :displayLabel, Types::Strict::String.meta(omittable: true)
       attribute :encoding, Standard.optional.meta(omittable: true)
+      attribute :groupedValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       attribute :parallelValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       # present for mapping to additional schemas in the future and for consistency but not otherwise used
@@ -23,6 +24,8 @@ module Cocina
       attribute :uri, Types::Strict::String.meta(omittable: true)
       # Value of the descriptive element.
       attribute :value, Types::Strict::String.meta(omittable: true)
+      # URL or other pointer to the location of the language information.
+      attribute :valueAt, Types::Strict::String.meta(omittable: true)
       attribute :valueLanguage, DescriptiveValueLanguage.optional.meta(omittable: true)
     end
   end

data/lib/cocina/models/related_resource.rb

@@ -25,6 +25,8 @@ module Cocina
       attribute :adminMetadata, DescriptiveAdminMetadata.optional.meta(omittable: true)
       # The version of the related resource.
       attribute :version, Types::Strict::String.meta(omittable: true)
+      # URL or other pointer to the location of the related resource information.
+      attribute :valueAt, Types::Strict::String.meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/title.rb

@@ -5,6 +5,7 @@ module Cocina
     class Title < Struct
       attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       attribute :parallelValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :groupedValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       # String or integer value of the descriptive element.
       attribute :value, Types::Nominal::Any.meta(omittable: true)
       # Type of value provided by the descriptive element.
@@ -25,6 +26,8 @@ module Cocina
       attribute :qualifier, Types::Strict::String.meta(omittable: true)
       attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       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).meta(omittable: true)
     end
   end

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.45.0'
+    VERSION = '0.48.0'
   end
 end

data/openapi.yml

@@ -169,6 +169,11 @@ components:
           default: <?xml version="1.0" encoding="UTF-8"?><rightsMetadata><access type="discover"><machine><world/></machine></access><access type="read"><machine><world/></machine></access><use><human type="useAndReproduction"/><human type="creativeCommons"/><machine type="creativeCommons" uri=""/><human type="openDataCommons"/><machine type="openDataCommons" uri=""/></use><copyright><human/></copyright></rightsMetadata>
         registrationWorkflow:
           type: string
+        collectionsForRegistration:
+          description: When you register an item with this admin policy, these are the collections that are available.
+          type: array
+          items:
+            type: string
         hasAdminPolicy:
           type: string
       required:
@@ -239,6 +244,8 @@ components:
       type: object
       additionalProperties: false
       properties:
+        sourceId:
+          $ref: '#/components/schemas/SourceId'
         catalogLinks:
           type: array
           items:
@@ -277,6 +284,9 @@ components:
           type: array
           items:
             $ref: "#/components/schemas/DescriptiveValue"
+        valueAt:
+          description: URL or other pointer to the location of the contributor information.
+          type: string
     Description:
       type: object
       additionalProperties: false
@@ -348,6 +358,9 @@ components:
             $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
     DescriptiveAccessMetadata:
@@ -424,13 +437,15 @@ components:
     DescriptiveBasicValue:
       description: Basic value model for descriptive elements.
       type: object
-      # additionalProperties breaks the validator, unclear as to why.
+      # additionalProperties breaks the validator for allOf, unclear as to why.
       # additionalProperties: false
       allOf:
         - $ref: "#/components/schemas/DescriptiveStructuredValue"
         - $ref: "#/components/schemas/DescriptiveParallelValue"
+        - $ref: "#/components/schemas/DescriptiveGroupedValue"
         - type: object
-          additionalProperties: false
+          # additionalProperties breaks the validator for DescriptiveValue, unclear as to why.
+          # additionalProperties: false
           properties:
             value:
               description: String or integer value of the descriptive element.
@@ -480,6 +495,9 @@ components:
                 $ref: "#/components/schemas/DescriptiveValue"
             valueLanguage:
               $ref: "#/components/schemas/DescriptiveValueLanguage"
+            valueAt:
+              description: URL or other pointer to the location of the value of the descriptive element.
+              type: string
     DescriptiveGeographicMetadata:
       description: Value model for mods geographic extension metadata
       type: object
@@ -494,6 +512,15 @@ components:
           type: array
           items:
             $ref: "#/components/schemas/DescriptiveValue"
+    DescriptiveGroupedValue:
+      description: Value model for a set of descriptive elements grouped together in an unstructured way.
+      type: object
+      additionalProperties: false
+      properties:
+        groupedValue:
+          type: array
+          items:
+            $ref: "#/components/schemas/DescriptiveValue"
     DescriptiveParallelValue:
       description: Value model for multiple representations of the same information (e.g. in different languages).
       type: object
@@ -546,6 +573,12 @@ components:
             - type: object
               required:
                 - parallelValue
+            - type: object
+              required:
+                - groupedValue
+            - type: object
+              required:
+                - valueAt
     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
@@ -918,6 +951,11 @@ components:
         encoding:
           # description: present for mapping to additional schemas in the future and for consistency but not otherwise used
           $ref: "#/components/schemas/Standard"
+        groupedValue:
+          description: present for mapping to additional schemas in the future and for consistency but not otherwise used
+          type: array
+          items:
+            $ref: "#/components/schemas/DescriptiveValue"
         note:
           description: present for mapping to additional schemas in the future and for consistency but not otherwise used
           type: array
@@ -957,6 +995,9 @@ components:
         value:
           description: Value of the descriptive element.
           type: string
+        valueAt:
+          description: URL or other pointer to the location of the language information.
+          type: string
         valueLanguage:
           # description: present for mapping to additional schemas in the future and for consistency but not otherwise used
           $ref: "#/components/schemas/DescriptiveValueLanguage"
@@ -1064,6 +1105,9 @@ components:
         version:
           description: The version of the related resource.
           type: string
+        valueAt:
+          description: URL or other pointer to the location of the related resource information.
+          type: string
     ReleaseTag:
       description: A tag that indicates the item or collection should be released.
       type: object

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.45.0
+  version: 0.48.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-20 00:00:00.000000000 Z
+date: 2021-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -268,6 +268,7 @@ files:
 - lib/cocina/models/descriptive_admin_metadata.rb
 - lib/cocina/models/descriptive_basic_value.rb
 - lib/cocina/models/descriptive_geographic_metadata.rb
+- lib/cocina/models/descriptive_grouped_value.rb
 - lib/cocina/models/descriptive_parallel_value.rb
 - lib/cocina/models/descriptive_structured_value.rb
 - lib/cocina/models/descriptive_value.rb
@@ -325,7 +326,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Data models for the SDR