cocina-models 0.107.1 → 0.108.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e982057b0f0017c03ce8809fa93494bd179b28a90e6ad3f32ad6859c4a8249c
-  data.tar.gz: 4777322f4d9b18fa6d814b36974dbbbd9e79857a4ce5149a756ae737e82ca49c
+  metadata.gz: dd16339f9a675493e71e0ced334d9f5c265dd0ce0c712f7016f8fd0e4e5c4125
+  data.tar.gz: 03f80e5b956fd69a8dbf978469668f62bac2c70a9100f781d05d4c3d7f662f92
 SHA512:
-  metadata.gz: c0c1136149b28c85dfa4c7a5e1aab4ee6829beecb2a04367db82a85f31a4a84aca774a3243fdbbfac34db1dca4d6f7624eaf399548db69a281c0e7059136d67a
-  data.tar.gz: 0ba5d2b587e122a0ab1cd363fcc5c32e0fc3a3a26ae35621967bcb8e0eead73bc87d86f263520be8b6d831ca528f2e7e0a85138f545e31ff8381d90bd826971c
+  metadata.gz: c0f258871c023833f9d43443c2140e091671d18d1f4c65c12626e14308ee78c99baa91fdb2a408b88d0ad3f7197931ddfb57979b122c806eec664e1b15a6fdff
+  data.tar.gz: 8f5d5d83bbf5c0ed0a919056458b7ac13bf009f537f69fbf60c8220acdcf14adeb594a5ff0c601da87859cae23e85fea7fd49b2d0368d500c1530bcdf041a629

data/.rubocop.yml

@@ -538,3 +538,5 @@ Style/EmptyStringInsideInterpolation: # new in 1.76
   Enabled: true
 Style/RedundantArrayFlatten: # new in 1.76
   Enabled: true
+Style/ArrayIntersectWithSingleElement: # new in 1.81
+  Enabled: true

data/Gemfile

@@ -5,5 +5,5 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in cocina-models.gemspec
 gemspec
 
-gem 'byebug'
+gem 'debug'
 gem 'rspec_junit_formatter' # For CircleCI

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cocina-models (0.107.1)
+    cocina-models (0.108.0)
       activesupport
       deprecation
       dry-struct (~> 1.0)
@@ -19,14 +19,14 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (8.0.3)
+    activesupport (8.1.0)
       base64
-      benchmark (>= 0.3)
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      json
       logger (>= 1.4.2)
       minitest (>= 5.1)
       securerandom (>= 0.3)
@@ -35,15 +35,17 @@ GEM
     ast (2.4.3)
     attr_extras (7.1.0)
     base64 (0.3.0)
-    benchmark (0.4.1)
     bigdecimal (3.3.1)
-    byebug (12.0.0)
     committee (5.0.0)
       json_schema (~> 0.14, >= 0.14.3)
       openapi_parser (~> 1.0)
       rack (>= 1.5)
     concurrent-ruby (1.3.5)
     connection_pool (2.5.4)
+    date (3.4.1)
+    debug (1.11.0)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
     deprecation (1.1.0)
       activesupport
     diff-lcs (1.6.2)
@@ -75,10 +77,16 @@ GEM
       activesupport (>= 3.0, < 9.0)
     equivalent-xml (0.6.0)
       nokogiri (>= 1.4.3)
+    erb (5.1.1)
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    json (2.15.1)
+    io-console (0.8.1)
+    irb (1.15.2)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.15.2)
     json_schema (0.21.0)
     jsonpath (1.1.5)
       multi_json
@@ -94,18 +102,30 @@ GEM
     openapi_parser (1.0.0)
     optimist (3.2.1)
     parallel (1.27.0)
-    parser (3.3.9.0)
+    parser (3.3.10.0)
       ast (~> 2.4.1)
       racc
     patience_diff (1.2.0)
       optimist (~> 3.0)
+    pp (0.6.3)
+      prettyprint
+    prettyprint (0.2.0)
     prism (1.6.0)
+    psych (5.2.6)
+      date
+      stringio
     racc (1.8.1)
     rack (3.2.3)
     rainbow (3.1.1)
     rake (13.3.0)
+    rdoc (6.15.0)
+      erb
+      psych (>= 4.0.0)
+      tsort
     regexp_parser (2.11.3)
-    rspec (3.13.1)
+    reline (0.6.2)
+      io-console (~> 0.5)
+    rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
@@ -120,7 +140,7 @@ GEM
     rspec-support (3.13.6)
     rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (1.81.1)
+    rubocop (1.81.6)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -148,11 +168,13 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.13.2)
     simplecov_json_formatter (0.1.4)
-    super_diff (0.16.0)
+    stringio (3.1.7)
+    super_diff (0.17.0)
       attr_extras (>= 6.2.4)
       diff-lcs
       patience_diff
     thor (1.4.0)
+    tsort (0.2.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (3.2.0)
@@ -166,9 +188,9 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.0)
-  byebug
   cocina-models!
   committee
+  debug
   rake (~> 13.0)
   rspec (~> 3.0)
   rspec_junit_formatter

data/lib/cocina/generator/datatype.rb

@@ -10,7 +10,7 @@ module Cocina
 
           module Cocina
             module Models
-              #{name} = Types::String#{pattern}#{enum}
+              #{preamble}#{name} = Types::String#{pattern}#{enum}
             end
           end
         RUBY

data/lib/cocina/generator/generator.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'debug'
 require 'fileutils'
 
 module Cocina

data/lib/cocina/generator/schema_array.rb

@@ -7,7 +7,7 @@ module Cocina
       GENERIC_ITEMS_NAME = 'items'
 
       def generate
-        "attribute :#{name.camelize(:lower)}, Types::Strict::Array.of(#{array_of_type}).default([].freeze)"
+        "#{preamble}attribute :#{name.camelize(:lower)}, Types::Strict::Array.of(#{array_of_type}).default([].freeze)"
       end
 
       def array_of_type

data/lib/cocina/generator/schema_base.rb

@@ -46,7 +46,15 @@ module Cocina
       def description
         return '' unless schema_doc.description
 
-        "# #{schema_doc.description}\n"
+        to_multiline_comment(schema_doc.description)
+      end
+
+      def to_multiline_comment(string)
+        string
+          .split(/(.{80,}?) /)
+          .compact_blank
+          .map { |comment_chunk| "# #{comment_chunk}\n" }
+          .join
       end
 
       def deprecation
@@ -58,7 +66,7 @@ module Cocina
       def example
         return '' unless schema_doc.example
 
-        "# example: #{schema_doc.example}\n"
+        to_multiline_comment("example: #{schema_doc.example}")
       end
 
       def relaxed_comment

data/lib/cocina/generator/schema_ref.rb

@@ -6,9 +6,9 @@ module Cocina
     class SchemaRef < SchemaBase
       def generate
         if required && !relaxed
-          "attribute(:#{name.camelize(:lower)}, #{schema_doc.name}.default { #{schema_doc.name}.new })"
+          "#{preamble}attribute(:#{name.camelize(:lower)}, #{schema_doc.name}.default { #{schema_doc.name}.new })"
         else
-          "attribute? :#{name.camelize(:lower)}, #{schema_doc.name}.optional"
+          "#{preamble}attribute? :#{name.camelize(:lower)}, #{schema_doc.name}.optional"
         end
       end
     end

data/lib/cocina/generator/union_type.rb

@@ -10,7 +10,7 @@ module Cocina
 
           module Cocina
             module Models
-              #{name} = #{type_names}
+              #{preamble}#{name} = #{type_names}
             end
           end
         RUBY

data/lib/cocina/generator/vocab.rb

@@ -52,11 +52,12 @@ module Cocina
       private_constant :BASE, :URIS
 
       def vocabs
-        type_properties = schemas.values.map { |schema| schema.properties&.[]('type') }.compact
-        type_properties.map(&:enum).flat_map(&:to_a)
-                       .filter { |vocab| vocab.start_with?(BASE) }
-                       .uniq
-                       .sort
+        schemas.values
+               .filter_map { |schema| schema.properties&.[]('type')&.enum }
+               .flat_map(&:to_a)
+               .select { |vocab| vocab.start_with?(BASE) }
+               .uniq
+               .sort
       end
 
       def names

data/lib/cocina/models/access_role.rb

@@ -6,6 +6,7 @@ module Cocina
     class AccessRole < Struct
       # Name of role
       attribute :name, Types::Strict::String.enum('dor-apo-depositor', 'dor-apo-manager', 'dor-apo-viewer', 'sdr-administrator', 'sdr-viewer', 'hydrus-collection-creator', 'hydrus-collection-manager', 'hydrus-collection-depositor', 'hydrus-collection-item-depositor', 'hydrus-collection-reviewer', 'hydrus-collection-viewer')
+      # The users and groups that are members of the role
       attribute :members, Types::Strict::Array.of(AccessRoleMember).default([].freeze)
     end
   end

data/lib/cocina/models/admin_policy.rb

@@ -17,6 +17,7 @@ module Cocina
       attribute :externalIdentifier, Druid
       attribute :label, Types::Strict::String
       attribute :version, Types::Strict::Integer
+      # Administrative properties for an AdminPolicy
       attribute(:administrative, AdminPolicyAdministrative.default { AdminPolicyAdministrative.new })
       attribute? :description, Description.optional
     end

data/lib/cocina/models/admin_policy_access_template.rb

@@ -2,15 +2,21 @@
 
 module Cocina
   module Models
-    # Provides the template of access settings that is copied to the items governed by an AdminPolicy. This is almost the same as DROAccess, but it provides no defaults and has no embargo.
+    # Provides the template of access settings that is copied to the items governed by
+    # an AdminPolicy. This is almost the same as DROAccess, but it provides no defaults
+    # and has no embargo.
     class AdminPolicyAccessTemplate < Struct
       # The human readable copyright statement that applies
       # example: Copyright World Trade Organization
       attribute? :copyright, Copyright.optional
       # The human readable use and reproduction statement that applies
-      # example: Property rights reside with the repository. Literary rights reside with the creators of the documents or their heirs. To obtain permission to publish or reproduce, please contact the Public Services Librarian of the Dept. of Special Collections (http://library.stanford.edu/spc).
+      # example: Property rights reside with the repository. Literary rights reside with
+      # the creators of the documents or their heirs. To obtain permission to publish or
+      # reproduce, please contact the Public Services Librarian of the Dept. of Special Collections
+      # (http://library.stanford.edu/spc).
       attribute? :useAndReproductionStatement, UseAndReproductionStatement.optional
-      # The license governing reuse of the DRO. Should be an IRI for known licenses (i.e. CC, RightsStatement.org URI, etc.).
+      # The license governing reuse of the DRO. Should be an IRI for known licenses (i.e.
+      # CC, RightsStatement.org URI, etc.).
       attribute? :license, License.optional.enum('https://www.gnu.org/licenses/agpl.txt', 'https://www.apache.org/licenses/LICENSE-2.0', 'https://opensource.org/licenses/BSD-2-Clause', 'https://opensource.org/licenses/BSD-3-Clause', 'https://creativecommons.org/licenses/by/4.0/legalcode', 'https://creativecommons.org/licenses/by-nc/4.0/legalcode', 'https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode', 'https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode', 'https://creativecommons.org/licenses/by-nd/4.0/legalcode', 'https://creativecommons.org/licenses/by-sa/4.0/legalcode', 'https://creativecommons.org/publicdomain/zero/1.0/legalcode', 'https://opensource.org/licenses/cddl1', 'https://www.eclipse.org/legal/epl-2.0', 'https://www.gnu.org/licenses/gpl-3.0-standalone.html', 'https://www.isc.org/downloads/software-support-policy/isc-license/', 'https://www.gnu.org/licenses/lgpl-3.0-standalone.html', 'https://opensource.org/licenses/MIT', 'https://www.mozilla.org/MPL/2.0/', 'https://opendatacommons.org/licenses/by/1-0/', 'http://opendatacommons.org/licenses/odbl/1.0/', 'https://opendatacommons.org/licenses/odbl/1-0/', 'https://creativecommons.org/publicdomain/mark/1.0/', 'https://opendatacommons.org/licenses/pddl/1-0/', 'https://creativecommons.org/licenses/by/3.0/legalcode', 'https://creativecommons.org/licenses/by-sa/3.0/legalcode', 'https://creativecommons.org/licenses/by-nd/3.0/legalcode', 'https://creativecommons.org/licenses/by-nc/3.0/legalcode', 'https://creativecommons.org/licenses/by-nc-sa/3.0/legalcode', 'https://creativecommons.org/licenses/by-nc-nd/3.0/legalcode', 'https://cocina.sul.stanford.edu/licenses/none')
       # Access level.
       # Validation of this property is relaxed. See the openapi for full validation.

data/lib/cocina/models/admin_policy_administrative.rb

@@ -4,16 +4,25 @@ module Cocina
   module Models
     # Administrative properties for an AdminPolicy
     class AdminPolicyAdministrative < Struct
+      # Provides the template of access settings that is copied to the items governed by
+      # an AdminPolicy. This is almost the same as DROAccess, but it provides no defaults
+      # and has no embargo.
       attribute(:accessTemplate, AdminPolicyAccessTemplate.default { AdminPolicyAccessTemplate.new })
+      # When you register an item with this admin policy, these are the workflows that are
+      # available.
       attribute :registrationWorkflow, Types::Strict::Array.of(Types::Strict::String).default([].freeze)
-      # An additional workflow to start for objects managed by this admin policy once the end-accession workflow step is complete
+      # 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
+      # When you register an item with this admin policy, these are the collections that
+      # are available.
       attribute :collectionsForRegistration, Types::Strict::Array.of(Types::Strict::String).default([].freeze)
       # example: druid:bc123df4567
       attribute :hasAdminPolicy, Druid
       # example: druid:bc123df4567
       attribute :hasAgreement, Druid
+      # The access roles conferred by this AdminPolicy (used by Argo)
       attribute :roles, Types::Strict::Array.of(AccessRole).default([].freeze)
     end
   end

data/lib/cocina/models/admin_policy_lite.rb

@@ -15,7 +15,10 @@ module Cocina
       attribute :externalIdentifier, Druid
       attribute :label, Types::Strict::String
       attribute :version, Types::Strict::Integer
+      # Administrative properties for an AdminPolicy
+      # Validation of this property is relaxed. See the openapi for full validation.
       attribute? :administrative, AdminPolicyAdministrative.optional
+      # Validation of this property is relaxed. See the openapi for full validation.
       attribute? :description, Description.optional
     end
   end

data/lib/cocina/models/admin_policy_with_metadata.rb

@@ -18,6 +18,7 @@ module Cocina
       attribute :externalIdentifier, Druid
       attribute :label, Types::Strict::String
       attribute :version, Types::Strict::Integer
+      # Administrative properties for an AdminPolicy
       attribute(:administrative, AdminPolicyAdministrative.default { AdminPolicyAdministrative.new })
       attribute? :description, Description.optional
       # When the object was created.

data/lib/cocina/models/applies_to.rb

@@ -2,7 +2,8 @@
 
 module Cocina
   module Models
-    # Property model for indicating the parts, aspects, or versions of the resource to which a descriptive element is applicable.
+    # Property model for indicating the parts, aspects, or versions of the resource to
+    # which a descriptive element is applicable.
     class AppliesTo < Struct
       attribute :appliesTo, Types::Strict::Array.of(DescriptiveBasicValue).default([].freeze)
     end

data/lib/cocina/models/barcode.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # A barcode
     Barcode = BusinessBarcode | LaneMedicalBarcode | CatkeyBarcode | StandardBarcode
   end
 end

data/lib/cocina/models/business_barcode.rb

@@ -2,6 +2,8 @@
 
 module Cocina
   module Models
+    # The barcode associated with a business library DRO object, prefixed with 2050
+    # example: 20503740296
     BusinessBarcode = Types::String.constrained(format: /^2050[0-9]{7}$/)
   end
 end

data/lib/cocina/models/catalog_link.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # A linkage between an object and a catalog record
     CatalogLink = FolioCatalogLink | SymphonyCatalogLink
   end
 end

data/lib/cocina/models/catkey_barcode.rb

@@ -2,6 +2,9 @@
 
 module Cocina
   module Models
+    # The barcode associated with a DRO object based on catkey, prefixed with a catkey
+    # followed by a hyphen
+    # example: 6772719-1001
     CatkeyBarcode = Types::String.constrained(format: /^[0-9]+-[0-9]+$/)
   end
 end

data/lib/cocina/models/citation_only_access.rb

@@ -2,7 +2,8 @@
 
 module Cocina
   module Models
-    # A type of access for an object wherein users can see the metadata and a list of files, but the files will not have view or download access
+    # A type of access for an object wherein users can see the metadata and a list of files,
+    # but the files will not have view or download access
     class CitationOnlyAccess < Struct
       # Access level.
       attribute :view, Types::Strict::String.enum('citation-only')

data/lib/cocina/models/cocina_version.rb

@@ -2,6 +2,8 @@
 
 module Cocina
   module Models
+    # The version of Cocina with which this object conforms.
+    # example: 1.2.3
     CocinaVersion = Types::String.constrained(format: /^\d+\.\d+\.\d+$/)
   end
 end

data/lib/cocina/models/collection.rb

@@ -2,7 +2,8 @@
 
 module Cocina
   module Models
-    # A group of Digital Repository Objects that indicate some type of conceptual grouping within the domain that is worth reusing across the system.
+    # A group of Digital Repository Objects that indicate some type of conceptual grouping
+    # within the domain that is worth reusing across the system.
     class Collection < Struct
       include Validatable
 
@@ -25,6 +26,7 @@ module Cocina
       attribute :label, Types::Strict::String
       # Version for the Collection within SDR.
       attribute :version, Types::Strict::Integer
+      # Access metadata for collections
       attribute(:access, CollectionAccess.default { CollectionAccess.new })
       attribute(:administrative, Administrative.default { Administrative.new })
       attribute(:description, Description.default { Description.new })

data/lib/cocina/models/collection_access.rb

@@ -10,9 +10,13 @@ module Cocina
       # example: Copyright World Trade Organization
       attribute? :copyright, Copyright.optional
       # The human readable use and reproduction statement that applies
-      # example: Property rights reside with the repository. Literary rights reside with the creators of the documents or their heirs. To obtain permission to publish or reproduce, please contact the Public Services Librarian of the Dept. of Special Collections (http://library.stanford.edu/spc).
+      # example: Property rights reside with the repository. Literary rights reside with
+      # the creators of the documents or their heirs. To obtain permission to publish or
+      # reproduce, please contact the Public Services Librarian of the Dept. of Special Collections
+      # (http://library.stanford.edu/spc).
       attribute? :useAndReproductionStatement, UseAndReproductionStatement.optional
-      # The license governing reuse of the DRO. Should be an IRI for known licenses (i.e. CC, RightsStatement.org URI, etc.).
+      # The license governing reuse of the DRO. Should be an IRI for known licenses (i.e.
+      # CC, RightsStatement.org URI, etc.).
       attribute? :license, License.optional.enum('https://www.gnu.org/licenses/agpl.txt', 'https://www.apache.org/licenses/LICENSE-2.0', 'https://opensource.org/licenses/BSD-2-Clause', 'https://opensource.org/licenses/BSD-3-Clause', 'https://creativecommons.org/licenses/by/4.0/legalcode', 'https://creativecommons.org/licenses/by-nc/4.0/legalcode', 'https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode', 'https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode', 'https://creativecommons.org/licenses/by-nd/4.0/legalcode', 'https://creativecommons.org/licenses/by-sa/4.0/legalcode', 'https://creativecommons.org/publicdomain/zero/1.0/legalcode', 'https://opensource.org/licenses/cddl1', 'https://www.eclipse.org/legal/epl-2.0', 'https://www.gnu.org/licenses/gpl-3.0-standalone.html', 'https://www.isc.org/downloads/software-support-policy/isc-license/', 'https://www.gnu.org/licenses/lgpl-3.0-standalone.html', 'https://opensource.org/licenses/MIT', 'https://www.mozilla.org/MPL/2.0/', 'https://opendatacommons.org/licenses/by/1-0/', 'http://opendatacommons.org/licenses/odbl/1.0/', 'https://opendatacommons.org/licenses/odbl/1-0/', 'https://creativecommons.org/publicdomain/mark/1.0/', 'https://opendatacommons.org/licenses/pddl/1-0/', 'https://creativecommons.org/licenses/by/3.0/legalcode', 'https://creativecommons.org/licenses/by-sa/3.0/legalcode', 'https://creativecommons.org/licenses/by-nd/3.0/legalcode', 'https://creativecommons.org/licenses/by-nc/3.0/legalcode', 'https://creativecommons.org/licenses/by-nc-sa/3.0/legalcode', 'https://creativecommons.org/licenses/by-nc-nd/3.0/legalcode', 'https://cocina.sul.stanford.edu/licenses/none')
     end
   end

data/lib/cocina/models/collection_identification.rb

@@ -4,7 +4,14 @@ module Cocina
   module Models
     class CollectionIdentification < Struct
       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"
+      # 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, SourceId.optional

data/lib/cocina/models/collection_lite.rb

@@ -2,7 +2,8 @@
 
 module Cocina
   module Models
-    # A group of Digital Repository Objects that indicate some type of conceptual grouping within the domain that is worth reusing across the system.
+    # A group of Digital Repository Objects that indicate some type of conceptual grouping
+    # within the domain that is worth reusing across the system.
     class CollectionLite < Struct
       include Checkable
 
@@ -23,9 +24,14 @@ module Cocina
       attribute :label, Types::Strict::String
       # Version for the Collection within SDR.
       attribute :version, Types::Strict::Integer
+      # Access metadata for collections
+      # Validation of this property is relaxed. See the openapi for full validation.
       attribute? :access, CollectionAccess.optional
+      # Validation of this property is relaxed. See the openapi for full validation.
       attribute? :administrative, Administrative.optional
+      # Validation of this property is relaxed. See the openapi for full validation.
       attribute? :description, Description.optional
+      # Validation of this property is relaxed. See the openapi for full validation.
       attribute? :identification, CollectionIdentification.optional
     end
   end

data/lib/cocina/models/collection_with_metadata.rb

@@ -25,6 +25,7 @@ module Cocina
       attribute :label, Types::Strict::String
       # Version for the Collection within SDR.
       attribute :version, Types::Strict::Integer
+      # Access metadata for collections
       attribute(:access, CollectionAccess.default { CollectionAccess.new })
       attribute(:administrative, Administrative.default { Administrative.new })
       attribute(:description, Description.default { Description.new })

data/lib/cocina/models/contributor.rb

@@ -2,19 +2,29 @@
 
 module Cocina
   module Models
-    # Property model for describing agents contributing in some way to the creation and history of the resource.
+    # Property model for describing agents contributing in some way to the creation and
+    # history of the resource.
     class Contributor < Struct
+      # Names associated with a contributor.
       attribute :name, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
-      # Entity type of the contributor (person, organization, etc.). See https://github.com/sul-dlss/cocina-models/blob/main/docs/description_types.md for valid types.
+      # Entity type of the contributor (person, organization, etc.). See https://github.com/sul-dlss/cocina-models/blob/main/docs/description_types.md
+      # for valid types.
       attribute? :type, Types::Strict::String
-      # Status of the contributor relative to other parallel contributors (e.g. the primary author among a group of contributors).
+      # Status of the contributor relative to other parallel contributors (e.g. the primary
+      # author among a group of contributors).
       attribute? :status, Types::Strict::String
+      # Relationships of the contributor to the resource or to an event in its history.
       attribute :role, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # Identifiers and URIs associated with the contributor entity.
       attribute :identifier, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # Institutional or other affiliation associated with a contributor.
       attribute :affiliation, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # Other information associated with the contributor.
       attribute :note, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
       # URL or other pointer to the location of the contributor information.
       attribute? :valueAt, Types::Strict::String
+      # For multiple representations of information about the same contributor (e.g. in different
+      # languages).
       attribute :parallelContributor, Types::Strict::Array.of(DescriptiveParallelContributor).default([].freeze)
     end
   end

data/lib/cocina/models/copyright.rb

@@ -2,6 +2,8 @@
 
 module Cocina
   module Models
+    # The human readable copyright statement that applies
+    # example: Copyright World Trade Organization
     Copyright = Types::String
   end
 end

data/lib/cocina/models/created_in_folio_identifier.rb

@@ -2,6 +2,8 @@
 
 module Cocina
   module Models
+    # A record identifier created in Folio
+    # example: in11403803
     CreatedInFolioIdentifier = Types::String.constrained(format: /^in\d+$/)
   end
 end

data/lib/cocina/models/description.rb

@@ -5,18 +5,32 @@ module Cocina
     class Description < Struct
       include Validatable
 
+      # Titles of the resource.
       attribute :title, Types::Strict::Array.of(Title).default([].freeze)
+      # Agents contributing in some way to the creation and history of the resource.
       attribute :contributor, Types::Strict::Array.of(Contributor).default([].freeze)
+      # Events in the history of the resource.
       attribute :event, Types::Strict::Array.of(Event).default([].freeze)
+      # Characteristics of the resource's physical, digital, and intellectual form and genre,
+      # and of its process of creation.
       attribute :form, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # Geographic description for items with coordinates or bounding boxes.
       attribute :geographic, Types::Strict::Array.of(DescriptiveGeographicMetadata).default([].freeze)
+      # Languages, scripts, symbolic systems, and notations used in all or part of a resource.
       attribute :language, Types::Strict::Array.of(Language).default([].freeze)
+      # Additional information relevant to a resource.
       attribute :note, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # Identifiers and URIs associated with the resource.
       attribute :identifier, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # Terms associated with the intellectual content of the resource.
       attribute :subject, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # Information about how to access digital and physical versions of the object.
       attribute? :access, DescriptiveAccessMetadata.optional
+      # Other resources associated with the described resource.
       attribute :relatedResource, Types::Strict::Array.of(RelatedResource).default([].freeze)
+      # Data about the resource represented in MARC fixed fields and codes.
       attribute :marcEncodedData, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # Information about this resource description.
       attribute? :adminMetadata, DescriptiveAdminMetadata.optional
       # URL or other pointer to the location of the resource description.
       attribute? :valueAt, Types::Strict::String

data/lib/cocina/models/descriptive_access_metadata.rb

@@ -4,11 +4,18 @@ module Cocina
   module Models
     # Information about how to access digital and physical versions of the object.
     class DescriptiveAccessMetadata < Struct
+      # URLs where the resource may be accessed in full or part.
       attribute :url, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # Location of a physical version of the resource.
       attribute :physicalLocation, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # Location of a digital version of the resource, such as a file path for a born digital
+      # resource.
       attribute :digitalLocation, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # The library, organization, or person responsible for access to the resource.
       attribute :accessContact, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # The digital repositories that hold the resource.
       attribute :digitalRepository, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # Other information related to accessing the resource.
       attribute :note, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
     end
   end

data/lib/cocina/models/descriptive_admin_metadata.rb

@@ -4,11 +4,17 @@ module Cocina
   module Models
     # Information about this resource description.
     class DescriptiveAdminMetadata < Struct
+      # Contributors to this resource description.
       attribute :contributor, Types::Strict::Array.of(Contributor).default([].freeze)
+      # Events in the history of this resource description.
       attribute :event, Types::Strict::Array.of(Event).default([].freeze)
+      # Languages, scripts, symbolic systems, and notations used in this resource description.
       attribute :language, Types::Strict::Array.of(Language).default([].freeze)
+      # Other information related to this resource description.
       attribute :note, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # Descriptive or content standard(s) to which this resource description conforms.
       attribute :metadataStandard, Types::Strict::Array.of(Standard).default([].freeze)
+      # Identifiers associated with this resource description.
       attribute :identifier, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
     end
   end