cocina-models 0.49.0 → 0.54.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 422ee3a70d8d672a70b4a2125ada5a107941a963c6023e2905dd3f8c893b6ec4
-  data.tar.gz: d1dbe1479ea5ee1366e621eb8fb44663d4540cfbd84cf02e97ced3017c36bb93
+  metadata.gz: 458d1785e59901fddf5a48498b69f94918438a17eae1b55b3aae4c2566e7dfa5
+  data.tar.gz: 2f8db910031913c252f19e019535877d7d7cbb113ee8e2fdf5e3455866a5ef54
 SHA512:
-  metadata.gz: ce12a8eebecba8a9b4fbfb8275feced7bffd9439c28c171769995495afb4ecfbcdc5aded9ec86a188825684151dc248958c04c5116df3923a015ad4f29e1e283
-  data.tar.gz: b2cc97124a3c86da0134bcac5987664411cd62473886d8fcc8d1aa6ae11d91b0e6e0ea4f153e15ceb8ad2b4068c29403f45c86df97ed433cbce6e05a8eb0aeeb
+  metadata.gz: '095a80dcc767034269cca494bb97ac2cd2ebfd71c8c08407c22d69e3e39fbd3ec9f61d84259ca74ed09a63f0216832230f8da52de20dc384cc1bccd57f48ce4b'
+  data.tar.gz: fd89991c60f9a90397d250483f6a44aabf0f30ac83f20cc10f34d33dac1b082877a628bcd87465805ba742d143e37e608e5a58759b024ce448826efb3d44b622

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,8 +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/descriptive_parallel_event.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class DescriptiveParallelEvent < Struct
+      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)
+      attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :valueLanguage, DescriptiveValueLanguage.optional.meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/event.rb

@@ -4,7 +4,6 @@ module Cocina
   module Models
     class Event < Struct
       attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
-      attribute :parallelValue, 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.
@@ -14,6 +13,8 @@ module Cocina
       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 :valueLanguage, DescriptiveValueLanguage.optional.meta(omittable: true)
+      attribute :parallelEvent, Types::Strict::Array.of(DescriptiveParallelEvent).meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/file_administrative.rb

@@ -3,6 +3,7 @@
 module Cocina
   module Models
     class FileAdministrative < Struct
+      attribute :publish, Types::Strict::Bool.default(false)
       attribute :sdrPreserve, Types::Strict::Bool.default(true)
       attribute :shelve, Types::Strict::Bool.default(false)
     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.49.0'
+    VERSION = '0.54.0.beta.1'
   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,12 +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:
@@ -521,6 +576,49 @@ 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/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"
+            valueLanguage:
+              # description: Language of the descriptive element value
+              $ref: "#/components/schemas/DescriptiveValueLanguage"
     DescriptiveParallelValue:
       description: Value model for multiple representations of the same information (e.g. in different languages).
       type: object
@@ -558,27 +656,6 @@ components:
               $ref: '#/components/schemas/Standard'
               # description: An alphabet or other notation used to represent a
               #   language or other symbolic system of the descriptive element value.
-    Title:
-      type: object
-      additionalProperties: false
-      allOf:
-        - $ref: "#/components/schemas/DescriptiveValue"
-        - anyOf:
-            - type: object
-              required:
-                - value
-            - type: object
-              required:
-                - structuredValue
-            - 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
@@ -743,7 +820,6 @@ components:
       additionalProperties: false
       allOf:
         - $ref: "#/components/schemas/DescriptiveStructuredValue"
-        - $ref: "#/components/schemas/DescriptiveParallelValue"
         - type: object
           additionalProperties: false
           properties:
@@ -778,6 +854,14 @@ components:
               type: array
               items:
                 $ref: "#/components/schemas/DescriptiveValue"
+            valueLanguage:
+              # description: Language of the descriptive element value
+              $ref: "#/components/schemas/DescriptiveValueLanguage"
+            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
@@ -870,6 +954,9 @@ components:
       type: object
       additionalProperties: false
       properties:
+        publish:
+          type: boolean
+          default: false
         sdrPreserve:
           type: boolean
           default: true
@@ -877,6 +964,7 @@ components:
           type: boolean
           default: false
       required:
+        - publish
         - sdrPreserve
         - shelve
     FileSet:
@@ -1416,3 +1504,24 @@ components:
           type: string
         source:
           $ref: "#/components/schemas/Source"
+    Title:
+      type: object
+      additionalProperties: false
+      allOf:
+        - $ref: "#/components/schemas/DescriptiveValue"
+        - anyOf:
+            - type: object
+              required:
+                - value
+            - type: object
+              required:
+                - structuredValue
+            - type: object
+              required:
+                - parallelValue
+            - type: object
+              required:
+                - groupedValue
+            - type: object
+              required:
+                - valueAt

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.49.0
+  version: 0.54.0.beta.1
 platform: ruby
 authors:
 - Justin Coyne
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-26 00:00:00.000000000 Z
+date: 2021-03-10 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
@@ -311,7 +314,7 @@ files:
 homepage: https://github.com/sul-dlss/cocina-models
 licenses: []
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -322,12 +325,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.0.6
+signing_key: 
 specification_version: 4
 summary: Data models for the SDR
 test_files: []