cocina-models 0.47.2 → 0.52.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf7d1d0d676c42b4331df2079f9b8cdede0bc8b92c85478700dadc15ba972d92
-  data.tar.gz: df0756d9ab7cc3dd3b999c0427a18859df2470476069a347468a4805bf8f88b8
+  metadata.gz: 2a9f53ca8dbbb3649b0dad155b0ad42fa6901f3c9b7a7082ef1571197b006b6e
+  data.tar.gz: 806294c0697f580c59beb6d8ced0e7b738c843576621c4c60ffb29632305e09b
 SHA512:
-  metadata.gz: ebd2278320311858eed8ee824f64336f2bade54bbb711de95e36cb2148f94307585b530ce770d4626fa75cc09285b563b3bc9583bd322e3782b66a5417eaef06
-  data.tar.gz: 724f8d92f5978f2a395b954dc4c7004a85f4198f43595244a900e7638b6860a0270b03d766bc6a61fb2b0d596cdbc2fc0a15b9dab667ca61b4fff5ca8273d0ec
+  metadata.gz: 8047d6f2a4d16f0c8269440d3ba6db3e616c4cf93c1a7071d62e70c40614f60740f724c03351d579f009b0957e0a658f5bf6a10ef5f256e00621e615f31991c0
+  data.tar.gz: ebeb2ef783b0ada2f5e23dc181a28ed07cf03be4262917cab39c163179314bf35c255c656d65d02c7cc6b05c7a680789a7d8ec2bcf29ce7c0cd46290417fd76a

data/lib/cocina/models/access_role.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class AccessRole < Struct
+      # Name of role
+      attribute :name, Types::Strict::String.enum('sdr-administrator', 'sdr-viewer', 'dor-apo-manager', 'hydrus-collection-creator', 'hydrus-collection-manager', 'hydrus-collection-depositor', 'hydrus-collection-item-depositor', 'hydrus-collection-reviewer', 'hydrus-collection-viewer')
+      attribute :members, Types::Strict::Array.of(AccessRoleMember).default([].freeze)
+    end
+  end
+end

data/lib/cocina/models/access_role_member.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class AccessRoleMember < Struct
+      include Checkable
+
+      TYPES = %w[sunetid
+                 workgroup].freeze
+
+      # Name of role
+      attribute :type, Types::Strict::String.enum(*AccessRoleMember::TYPES)
+      attribute :identifier, Types::Strict::String
+    end
+  end
+end

data/lib/cocina/models/admin_policy_administrative.rb

@@ -4,7 +4,12 @@ module Cocina
   module Models
     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 :registrationWorkflow, Types::Strict::Array.of(Types::Strict::String).meta(omittable: true)
+      # An additional workflow to start for objects managed by this admin policy once the end-accession workflow step is complete
+      # example: wasCrawlPreassemblyWF
+      attribute :disseminationWorkflow, Types::Strict::String.meta(omittable: true)
+      attribute :collectionsForRegistration, Types::Strict::Array.of(Types::Strict::String).meta(omittable: true)
+      attribute :roles, Types::Strict::Array.of(AccessRole).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/descriptive_parallel_event.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class DescriptiveParallelEvent < Struct
+      # Code representing the standard or encoding.
+      attribute :code, Types::Strict::String.meta(omittable: true)
+      # URI for the standard or encoding.
+      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).meta(omittable: true)
+      # The version of the standard or encoding.
+      attribute :version, Types::Strict::String.meta(omittable: true)
+      attribute :source, Source.optional.meta(omittable: true)
+      attribute :valueScript, Standard.optional.meta(omittable: true)
+      attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      # Description of the event (creation, publication, etc.).
+      attribute :type, Types::Strict::String.meta(omittable: true)
+      # The preferred display label to use for the event in access systems.
+      attribute :displayLabel, Types::Strict::String.meta(omittable: true)
+      attribute :date, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :contributor, Types::Strict::Array.of(Contributor).meta(omittable: true)
+      attribute :location, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :identifier, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/event.rb

@@ -4,6 +4,17 @@ module Cocina
   module Models
     class Event < Struct
       attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      # Code representing the standard or encoding.
+      attribute :code, Types::Strict::String.meta(omittable: true)
+      # URI for the standard or encoding.
+      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).meta(omittable: true)
+      # The version of the standard or encoding.
+      attribute :version, Types::Strict::String.meta(omittable: true)
+      attribute :source, Source.optional.meta(omittable: true)
+      attribute :valueScript, Standard.optional.meta(omittable: true)
       # Description of the event (creation, publication, etc.).
       attribute :type, Types::Strict::String.meta(omittable: true)
       # The preferred display label to use for the event in access systems.
@@ -12,7 +23,7 @@ module Cocina
       attribute :contributor, Types::Strict::Array.of(Contributor).meta(omittable: true)
       attribute :location, 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)
+      attribute :parallelEvent, Types::Strict::Array.of(DescriptiveParallelEvent).meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/validator.rb

@@ -7,7 +7,8 @@ module Cocina
       def self.validate(clazz, attributes)
         method_name = clazz.name.split('::').last
         request_operation = root.request_operation(:post, "/validate/#{method_name}")
-        request_operation.validate_request_body('application/json', attributes)
+        # JSON.parse forces serialization of objects like DateTime.
+        request_operation.validate_request_body('application/json', JSON.parse(attributes.to_json))
       rescue OpenAPIParser::OpenAPIError => e
         raise ValidationError, e.message
       end

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.47.2'
+    VERSION = '0.52.0'
   end
 end

data/openapi.yml

@@ -118,6 +118,48 @@ components:
             - 'art'
             - 'hoover'
             - 'm&m'
+    AccessRole:
+      description: Access role conferred by an AdminPolicy to objects within it. (used by Argo)
+      type: object
+      additionalProperties: false
+      properties:
+        name:
+          description: Name of role
+          type: string
+          enum:
+            - 'sdr-administrator'
+            - 'sdr-viewer'
+            - 'dor-apo-manager'
+            - 'hydrus-collection-creator'
+            - 'hydrus-collection-manager'
+            - 'hydrus-collection-depositor'
+            - 'hydrus-collection-item-depositor'
+            - 'hydrus-collection-reviewer'
+            - 'hydrus-collection-viewer'
+        members:
+          description: The users and groups that are members of the role
+          type: array
+          items:
+            $ref: '#/components/schemas/AccessRoleMember'
+      required:
+        - members
+        - name
+    AccessRoleMember:
+      description: Represents a user or group that is a member of an AccessRole
+      type: object
+      additionalProperties: false
+      properties:
+        type:
+          description: Name of role
+          type: string
+          enum:
+            - 'sunetid'
+            - 'workgroup'
+        identifier:
+          type: string
+      required:
+        - identifier
+        - type
     Administrative:
       type: object
       additionalProperties: false
@@ -161,6 +203,7 @@ components:
         - type
         - version
     AdminPolicyAdministrative:
+      description: Administrative properties for an AdminPolicy
       type: object
       additionalProperties: false
       properties:
@@ -168,7 +211,24 @@ components:
           type: 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>
         registrationWorkflow:
+          description: When you register an item with this admin policy, these are the workflows that are available.
+          type: array
+          items:
+            type: string
+        disseminationWorkflow:
+          description: An additional workflow to start for objects managed by this admin policy once the end-accession workflow step is complete
+          example: wasCrawlPreassemblyWF
           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
+        roles:
+          description: The access roles conferred by this AdminPolicy (used by Argo)
+          type: array
+          items:
+            $ref: '#/components/schemas/AccessRole'
         hasAdminPolicy:
           type: string
       required:
@@ -239,6 +299,8 @@ components:
       type: object
       additionalProperties: false
       properties:
+        sourceId:
+          $ref: '#/components/schemas/SourceId'
         catalogLinks:
           type: array
           items:
@@ -514,6 +576,47 @@ components:
           type: array
           items:
             $ref: "#/components/schemas/DescriptiveValue"
+    DescriptiveParallelEvent:
+      description: Value model for multiple representations of information about the same event (e.g. in different languages).
+      type: object
+      additionalProperties: false
+      allOf:
+        - $ref: "#/components/schemas/DescriptiveValueLanguage"
+        - $ref: "#/components/schemas/DescriptiveStructuredValue"
+        - type: object
+          additionalProperties: false
+          properties:
+            type:
+              description: Description of the event (creation, publication, etc.).
+              type: string
+            displayLabel:
+              description: The preferred display label to use for the event in access systems.
+              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"
+            identifier:
+              description: Identifiers and URIs 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"
     DescriptiveParallelValue:
       description: Value model for multiple representations of the same information (e.g. in different languages).
       type: object
@@ -736,6 +839,7 @@ components:
       additionalProperties: false
       allOf:
         - $ref: "#/components/schemas/DescriptiveStructuredValue"
+        - $ref: "#/components/schemas/DescriptiveValueLanguage"
         - type: object
           additionalProperties: false
           properties:
@@ -770,6 +874,11 @@ components:
               type: array
               items:
                 $ref: "#/components/schemas/DescriptiveValue"
+            parallelEvent:
+              description: For multiple representations of information about the same event (e.g. in different languages)
+              type: array
+              items:
+                $ref: "#/components/schemas/DescriptiveParallelEvent"
     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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.47.2
+  version: 0.52.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-13 00:00:00.000000000 Z
+date: 2021-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -254,6 +254,8 @@ files:
 - lib/cocina/generator/vocab.rb
 - lib/cocina/models.rb
 - lib/cocina/models/access.rb
+- lib/cocina/models/access_role.rb
+- lib/cocina/models/access_role_member.rb
 - lib/cocina/models/admin_policy.rb
 - lib/cocina/models/admin_policy_administrative.rb
 - lib/cocina/models/administrative.rb
@@ -269,6 +271,7 @@ files:
 - 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_event.rb
 - lib/cocina/models/descriptive_parallel_value.rb
 - lib/cocina/models/descriptive_structured_value.rb
 - lib/cocina/models/descriptive_value.rb
@@ -326,7 +329,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: Data models for the SDR