cocina-models 0.107.1 → 0.108.0

data/lib/cocina/models/descriptive_basic_value.rb

@@ -2,14 +2,16 @@
 
 module Cocina
   module Models
-    # Basic value model for descriptive elements. Can only have one of value, parallelValue, groupedValue, or structuredValue.
+    # Basic value model for descriptive elements. Can only have one of value, parallelValue,
+    # groupedValue, or structuredValue.
     class DescriptiveBasicValue < Struct
       attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
       attribute :parallelValue, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
       attribute :groupedValue, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
       # String or integer value of the descriptive element.
       attribute? :value, Types::Nominal::Any
-      # Type of value provided by the descriptive element. See https://github.com/sul-dlss/cocina-models/blob/main/docs/description_types.md for valid types.
+      # Type of value provided by the descriptive element. 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 descriptive element value relative to other instances of the element.
       attribute? :status, Types::Strict::String
@@ -17,15 +19,25 @@ module Cocina
       attribute? :code, Types::Strict::String
       # URI value of the descriptive element.
       attribute? :uri, Types::Strict::String
+      # Property model for indicating the encoding, standard, or syntax to which a value
+      # conforms (e.g. RDA).
       attribute? :standard, Standard.optional
+      # Property model for indicating the encoding, standard, or syntax to which a value
+      # conforms (e.g. RDA).
       attribute? :encoding, Standard.optional
+      # Identifiers and URIs associated with the descriptive element.
       attribute :identifier, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # Property model for indicating the vocabulary, authority, or other origin for a term,
+      # code, or identifier.
       attribute? :source, Source.optional
       # The preferred display label to use for the descriptive element in access systems.
       attribute? :displayLabel, Types::Strict::String
-      # A term providing information about the circumstances of the statement (e.g., approximate dates).
+      # A term providing information about the circumstances of the statement (e.g., approximate
+      # dates).
       attribute? :qualifier, Types::Strict::String
+      # Other information related to the descriptive element.
       attribute :note, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # Language of the descriptive element value
       attribute? :valueLanguage, DescriptiveValueLanguage.optional
       # URL or other pointer to the location of the value of the descriptive element.
       attribute? :valueAt, Types::Strict::String

data/lib/cocina/models/descriptive_geographic_metadata.rb

@@ -5,6 +5,7 @@ module Cocina
     # Value model for mods geographic extension metadata
     class DescriptiveGeographicMetadata < Struct
       attribute :form, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # Terms associated with the intellectual content of the related resource.
       attribute :subject, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
     end
   end

data/lib/cocina/models/descriptive_grouped_value.rb

@@ -2,7 +2,8 @@
 
 module Cocina
   module Models
-    # Value model for a set of descriptive elements grouped together in an unstructured way.
+    # Value model for a set of descriptive elements grouped together in an unstructured
+    # way.
     class DescriptiveGroupedValue < Struct
       attribute :groupedValue, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
     end

data/lib/cocina/models/descriptive_parallel_contributor.rb

@@ -3,18 +3,26 @@
 module Cocina
   module Models
     # DEPRECATED
-    # Value model for multiple representations of information about the same contributor (e.g. in different languages).
+    # Value model for multiple representations of information about the same contributor
+    # (e.g. in different languages).
     class DescriptiveParallelContributor < 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)
+      # 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
+      # Language of the descriptive element value
       attribute? :valueLanguage, DescriptiveValueLanguage.optional
     end
   end

data/lib/cocina/models/descriptive_parallel_event.rb

@@ -2,18 +2,25 @@
 
 module Cocina
   module Models
-    # Value model for multiple representations of information about the same event (e.g. in different languages).
+    # Value model for multiple representations of information about the same event (e.g.
+    # in different languages).
     class DescriptiveParallelEvent < Struct
       attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
       # Description of the event (creation, publication, etc.).
       attribute? :type, Types::Strict::String
       # The preferred display label to use for the event in access systems.
       attribute? :displayLabel, Types::Strict::String
+      # Dates associated with the event.
       attribute :date, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # Contributors associated with the event.
       attribute :contributor, Types::Strict::Array.of(Contributor).default([].freeze)
+      # Locations associated with the event.
       attribute :location, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # Identifiers and URIs associated with the event.
       attribute :identifier, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # Other information about the event.
       attribute :note, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # Language of the descriptive element value
       attribute? :valueLanguage, DescriptiveValueLanguage.optional
     end
   end

data/lib/cocina/models/descriptive_parallel_value.rb

@@ -2,7 +2,8 @@
 
 module Cocina
   module Models
-    # Value model for multiple representations of the same information (e.g. in different languages).
+    # Value model for multiple representations of the same information (e.g. in different
+    # languages).
     class DescriptiveParallelValue < Struct
       attribute :parallelValue, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
     end

data/lib/cocina/models/descriptive_value.rb

@@ -9,7 +9,8 @@ module Cocina
       attribute :groupedValue, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
       # String or integer value of the descriptive element.
       attribute? :value, Types::Nominal::Any
-      # Type of value provided by the descriptive element. See https://github.com/sul-dlss/cocina-models/blob/main/docs/description_types.md for valid types.
+      # Type of value provided by the descriptive element. 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 descriptive element value relative to other instances of the element.
       attribute? :status, Types::Strict::String
@@ -17,15 +18,25 @@ module Cocina
       attribute? :code, Types::Strict::String
       # URI value of the descriptive element.
       attribute? :uri, Types::Strict::String
+      # Property model for indicating the encoding, standard, or syntax to which a value
+      # conforms (e.g. RDA).
       attribute? :standard, Standard.optional
+      # Property model for indicating the encoding, standard, or syntax to which a value
+      # conforms (e.g. RDA).
       attribute? :encoding, Standard.optional
+      # Identifiers and URIs associated with the descriptive element.
       attribute :identifier, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # Property model for indicating the vocabulary, authority, or other origin for a term,
+      # code, or identifier.
       attribute? :source, Source.optional
       # The preferred display label to use for the descriptive element in access systems.
       attribute? :displayLabel, Types::Strict::String
-      # A term providing information about the circumstances of the statement (e.g., approximate dates).
+      # A term providing information about the circumstances of the statement (e.g., approximate
+      # dates).
       attribute? :qualifier, Types::Strict::String
+      # Other information related to the descriptive element.
       attribute :note, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # Language of the descriptive element value
       attribute? :valueLanguage, DescriptiveValueLanguage.optional
       # URL or other pointer to the location of the value of the descriptive element.
       attribute? :valueAt, Types::Strict::String

data/lib/cocina/models/descriptive_value_language.rb

@@ -10,10 +10,15 @@ module Cocina
       attribute? :uri, Types::Strict::String
       # String describing the standard or encoding.
       attribute? :value, Types::Strict::String
+      # Other information related to the standard or encoding.
       attribute :note, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
       # The version of the standard or encoding.
       attribute? :version, Types::Strict::String
+      # Property model for indicating the vocabulary, authority, or other origin for a term,
+      # code, or identifier.
       attribute? :source, Source.optional
+      # Property model for indicating the encoding, standard, or syntax to which a value
+      # conforms (e.g. RDA).
       attribute? :valueScript, Standard.optional
     end
   end

data/lib/cocina/models/doi.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
-    DOI = DoiPattern | DoiExceptions
+    # Digital Object Identifier (https://www.doi.org)
+    DOI = RepositoryDOI | PreregisteredRepositoryDOI | LibrariesDOI | DOIExceptions
   end
 end

data/lib/cocina/models/doi_exceptions.rb

@@ -2,6 +2,11 @@
 
 module Cocina
   module Models
-    DoiExceptions = Types::String.constrained(format: %r{^10\.(25740/([vV][aA]90-[cC][tT]15|[sS][yY][xX][aA]-[mM]256|12[qQ][fF]-5243|65[jJ]8-6114)|25936/629[tT]-[bB][xX]79)$})
+    # The DOI (Digital Object Identifier, https://www.doi.org) pattern for objects in SDR
+    # that do not adhere to any of the other DOI patterns in the spec. This is a short
+    # list of known exceptions only. Please note that DOIs are *not* case-sensitive, so
+    # we allow for uppercase and lowercase letters with these exceptions.
+    # example: 10.18735/0mw1-qq72
+    DOIExceptions = Types::String.constrained(format: %r{^10\.25936/[jJ][mM]709[hH][cC]8700|10\.18735/4[nN][sS][eE]-8871|10\.18735/952[xX]-[wW]447|10\.18735/0[mM][wW]1-[qQ][qQ]72$})
   end
 end

data/lib/cocina/models/dro.rb

@@ -2,7 +2,8 @@
 
 module Cocina
   module Models
-    # 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.
+    # 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.
     class DRO < Struct
       include Validatable
 
@@ -39,7 +40,9 @@ module Cocina
       attribute(:administrative, Administrative.default { Administrative.new })
       attribute(:description, Description.default { Description.new })
       attribute(:identification, Identification.default { Identification.new })
+      # Structural metadata
       attribute(:structural, DROStructural.default { DROStructural.new })
+      # Geographic metadata
       attribute? :geographic, Geographic.optional
     end
   end

data/lib/cocina/models/dro_access.rb

@@ -19,9 +19,13 @@ module Cocina
       attribute? :copyright, Copyright.optional
       attribute? :embargo, Embargo.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/dro_lite.rb

@@ -2,7 +2,8 @@
 
 module Cocina
   module Models
-    # 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.
+    # 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.
     class DROLite < Struct
       include Checkable
 
@@ -33,11 +34,19 @@ module Cocina
       attribute :label, Types::Strict::String
       # Version for the DRO within SDR.
       attribute :version, Types::Strict::Integer
+      # Validation of this property is relaxed. See the openapi for full validation.
       attribute? :access, DROAccess.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, Identification.optional
+      # Structural metadata
+      # Validation of this property is relaxed. See the openapi for full validation.
       attribute? :structural, DROStructural.optional
+      # Geographic metadata
+      # Validation of this property is relaxed. See the openapi for full validation.
       attribute? :geographic, Geographic.optional
     end
   end

data/lib/cocina/models/dro_structural.rb

@@ -4,8 +4,12 @@ module Cocina
   module Models
     # Structural metadata
     class DROStructural < Struct
+      # Filesets that contain the digital representations (Files)
       attribute :contains, Types::Strict::Array.of(FileSet).default([].freeze)
+      # Provided sequences or orderings of members, including some metadata about each sequence
+      # (i.e. sequence label, sequence type, if the sequence is primary, etc.).
       attribute :hasMemberOrders, Types::Strict::Array.of(Sequence).default([].freeze)
+      # Collections that this DRO is a member of
       attribute :isMemberOf, Types::Strict::Array.of(Druid).default([].freeze)
     end
   end

data/lib/cocina/models/dro_with_metadata.rb

@@ -39,7 +39,9 @@ module Cocina
       attribute(:administrative, Administrative.default { Administrative.new })
       attribute(:description, Description.default { Description.new })
       attribute(:identification, Identification.default { Identification.new })
+      # Structural metadata
       attribute(:structural, DROStructural.default { DROStructural.new })
+      # Geographic metadata
       attribute? :geographic, Geographic.optional
       # When the object was created.
       attribute? :created, Types::Params::DateTime

data/lib/cocina/models/druid.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # example: druid:bc123df4567
     Druid = Types::String.constrained(format: /^druid:[b-df-hjkmnp-tv-z]{2}[0-9]{3}[b-df-hjkmnp-tv-z]{2}[0-9]{4}$/)
   end
 end

data/lib/cocina/models/embargo.rb

@@ -18,7 +18,10 @@ module Cocina
       # example: 2029-06-22T07:00:00.000+00:00
       attribute :releaseDate, Types::Params::DateTime
       # 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
     end
   end

data/lib/cocina/models/event.rb

@@ -9,12 +9,20 @@ module Cocina
       attribute? :type, Types::Strict::String
       # The preferred display label to use for the event in access systems.
       attribute? :displayLabel, Types::Strict::String
+      # Dates associated with the event.
       attribute :date, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # Contributors associated with the event.
       attribute :contributor, Types::Strict::Array.of(Contributor).default([].freeze)
+      # Locations associated with the event.
       attribute :location, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # Identifiers and URIs associated with the event.
       attribute :identifier, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # Other information about the event.
       attribute :note, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # Language of the descriptive element value
       attribute? :valueLanguage, DescriptiveValueLanguage.optional
+      # For multiple representations of information about the same event (e.g. in different
+      # languages)
       attribute :parallelEvent, Types::Strict::Array.of(DescriptiveParallelEvent).default([].freeze)
     end
   end

data/lib/cocina/models/file.rb

@@ -2,7 +2,8 @@
 
 module Cocina
   module Models
-    # 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.
+    # 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.
     class File < Struct
       include Checkable
 
@@ -10,7 +11,8 @@ module Cocina
 
       # The content type of the File.
       attribute :type, Types::Strict::String.enum(*File::TYPES)
-      # Identifier for the resource within the SDR architecture but outside of the repository. UUID. Constant across resource versions. What clients will use calling the repository.
+      # Identifier for the resource within the SDR architecture but outside of the repository.
+      # UUID. Constant across resource versions. What clients will use calling the repository.
       attribute :externalIdentifier, Types::Strict::String
       # Primary processing label (can be same as title) for a File.
       attribute :label, Types::Strict::String
@@ -22,7 +24,8 @@ module Cocina
       attribute :version, Types::Strict::Integer
       # MIME Type of the File.
       attribute? :hasMimeType, Types::Strict::String
-      # BCP 47 language tag: https://www.rfc-editor.org/rfc/rfc4646.txt -- other applications (like media players) expect language codes of this format, see e.g. https://videojs.com/guides/text-tracks/#srclang
+      # BCP 47 language tag: https://www.rfc-editor.org/rfc/rfc4646.txt -- other applications
+      # (like media players) expect language codes of this format, see e.g. https://videojs.com/guides/text-tracks/#srclang
       attribute? :languageTag, LanguageTag.optional
       # Use for the File (e.g. "transcription" for OCR).
       attribute? :use, FileUse.optional
@@ -31,8 +34,10 @@ module Cocina
       # Indicates if text that has been verified for accessibility/correctness.
       attribute? :correctedForAccessibility, Types::Strict::Bool.default(false)
       attribute :hasMessageDigests, Types::Strict::Array.of(MessageDigest).default([].freeze)
+      # Access metadata for files
       attribute(:access, FileAccess.default { FileAccess.new })
       attribute(:administrative, FileAdministrative.default { FileAdministrative.new })
+      # Presentation data for the File.
       attribute? :presentation, Presentation.optional
     end
   end

data/lib/cocina/models/file_set.rb

@@ -26,6 +26,7 @@ module Cocina
       attribute :label, Types::Strict::String
       # Version for the Fileset within SDR.
       attribute :version, Types::Strict::Integer
+      # Structural metadata
       attribute(:structural, FileSetStructural.default { FileSetStructural.new })
     end
   end

data/lib/cocina/models/file_use.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Use for the File (e.g. "transcription" for OCR).
     FileUse = Types::String
   end
 end

data/lib/cocina/models/folio_catalog_link.rb

@@ -7,7 +7,9 @@ module Cocina
       # Catalog that is the source of the linked record.
       # example: folio
       attribute :catalog, Types::Strict::String.enum('folio', 'previous folio')
-      # Only one of the Folio instance HRIDs should be designated for refreshing. This means that this HRID is the one used to pull metadata from the catalog if there is more than one HRID present.
+      # Only one of the Folio instance HRIDs should be designated for refreshing. This means
+      # that this HRID is the one used to pull metadata from the catalog if there is more
+      # than one HRID present.
       attribute :refresh, Types::Strict::Bool.default(false)
       # Record identifier that is unique within the context of the linked record's catalog.
       attribute :catalogRecordId, MigratedFromSymphonyIdentifier | MigratedFromVoyagerIdentifier | CreatedInFolioIdentifier

data/lib/cocina/models/identification.rb

@@ -8,7 +8,14 @@ module Cocina
       attribute :catalogLinks, Types::Strict::Array.of(CatalogLink).default([].freeze)
       # Digital Object Identifier (https://www.doi.org)
       attribute? :doi, DOI.optional
-      # 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

data/lib/cocina/models/lane_medical_barcode.rb

@@ -2,6 +2,8 @@
 
 module Cocina
   module Models
+    # The barcode associated with a Lane Medical Library DRO object, prefixed with 245
+    # example: 24503259768
     LaneMedicalBarcode = Types::String.constrained(format: /^245[0-9]{8}$/)
   end
 end

data/lib/cocina/models/language.rb

@@ -2,24 +2,42 @@
 
 module Cocina
   module Models
-    # Languages, scripts, symbolic systems, and notations used in all or part of a resource or its descriptive metadata.
+    # Languages, scripts, symbolic systems, and notations used in all or part of a resource
+    # or its descriptive metadata.
     class Language < Struct
       attribute :appliesTo, Types::Strict::Array.of(DescriptiveBasicValue).default([].freeze)
       # Code value of the descriptive element.
       attribute? :code, Types::Strict::String
       # The preferred display label to use for the descriptive element in access systems.
       attribute? :displayLabel, Types::Strict::String
+      # Property model for indicating the encoding, standard, or syntax to which a value
+      # conforms (e.g. RDA).
       attribute? :encoding, Standard.optional
+      # present for mapping to additional schemas in the future and for consistency but not
+      # otherwise used
       attribute :groupedValue, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # present for mapping to additional schemas in the future and for consistency but not
+      # otherwise used
       attribute :note, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
+      # present for mapping to additional schemas in the future and for consistency but not
+      # otherwise used
       attribute :parallelValue, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
-      # present for mapping to additional schemas in the future and for consistency but not otherwise used
+      # present for mapping to additional schemas in the future and for consistency but not
+      # otherwise used
       attribute? :qualifier, Types::Strict::String
+      # Default value model for descriptive elements.
       attribute? :script, DescriptiveValue.optional
+      # Property model for indicating the vocabulary, authority, or other origin for a term,
+      # code, or identifier.
       attribute? :source, Source.optional
-      # Status of the language relative to other parallel language elements (e.g. the primary language)
+      # Status of the language relative to other parallel language elements (e.g. the primary
+      # language)
       attribute? :status, Types::Strict::String.enum('primary')
+      # Property model for indicating the encoding, standard, or syntax to which a value
+      # conforms (e.g. RDA).
       attribute? :standard, Standard.optional
+      # present for mapping to additional schemas in the future and for consistency but not
+      # otherwise used
       attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
       # URI value of the descriptive element.
       attribute? :uri, Types::Strict::String
@@ -27,6 +45,7 @@ module Cocina
       attribute? :value, Types::Strict::String
       # URL or other pointer to the location of the language information.
       attribute? :valueAt, Types::Strict::String
+      # Language of the descriptive element value
       attribute? :valueLanguage, DescriptiveValueLanguage.optional
     end
   end

data/lib/cocina/models/language_tag.rb

@@ -2,6 +2,8 @@
 
 module Cocina
   module Models
+    # BCP 47 language tag: https://www.rfc-editor.org/rfc/rfc4646.txt -- other applications
+    # (like media players) expect language codes of this format, see e.g. https://videojs.com/guides/text-tracks/#srclang
     LanguageTag = Types::String
   end
 end

data/lib/cocina/models/libraries_doi.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    # The DOI (Digital Object Identifier, https://www.doi.org) pattern for works registered
+    # by Stanford Libraries outside of SDR workflows. Please note that DOIs are *not* case-sensitive
+    # so both cases of letters should be permitted.
+    # example: 10.25936/629T-bx79
+    LibrariesDOI = Types::String.constrained(format: %r{^10\.25936/[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}$})
+  end
+end

data/lib/cocina/models/license.rb

@@ -2,6 +2,8 @@
 
 module Cocina
   module Models
+    # The license governing reuse of the DRO. Should be an IRI for known licenses (i.e.
+    # CC, RightsStatement.org URI, etc.).
     License = Types::String.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/migrated_from_symphony_identifier.rb

@@ -2,6 +2,8 @@
 
 module Cocina
   module Models
+    # A record identifier migrated from Symphony
+    # example: a11403803
     MigratedFromSymphonyIdentifier = Types::String.constrained(format: /^a\d+$/)
   end
 end

data/lib/cocina/models/migrated_from_voyager_identifier.rb

@@ -2,6 +2,8 @@
 
 module Cocina
   module Models
+    # A record identifier migrated from Voyager
+    # example: L11403803
     MigratedFromVoyagerIdentifier = Types::String.constrained(format: /^L\d+$/)
   end
 end

data/lib/cocina/models/preregistered_repository_doi.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    # The DOI (Digital Object Identifier, https://www.doi.org) pattern for DOIs registered
+    # before an SDR object has been registered---i.e., before it has a druid, which is
+    # a common pattern as of 2025. Please note that DOIs are *not* case-sensitive so both
+    # cases of letters should be permitted.
+    # example: 10.80343/12qF-5243
+    PreregisteredRepositoryDOI = Types::String.constrained(format: %r{^10\.(25740|80343)/[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}$})
+  end
+end

data/lib/cocina/models/purl.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Stanford persistent URL associated with the related resource.
     Purl = Types::String.constrained(format: %r{^https://})
   end
 end