cocina-models 0.49.0 → 0.50.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 422ee3a70d8d672a70b4a2125ada5a107941a963c6023e2905dd3f8c893b6ec4
-  data.tar.gz: d1dbe1479ea5ee1366e621eb8fb44663d4540cfbd84cf02e97ced3017c36bb93
+  metadata.gz: a55d992f499fd8f12826d186e7cca1d8ac9eea0fdc78863e8edcee8d04eb588e
+  data.tar.gz: 604b254a57b8760b65e1376d71bce54171ed6b539a013ad6efbd09e6a9305380
 SHA512:
-  metadata.gz: ce12a8eebecba8a9b4fbfb8275feced7bffd9439c28c171769995495afb4ecfbcdc5aded9ec86a188825684151dc248958c04c5116df3923a015ad4f29e1e283
-  data.tar.gz: b2cc97124a3c86da0134bcac5987664411cd62473886d8fcc8d1aa6ae11d91b0e6e0ea4f153e15ceb8ad2b4068c29403f45c86df97ed433cbce6e05a8eb0aeeb
+  metadata.gz: c0e746e2ba9ce5c02a7653f1fecfa833e59683f0fda8104d9caeec998cb6bb95c51d782f69eb3b2f80508e5f111c259ecd14bfdaa21fd7c1961b743c056b64c5
+  data.tar.gz: f24d9a01b2f1fbb1d4fad9d77c2e9b281f4c026ecedaa7ad0ab986302f61fea21b1349f6327a4eeb1b45a6293c3c9659a703ab186da58d8759de7e714ac93db5

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,9 @@ 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)
       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,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,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,7 @@ 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 :parallelEvent, Types::Strict::Array.of(DescriptiveParallelEvent).meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.49.0'
+    VERSION = '0.50.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,12 +211,20 @@ 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:
-          type: string
+          description: When you register an item with this admin policy, these are the workflows that are available.
+          type: array
+          items:
+            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 +572,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
@@ -743,7 +835,6 @@ components:
       additionalProperties: false
       allOf:
         - $ref: "#/components/schemas/DescriptiveStructuredValue"
-        - $ref: "#/components/schemas/DescriptiveParallelValue"
         - type: object
           additionalProperties: false
           properties:
@@ -778,6 +869,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.49.0
+  version: 0.50.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-26 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