cocina-models 0.62.1 → 0.65.0

data/openapi.yml

@@ -91,6 +91,18 @@ paths:
       responses:
         '200':
           description: noop
+  /validate/RequestDescription:
+    post:
+      summary: Validate a Request Description
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/RequestDescription'
+      responses:
+        '200':
+          description: noop
 components:
   schemas:
     Access:
@@ -172,6 +184,8 @@ components:
       type: object
       additionalProperties: false
       properties:
+        cocinaVersion:
+          $ref: '#/components/schemas/CocinaVersion'
         type:
           type: string
           enum:
@@ -187,6 +201,7 @@ components:
         description:
           $ref: '#/components/schemas/Description'
       required:
+        - cocinaVersion
         - administrative
         - externalIdentifier
         - label
@@ -220,7 +235,7 @@ components:
             type: string
         hasAdminPolicy:
           $ref: '#/components/schemas/Druid'
-        referencesAgreement:
+        hasAgreement:
           $ref: '#/components/schemas/Druid'
         roles:
           description: The access roles conferred by this AdminPolicy (used by Argo)
@@ -229,6 +244,7 @@ components:
             $ref: '#/components/schemas/AccessRole'
       required:
         - hasAdminPolicy
+        - hasAgreement
     AdminPolicyDefaultAccess:
       description: 'Provides the default access settings for an AdminPolicy. This is almost the same as DROAccess, but it provides no defaults and has no embargo.'
       type: object
@@ -298,6 +314,7 @@ components:
             $ref: "#/components/schemas/DescriptiveBasicValue"
     Barcode:
       description: 'A barcode'
+      nullable: true
       oneOf:
         - $ref: '#/components/schemas/BusinessBarcode'
         - $ref: '#/components/schemas/LaneMedicalBarcode'
@@ -360,11 +377,18 @@ components:
       required:
         - access
         - download
+    CocinaVersion:
+      description: The version of Cocina with which this object conforms.
+      type: string
+      pattern: '^\d+\.\d+\.\d+$'
+      example: '1.2.3'
     Collection:
       description: A group of Digital Repository Objects that indicate some type of conceptual grouping within the domain that is worth reusing across the system.
       type: object
       additionalProperties: false
       properties:
+        cocinaVersion:
+            $ref: '#/components/schemas/CocinaVersion'
         type:
           description: The content type of the Collection. Selected from an established set of values.
           type: string
@@ -391,6 +415,7 @@ components:
         identification:
           $ref: '#/components/schemas/CollectionIdentification'
       required:
+        - cocinaVersion
         - externalIdentifier
         - label
         - type
@@ -529,77 +554,15 @@ components:
     Description:
       type: object
       additionalProperties: false
-      properties:
-        title:
-          description: Titles of the resource.
-          type: array
-          minItems: 1
-          items:
-            $ref: "#/components/schemas/Title"
-        contributor:
-          description: Agents contributing in some way to the creation and history of the
-            resource.
-          type: array
-          items:
-            $ref: "#/components/schemas/Contributor"
-        event:
-          description: Events in the history of the resource.
-          type: array
-          items:
-            $ref: "#/components/schemas/Event"
-        form:
-          description: Characteristics of the resource's physical, digital, and intellectual
-            form and genre, and of its process of creation.
-          type: array
-          items:
-            $ref: "#/components/schemas/DescriptiveValue"
-        geographic:
-          description: Geographic description for items with coordinates or bounding boxes.
-          type: array
-          items:
-            $ref: "#/components/schemas/DescriptiveGeographicMetadata"
-        language:
-          description: Languages, scripts, symbolic systems, and notations used in all or
-            part of a resource.
-          type: array
-          items:
-            $ref: "#/components/schemas/Language"
-        note:
-          description: Additional information relevant to a resource.
-          type: array
-          items:
-            $ref: "#/components/schemas/DescriptiveValue"
-        identifier:
-          description: Identifiers and URIs associated with the resource.
-          type: array
-          items:
-            $ref: "#/components/schemas/DescriptiveValue"
-        subject:
-          description: Terms associated with the intellectual content of the resource.
-          type: array
-          items:
-            $ref: "#/components/schemas/DescriptiveValue"
-        purl:
-          $ref: "#/components/schemas/Purl"
-        access:
-          $ref: "#/components/schemas/DescriptiveAccessMetadata"
-        relatedResource:
-          description: Other resources associated with the described resource.
-          type: array
-          items:
-            $ref: "#/components/schemas/RelatedResource"
-        marcEncodedData:
-          description: Data about the resource represented in MARC fixed fields and codes.
-          type: array
-          items:
-            $ref: "#/components/schemas/DescriptiveValue"
-        adminMetadata:
-          $ref: "#/components/schemas/DescriptiveAdminMetadata"
-        valueAt:
-          description: URL or other pointer to the location of the resource description.
-          type: string
-      required:
-        - title
+      allOf:
+        - $ref: "#/components/schemas/RequestDescription"
+        - type: object
+          additionalProperties: false
+          properties:
+            purl:
+              $ref: "#/components/schemas/Purl"
+          required:
+            - purl
     DescriptiveAccessMetadata:
       description: Information about how to access digital and physical versions of the object.
       type: object
@@ -886,6 +849,8 @@ components:
       type: object
       additionalProperties: false
       properties:
+        cocinaVersion:
+          $ref: '#/components/schemas/CocinaVersion'
         type:
           description: The content type of the DRO. Selected from an established set of values.
           type: string
@@ -926,6 +891,7 @@ components:
         geographic:
           $ref: '#/components/schemas/Geographic'
       required:
+        - cocinaVersion
         - access
         - administrative
         - externalIdentifier
@@ -953,6 +919,7 @@ components:
             license:
               description: The license governing reuse of the DRO. Should be an IRI for known licenses (i.e. CC, RightsStatement.org URI, etc.).
               type: string
+              nullable: true
               enum:
                 - 'https://www.gnu.org/licenses/agpl.txt'
                 - 'https://www.apache.org/licenses/LICENSE-2.0'
@@ -1004,9 +971,6 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/Druid'
-        hasAgreement:
-          description: Agreement that covers the deposit of the DRO into SDR.
-          type: string
     Druid:
       type: string
       pattern: '^druid:[b-df-hjkmnp-tv-z]{2}[0-9]{3}[b-df-hjkmnp-tv-z]{2}[0-9]{4}$'
@@ -1508,6 +1472,8 @@ components:
       type: object
       additionalProperties: false
       properties:
+        cocinaVersion:
+          $ref: '#/components/schemas/CocinaVersion'
         type:
           type: string
           enum:
@@ -1519,8 +1485,9 @@ components:
         administrative:
           $ref: '#/components/schemas/AdminPolicyAdministrative'
         description:
-          $ref: '#/components/schemas/Description'
+          $ref: '#/components/schemas/RequestDescription'
       required:
+        - cocinaVersion
         - administrative
         - label
         - type
@@ -1530,6 +1497,8 @@ components:
       type: object
       additionalProperties: false
       properties:
+        cocinaVersion:
+          $ref: '#/components/schemas/CocinaVersion'
         type:
           type: string
           enum:
@@ -1547,20 +1516,96 @@ components:
         administrative:
           $ref: '#/components/schemas/Administrative'
         description:
-          $ref: '#/components/schemas/Description'
+          $ref: '#/components/schemas/RequestDescription'
         identification:
           $ref: '#/components/schemas/CollectionIdentification'
       required:
+        - cocinaVersion
         - access
         - administrative
         - label
         - type
         - version
+    RequestDescription:
+      description: Description that is included in a request to create a DRO. This is the same as a Description, except excludes PURL.
+      type: object
+      additionalProperties: false
+      properties:
+        title:
+          description: Titles of the resource.
+          type: array
+          minItems: 1
+          items:
+            $ref: "#/components/schemas/Title"
+        contributor:
+          description: Agents contributing in some way to the creation and history of the
+            resource.
+          type: array
+          items:
+            $ref: "#/components/schemas/Contributor"
+        event:
+          description: Events in the history of the resource.
+          type: array
+          items:
+            $ref: "#/components/schemas/Event"
+        form:
+          description: Characteristics of the resource's physical, digital, and intellectual
+            form and genre, and of its process of creation.
+          type: array
+          items:
+            $ref: "#/components/schemas/DescriptiveValue"
+        geographic:
+          description: Geographic description for items with coordinates or bounding boxes.
+          type: array
+          items:
+            $ref: "#/components/schemas/DescriptiveGeographicMetadata"
+        language:
+          description: Languages, scripts, symbolic systems, and notations used in all or
+            part of a resource.
+          type: array
+          items:
+            $ref: "#/components/schemas/Language"
+        note:
+          description: Additional information relevant to a resource.
+          type: array
+          items:
+            $ref: "#/components/schemas/DescriptiveValue"
+        identifier:
+          description: Identifiers and URIs associated with the resource.
+          type: array
+          items:
+            $ref: "#/components/schemas/DescriptiveValue"
+        subject:
+          description: Terms associated with the intellectual content of the resource.
+          type: array
+          items:
+            $ref: "#/components/schemas/DescriptiveValue"
+        access:
+          $ref: "#/components/schemas/DescriptiveAccessMetadata"
+        relatedResource:
+          description: Other resources associated with the described resource.
+          type: array
+          items:
+            $ref: "#/components/schemas/RelatedResource"
+        marcEncodedData:
+          description: Data about the resource represented in MARC fixed fields and codes.
+          type: array
+          items:
+            $ref: "#/components/schemas/DescriptiveValue"
+        adminMetadata:
+          $ref: "#/components/schemas/DescriptiveAdminMetadata"
+        valueAt:
+          description: URL or other pointer to the location of the resource description.
+          type: string
+      required:
+        - title
     RequestDRO:
       description: A request to create a DRO.  This has the same general structure as a DRO but doesn't have externalIdentifier and doesn't require the access subschema. If no access subschema is provided, these values will be inherited from the AdminPolicy.
       type: object
       additionalProperties: false
       properties:
+        cocinaVersion:
+          $ref: '#/components/schemas/CocinaVersion'
         type:
           type: string
           enum:
@@ -1588,7 +1633,7 @@ components:
         administrative:
           $ref: '#/components/schemas/Administrative'
         description:
-          $ref: '#/components/schemas/Description'
+          $ref: '#/components/schemas/RequestDescription'
         identification:
           $ref: '#/components/schemas/RequestIdentification'
         structural:
@@ -1596,6 +1641,7 @@ components:
         geographic:
           $ref: '#/components/schemas/Geographic'
       required:
+        - cocinaVersion
         - administrative
         - identification
         - label
@@ -1619,8 +1665,6 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/Druid'
-        hasAgreement:
-          type: string
     RequestFile:
       type: object
       additionalProperties: false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.62.1
+  version: 0.65.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-16 00:00:00.000000000 Z
+date: 2022-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -170,42 +170,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.93'
+        version: '1.24'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.93'
+        version: '1.24'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.44'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.44'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: '0'
 description: SDR data models that can be validated
 email:
 - jcoyne@justincoyne.com
@@ -266,6 +280,7 @@ files:
 - lib/cocina/models/catkey_barcode.rb
 - lib/cocina/models/checkable.rb
 - lib/cocina/models/citation_only_access.rb
+- lib/cocina/models/cocina_version.rb
 - lib/cocina/models/collection.rb
 - lib/cocina/models/collection_access.rb
 - lib/cocina/models/collection_identification.rb
@@ -309,6 +324,7 @@ files:
 - lib/cocina/models/release_tag.rb
 - lib/cocina/models/request_admin_policy.rb
 - lib/cocina/models/request_collection.rb
+- lib/cocina/models/request_description.rb
 - lib/cocina/models/request_dro.rb
 - lib/cocina/models/request_dro_structural.rb
 - lib/cocina/models/request_file.rb
@@ -329,7 +345,8 @@ files:
 - openapi.yml
 homepage: https://github.com/sul-dlss/cocina-models
 licenses: []
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -338,14 +355,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Data models for the SDR