cocina-models 0.108.2 → 0.108.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/openapi.yml CHANGED
@@ -5,7 +5,7 @@ info:
5
5
  title: Cocina Models
6
6
  license:
7
7
  name: Apache 2.0
8
- url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
8
+ url: "http://www.apache.org/licenses/LICENSE-2.0.html"
9
9
  paths:
10
10
  /validate/DRO:
11
11
  post:
@@ -15,9 +15,9 @@ paths:
15
15
  content:
16
16
  application/json:
17
17
  schema:
18
- $ref: '#/components/schemas/DRO'
18
+ $ref: "#/components/schemas/DRO"
19
19
  responses:
20
- '200':
20
+ "200":
21
21
  description: noop
22
22
  /validate/RequestDRO:
23
23
  post:
@@ -27,9 +27,9 @@ paths:
27
27
  content:
28
28
  application/json:
29
29
  schema:
30
- $ref: '#/components/schemas/RequestDRO'
30
+ $ref: "#/components/schemas/RequestDRO"
31
31
  responses:
32
- '200':
32
+ "200":
33
33
  description: noop
34
34
  /validate/DROWithMetadata:
35
35
  post:
@@ -39,9 +39,9 @@ paths:
39
39
  content:
40
40
  application/json:
41
41
  schema:
42
- $ref: '#/components/schemas/DROWithMetadata'
42
+ $ref: "#/components/schemas/DROWithMetadata"
43
43
  responses:
44
- '200':
44
+ "200":
45
45
  description: noop
46
46
  /validate/Collection:
47
47
  post:
@@ -51,9 +51,9 @@ paths:
51
51
  content:
52
52
  application/json:
53
53
  schema:
54
- $ref: '#/components/schemas/Collection'
54
+ $ref: "#/components/schemas/Collection"
55
55
  responses:
56
- '200':
56
+ "200":
57
57
  description: noop
58
58
  /validate/RequestCollection:
59
59
  post:
@@ -63,9 +63,9 @@ paths:
63
63
  content:
64
64
  application/json:
65
65
  schema:
66
- $ref: '#/components/schemas/RequestCollection'
66
+ $ref: "#/components/schemas/RequestCollection"
67
67
  responses:
68
- '200':
68
+ "200":
69
69
  description: noop
70
70
  /validate/CollectionWithMetadata:
71
71
  post:
@@ -75,9 +75,9 @@ paths:
75
75
  content:
76
76
  application/json:
77
77
  schema:
78
- $ref: '#/components/schemas/CollectionWithMetadata'
78
+ $ref: "#/components/schemas/CollectionWithMetadata"
79
79
  responses:
80
- '200':
80
+ "200":
81
81
  description: noop
82
82
  /validate/AdminPolicy:
83
83
  post:
@@ -87,9 +87,9 @@ paths:
87
87
  content:
88
88
  application/json:
89
89
  schema:
90
- $ref: '#/components/schemas/AdminPolicy'
90
+ $ref: "#/components/schemas/AdminPolicy"
91
91
  responses:
92
- '200':
92
+ "200":
93
93
  description: noop
94
94
  /validate/RequestAdminPolicy:
95
95
  post:
@@ -99,9 +99,9 @@ paths:
99
99
  content:
100
100
  application/json:
101
101
  schema:
102
- $ref: '#/components/schemas/RequestAdminPolicy'
102
+ $ref: "#/components/schemas/RequestAdminPolicy"
103
103
  responses:
104
- '200':
104
+ "200":
105
105
  description: noop
106
106
  /validate/AdminPolicyWithMetadata:
107
107
  post:
@@ -111,9 +111,9 @@ paths:
111
111
  content:
112
112
  application/json:
113
113
  schema:
114
- $ref: '#/components/schemas/AdminPolicyWithMetadata'
114
+ $ref: "#/components/schemas/AdminPolicyWithMetadata"
115
115
  responses:
116
- '200':
116
+ "200":
117
117
  description: noop
118
118
  /validate/Description:
119
119
  post:
@@ -123,9 +123,9 @@ paths:
123
123
  content:
124
124
  application/json:
125
125
  schema:
126
- $ref: '#/components/schemas/Description'
126
+ $ref: "#/components/schemas/Description"
127
127
  responses:
128
- '200':
128
+ "200":
129
129
  description: noop
130
130
  /validate/RequestDescription:
131
131
  post:
@@ -135,9 +135,9 @@ paths:
135
135
  content:
136
136
  application/json:
137
137
  schema:
138
- $ref: '#/components/schemas/RequestDescription'
138
+ $ref: "#/components/schemas/RequestDescription"
139
139
  responses:
140
- '200':
140
+ "200":
141
141
  description: noop
142
142
  components:
143
143
  schemas:
@@ -145,13 +145,13 @@ components:
145
145
  type: object
146
146
  oneOf:
147
147
  # Being first, makes DarkAccess the default.
148
- - $ref: '#/components/schemas/DarkAccess'
149
- - $ref: '#/components/schemas/CitationOnlyAccess'
150
- - $ref: '#/components/schemas/ControlledDigitalLendingAccess'
151
- - $ref: '#/components/schemas/LocationBasedAccess'
152
- - $ref: '#/components/schemas/LocationBasedDownloadAccess'
153
- - $ref: '#/components/schemas/StanfordAccess'
154
- - $ref: '#/components/schemas/WorldAccess'
148
+ - $ref: "#/components/schemas/DarkAccess"
149
+ - $ref: "#/components/schemas/CitationOnlyAccess"
150
+ - $ref: "#/components/schemas/ControlledDigitalLendingAccess"
151
+ - $ref: "#/components/schemas/LocationBasedAccess"
152
+ - $ref: "#/components/schemas/LocationBasedDownloadAccess"
153
+ - $ref: "#/components/schemas/StanfordAccess"
154
+ - $ref: "#/components/schemas/WorldAccess"
155
155
  AccessRole:
156
156
  description: Access role conferred by an AdminPolicy to objects within it. (used by Argo)
157
157
  type: object
@@ -161,22 +161,22 @@ components:
161
161
  description: Name of role
162
162
  type: string
163
163
  enum:
164
- - 'dor-apo-depositor'
165
- - 'dor-apo-manager'
166
- - 'dor-apo-viewer'
167
- - 'sdr-administrator'
168
- - 'sdr-viewer'
169
- - 'hydrus-collection-creator'
170
- - 'hydrus-collection-manager'
171
- - 'hydrus-collection-depositor'
172
- - 'hydrus-collection-item-depositor'
173
- - 'hydrus-collection-reviewer'
174
- - 'hydrus-collection-viewer'
164
+ - "dor-apo-depositor"
165
+ - "dor-apo-manager"
166
+ - "dor-apo-viewer"
167
+ - "sdr-administrator"
168
+ - "sdr-viewer"
169
+ - "hydrus-collection-creator"
170
+ - "hydrus-collection-manager"
171
+ - "hydrus-collection-depositor"
172
+ - "hydrus-collection-item-depositor"
173
+ - "hydrus-collection-reviewer"
174
+ - "hydrus-collection-viewer"
175
175
  members:
176
176
  description: The users and groups that are members of the role
177
177
  type: array
178
178
  items:
179
- $ref: '#/components/schemas/AccessRoleMember'
179
+ $ref: "#/components/schemas/AccessRoleMember"
180
180
  required:
181
181
  - members
182
182
  - name
@@ -189,8 +189,8 @@ components:
189
189
  description: Name of role
190
190
  type: string
191
191
  enum:
192
- - 'sunetid'
193
- - 'workgroup'
192
+ - "sunetid"
193
+ - "workgroup"
194
194
  identifier:
195
195
  type: string
196
196
  required:
@@ -201,21 +201,21 @@ components:
201
201
  additionalProperties: false
202
202
  properties:
203
203
  cocinaVersion:
204
- $ref: '#/components/schemas/CocinaVersion'
204
+ $ref: "#/components/schemas/CocinaVersion"
205
205
  type:
206
206
  type: string
207
207
  enum:
208
- - 'https://cocina.sul.stanford.edu/models/admin_policy'
208
+ - "https://cocina.sul.stanford.edu/models/admin_policy"
209
209
  externalIdentifier:
210
- $ref: '#/components/schemas/Druid'
210
+ $ref: "#/components/schemas/Druid"
211
211
  label:
212
212
  type: string
213
213
  version:
214
214
  type: integer
215
215
  administrative:
216
- $ref: '#/components/schemas/AdminPolicyAdministrative'
216
+ $ref: "#/components/schemas/AdminPolicyAdministrative"
217
217
  description:
218
- $ref: '#/components/schemas/Description'
218
+ $ref: "#/components/schemas/Description"
219
219
  required:
220
220
  - cocinaVersion
221
221
  - administrative
@@ -228,21 +228,21 @@ components:
228
228
  additionalProperties: false
229
229
  properties:
230
230
  hasAdminPolicy:
231
- $ref: '#/components/schemas/Druid'
231
+ $ref: "#/components/schemas/Druid"
232
232
  required:
233
233
  - hasAdminPolicy
234
234
  AdminPolicyAccessTemplate:
235
- description: '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.'
235
+ description: "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."
236
236
  type: object
237
237
  additionalProperties: false
238
238
  oneOf:
239
- - $ref: '#/components/schemas/DarkAccess'
240
- - $ref: '#/components/schemas/CitationOnlyAccess'
241
- - $ref: '#/components/schemas/ControlledDigitalLendingAccess'
242
- - $ref: '#/components/schemas/LocationBasedAccess'
243
- - $ref: '#/components/schemas/LocationBasedDownloadAccess'
244
- - $ref: '#/components/schemas/StanfordAccess'
245
- - $ref: '#/components/schemas/WorldAccess'
239
+ - $ref: "#/components/schemas/DarkAccess"
240
+ - $ref: "#/components/schemas/CitationOnlyAccess"
241
+ - $ref: "#/components/schemas/ControlledDigitalLendingAccess"
242
+ - $ref: "#/components/schemas/LocationBasedAccess"
243
+ - $ref: "#/components/schemas/LocationBasedDownloadAccess"
244
+ - $ref: "#/components/schemas/StanfordAccess"
245
+ - $ref: "#/components/schemas/WorldAccess"
246
246
  properties:
247
247
  copyright:
248
248
  $ref: "#/components/schemas/Copyright"
@@ -256,7 +256,7 @@ components:
256
256
  additionalProperties: false
257
257
  properties:
258
258
  accessTemplate:
259
- $ref: '#/components/schemas/AdminPolicyAccessTemplate'
259
+ $ref: "#/components/schemas/AdminPolicyAccessTemplate"
260
260
  registrationWorkflow:
261
261
  description: When you register an item with this admin policy, these are the workflows that are available.
262
262
  type: array
@@ -272,14 +272,14 @@ components:
272
272
  items:
273
273
  type: string
274
274
  hasAdminPolicy:
275
- $ref: '#/components/schemas/Druid'
275
+ $ref: "#/components/schemas/Druid"
276
276
  hasAgreement:
277
- $ref: '#/components/schemas/Druid'
277
+ $ref: "#/components/schemas/Druid"
278
278
  roles:
279
279
  description: The access roles conferred by this AdminPolicy (used by Argo)
280
280
  type: array
281
281
  items:
282
- $ref: '#/components/schemas/AccessRole'
282
+ $ref: "#/components/schemas/AccessRole"
283
283
  required:
284
284
  - hasAdminPolicy
285
285
  - hasAgreement
@@ -293,7 +293,8 @@ components:
293
293
  - $ref: "#/components/schemas/AdminPolicy"
294
294
  - $ref: "#/components/schemas/ObjectMetadata"
295
295
  AppliesTo:
296
- description: Property model for indicating the parts, aspects, or versions of the resource to which a
296
+ description:
297
+ Property model for indicating the parts, aspects, or versions of the resource to which a
297
298
  descriptive element is applicable.
298
299
  type: object
299
300
  additionalProperties: false
@@ -303,27 +304,27 @@ components:
303
304
  items:
304
305
  $ref: "#/components/schemas/DescriptiveBasicValue"
305
306
  Barcode:
306
- description: 'A barcode'
307
+ description: "A barcode"
307
308
  oneOf:
308
- - $ref: '#/components/schemas/BusinessBarcode'
309
- - $ref: '#/components/schemas/LaneMedicalBarcode'
310
- - $ref: '#/components/schemas/CatkeyBarcode'
311
- - $ref: '#/components/schemas/StandardBarcode'
309
+ - $ref: "#/components/schemas/BusinessBarcode"
310
+ - $ref: "#/components/schemas/LaneMedicalBarcode"
311
+ - $ref: "#/components/schemas/CatkeyBarcode"
312
+ - $ref: "#/components/schemas/StandardBarcode"
312
313
  BusinessBarcode:
313
314
  description: The barcode associated with a business library DRO object, prefixed with 2050
314
315
  type: string
315
- pattern: '^2050[0-9]{7}$'
316
- example: '20503740296'
316
+ pattern: "^2050[0-9]{7}$"
317
+ example: "20503740296"
317
318
  CatalogLink:
318
- description: 'A linkage between an object and a catalog record'
319
+ description: "A linkage between an object and a catalog record"
319
320
  oneOf:
320
- - $ref: '#/components/schemas/FolioCatalogLink'
321
- - $ref: '#/components/schemas/SymphonyCatalogLink'
321
+ - $ref: "#/components/schemas/FolioCatalogLink"
322
+ - $ref: "#/components/schemas/SymphonyCatalogLink"
322
323
  CatkeyBarcode:
323
324
  description: The barcode associated with a DRO object based on catkey, prefixed with a catkey followed by a hyphen
324
325
  type: string
325
- pattern: '^[0-9]+-[0-9]+$'
326
- example: '6772719-1001'
326
+ pattern: "^[0-9]+-[0-9]+$"
327
+ example: "6772719-1001"
327
328
  CitationOnlyAccess:
328
329
  description: 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
329
330
  type: object
@@ -337,7 +338,7 @@ components:
337
338
  description: Download access level.
338
339
  type: string
339
340
  enum:
340
- - 'none'
341
+ - "none"
341
342
  location:
342
343
  description: Not used for this access type, must be null.
343
344
  type: string
@@ -356,25 +357,25 @@ components:
356
357
  description: The version of Cocina with which this object conforms.
357
358
  type: string
358
359
  pattern: '^\d+\.\d+\.\d+$'
359
- example: '1.2.3'
360
+ example: "1.2.3"
360
361
  Collection:
361
362
  description: A group of Digital Repository Objects that indicate some type of conceptual grouping within the domain that is worth reusing across the system.
362
363
  type: object
363
364
  additionalProperties: false
364
365
  properties:
365
366
  cocinaVersion:
366
- $ref: '#/components/schemas/CocinaVersion'
367
+ $ref: "#/components/schemas/CocinaVersion"
367
368
  type:
368
369
  description: The content type of the Collection. Selected from an established set of values.
369
370
  type: string
370
371
  enum:
371
- - 'https://cocina.sul.stanford.edu/models/collection'
372
- - 'https://cocina.sul.stanford.edu/models/curated-collection'
373
- - 'https://cocina.sul.stanford.edu/models/user-collection'
374
- - 'https://cocina.sul.stanford.edu/models/exhibit'
375
- - 'https://cocina.sul.stanford.edu/models/series'
372
+ - "https://cocina.sul.stanford.edu/models/collection"
373
+ - "https://cocina.sul.stanford.edu/models/curated-collection"
374
+ - "https://cocina.sul.stanford.edu/models/user-collection"
375
+ - "https://cocina.sul.stanford.edu/models/exhibit"
376
+ - "https://cocina.sul.stanford.edu/models/series"
376
377
  externalIdentifier:
377
- $ref: '#/components/schemas/Druid'
378
+ $ref: "#/components/schemas/Druid"
378
379
  label:
379
380
  description: Primary processing label (can be same as title) for a Collection.
380
381
  type: string
@@ -382,13 +383,13 @@ components:
382
383
  description: Version for the Collection within SDR.
383
384
  type: integer
384
385
  access:
385
- $ref: '#/components/schemas/CollectionAccess'
386
+ $ref: "#/components/schemas/CollectionAccess"
386
387
  administrative:
387
- $ref: '#/components/schemas/Administrative'
388
+ $ref: "#/components/schemas/Administrative"
388
389
  description:
389
- $ref: '#/components/schemas/Description'
390
+ $ref: "#/components/schemas/Description"
390
391
  identification:
391
- $ref: '#/components/schemas/CollectionIdentification'
392
+ $ref: "#/components/schemas/CollectionIdentification"
392
393
  required:
393
394
  - cocinaVersion
394
395
  - description
@@ -408,9 +409,9 @@ components:
408
409
  description: Access level
409
410
  type: string
410
411
  enum:
411
- - 'world'
412
- - 'dark'
413
- default: 'dark'
412
+ - "world"
413
+ - "dark"
414
+ default: "dark"
414
415
  copyright:
415
416
  $ref: "#/components/schemas/Copyright"
416
417
  useAndReproductionStatement:
@@ -424,9 +425,9 @@ components:
424
425
  catalogLinks:
425
426
  type: array
426
427
  items:
427
- $ref: '#/components/schemas/CatalogLink'
428
+ $ref: "#/components/schemas/CatalogLink"
428
429
  sourceId:
429
- $ref: '#/components/schemas/SourceId'
430
+ $ref: "#/components/schemas/SourceId"
430
431
  # CollectionWithMetadata schema should not be copied to sdr-api and dor-services-app.
431
432
  CollectionWithMetadata:
432
433
  description: Collection with addition object metadata.
@@ -436,7 +437,8 @@ components:
436
437
  - $ref: "#/components/schemas/Collection"
437
438
  - $ref: "#/components/schemas/ObjectMetadata"
438
439
  Contributor:
439
- description: Property model for describing agents contributing in some way to
440
+ description:
441
+ Property model for describing agents contributing in some way to
440
442
  the creation and history of the resource.
441
443
  type: object
442
444
  additionalProperties: false
@@ -450,11 +452,13 @@ components:
450
452
  description: 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.
451
453
  type: string
452
454
  status:
453
- description: Status of the contributor relative to other parallel contributors
455
+ description:
456
+ Status of the contributor relative to other parallel contributors
454
457
  (e.g. the primary author among a group of contributors).
455
458
  type: string
456
459
  role:
457
- description: Relationships of the contributor to the resource or to an event
460
+ description:
461
+ Relationships of the contributor to the resource or to an event
458
462
  in its history.
459
463
  type: array
460
464
  items:
@@ -517,47 +521,47 @@ components:
517
521
  description: A record identifier created in Folio
518
522
  type: string
519
523
  pattern: '^in\d+$'
520
- example: 'in11403803'
524
+ example: "in11403803"
521
525
  DOI:
522
526
  description: Digital Object Identifier (https://www.doi.org)
523
527
  oneOf:
524
- - $ref: '#/components/schemas/RepositoryDOI'
525
- - $ref: '#/components/schemas/PreregisteredRepositoryDOI'
526
- - $ref: '#/components/schemas/LibrariesDOI'
527
- - $ref: '#/components/schemas/DOIExceptions'
528
+ - $ref: "#/components/schemas/RepositoryDOI"
529
+ - $ref: "#/components/schemas/PreregisteredRepositoryDOI"
530
+ - $ref: "#/components/schemas/LibrariesDOI"
531
+ - $ref: "#/components/schemas/DOIExceptions"
528
532
  DOIExceptions:
529
533
  type: string
530
534
  description: "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."
531
535
  pattern: '^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$'
532
- example: '10.18735/0mw1-qq72'
536
+ example: "10.18735/0mw1-qq72"
533
537
  DRO:
534
538
  description: Domain-defined abstraction of a 'work'. Digital Repository Objects' abstraction is describable for our domain’s purposes, i.e. for management needs within our system.
535
539
  type: object
536
540
  additionalProperties: false
537
541
  properties:
538
542
  cocinaVersion:
539
- $ref: '#/components/schemas/CocinaVersion'
543
+ $ref: "#/components/schemas/CocinaVersion"
540
544
  type:
541
545
  description: The content type of the DRO. Selected from an established set of values.
542
546
  type: string
543
547
  enum:
544
- - 'https://cocina.sul.stanford.edu/models/object'
545
- - 'https://cocina.sul.stanford.edu/models/3d'
546
- - 'https://cocina.sul.stanford.edu/models/agreement'
547
- - 'https://cocina.sul.stanford.edu/models/book'
548
- - 'https://cocina.sul.stanford.edu/models/document'
549
- - 'https://cocina.sul.stanford.edu/models/geo'
550
- - 'https://cocina.sul.stanford.edu/models/image'
551
- - 'https://cocina.sul.stanford.edu/models/page'
552
- - 'https://cocina.sul.stanford.edu/models/photograph'
553
- - 'https://cocina.sul.stanford.edu/models/manuscript'
554
- - 'https://cocina.sul.stanford.edu/models/map'
555
- - 'https://cocina.sul.stanford.edu/models/media'
556
- - 'https://cocina.sul.stanford.edu/models/track'
557
- - 'https://cocina.sul.stanford.edu/models/webarchive-binary'
558
- - 'https://cocina.sul.stanford.edu/models/webarchive-seed'
548
+ - "https://cocina.sul.stanford.edu/models/object"
549
+ - "https://cocina.sul.stanford.edu/models/3d"
550
+ - "https://cocina.sul.stanford.edu/models/agreement"
551
+ - "https://cocina.sul.stanford.edu/models/book"
552
+ - "https://cocina.sul.stanford.edu/models/document"
553
+ - "https://cocina.sul.stanford.edu/models/geo"
554
+ - "https://cocina.sul.stanford.edu/models/image"
555
+ - "https://cocina.sul.stanford.edu/models/page"
556
+ - "https://cocina.sul.stanford.edu/models/photograph"
557
+ - "https://cocina.sul.stanford.edu/models/manuscript"
558
+ - "https://cocina.sul.stanford.edu/models/map"
559
+ - "https://cocina.sul.stanford.edu/models/media"
560
+ - "https://cocina.sul.stanford.edu/models/track"
561
+ - "https://cocina.sul.stanford.edu/models/webarchive-binary"
562
+ - "https://cocina.sul.stanford.edu/models/webarchive-seed"
559
563
  externalIdentifier:
560
- $ref: '#/components/schemas/Druid'
564
+ $ref: "#/components/schemas/Druid"
561
565
  label:
562
566
  description: Primary processing label (can be same as title) for a DRO.
563
567
  type: string
@@ -565,17 +569,17 @@ components:
565
569
  description: Version for the DRO within SDR.
566
570
  type: integer
567
571
  access:
568
- $ref: '#/components/schemas/DROAccess'
572
+ $ref: "#/components/schemas/DROAccess"
569
573
  administrative:
570
- $ref: '#/components/schemas/Administrative'
574
+ $ref: "#/components/schemas/Administrative"
571
575
  description:
572
- $ref: '#/components/schemas/Description'
576
+ $ref: "#/components/schemas/Description"
573
577
  identification:
574
- $ref: '#/components/schemas/Identification'
578
+ $ref: "#/components/schemas/Identification"
575
579
  structural:
576
- $ref: '#/components/schemas/DROStructural'
580
+ $ref: "#/components/schemas/DROStructural"
577
581
  geographic:
578
- $ref: '#/components/schemas/Geographic'
582
+ $ref: "#/components/schemas/Geographic"
579
583
  required:
580
584
  - cocinaVersion
581
585
  - access
@@ -597,7 +601,7 @@ components:
597
601
  copyright:
598
602
  $ref: "#/components/schemas/Copyright"
599
603
  embargo:
600
- $ref: '#/components/schemas/Embargo'
604
+ $ref: "#/components/schemas/Embargo"
601
605
  useAndReproductionStatement:
602
606
  $ref: "#/components/schemas/UseAndReproductionStatement"
603
607
  license:
@@ -611,17 +615,17 @@ components:
611
615
  description: Filesets that contain the digital representations (Files)
612
616
  type: array
613
617
  items:
614
- $ref: '#/components/schemas/FileSet'
618
+ $ref: "#/components/schemas/FileSet"
615
619
  hasMemberOrders:
616
620
  description: Provided sequences or orderings of members, including some metadata about each sequence (i.e. sequence label, sequence type, if the sequence is primary, etc.).
617
621
  type: array
618
622
  items:
619
- $ref: '#/components/schemas/Sequence'
623
+ $ref: "#/components/schemas/Sequence"
620
624
  isMemberOf:
621
625
  description: Collections that this DRO is a member of
622
626
  type: array
623
627
  items:
624
- $ref: '#/components/schemas/Druid'
628
+ $ref: "#/components/schemas/Druid"
625
629
  # DROWithMetadata schema should not be copied to sdr-api and dor-services-app.
626
630
  DROWithMetadata:
627
631
  description: DRO with addition object metadata.
@@ -636,15 +640,15 @@ components:
636
640
  view:
637
641
  description: Access level.
638
642
  type: string
639
- default: 'dark'
643
+ default: "dark"
640
644
  enum:
641
645
  - dark
642
646
  download:
643
647
  description: Download access level.
644
648
  type: string
645
- default: 'none'
649
+ default: "none"
646
650
  enum:
647
- - 'none'
651
+ - "none"
648
652
  location:
649
653
  description: Not used for this access type, must be null.
650
654
  type: string
@@ -756,7 +760,7 @@ components:
756
760
  value:
757
761
  description: String or integer value of the descriptive element.
758
762
  oneOf:
759
- - type: string
763
+ - type: string
760
764
  # Title note (nonsorting character count) was supposed to be able to accept an integer value,
761
765
  # but this triggered a bug in committee:
762
766
  # https://github.com/interagent/committee/issues/286
@@ -765,7 +769,8 @@ components:
765
769
  description: 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.
766
770
  type: string
767
771
  status:
768
- description: Status of the descriptive element value relative to other instances
772
+ description:
773
+ Status of the descriptive element value relative to other instances
769
774
  of the element.
770
775
  type: string
771
776
  code:
@@ -785,7 +790,7 @@ components:
785
790
  description: Identifiers and URIs associated with the descriptive element.
786
791
  type: array
787
792
  items:
788
- $ref: "#/components/schemas/DescriptiveValue"
793
+ $ref: "#/components/schemas/DescriptiveValue"
789
794
  source:
790
795
  $ref: "#/components/schemas/Source"
791
796
  displayLabel:
@@ -942,13 +947,13 @@ components:
942
947
  - type: object
943
948
  properties:
944
949
  valueScript:
945
- $ref: '#/components/schemas/Standard'
950
+ $ref: "#/components/schemas/Standard"
946
951
  # description: An alphabet or other notation used to represent a
947
952
  # language or other symbolic system of the descriptive element value.
948
953
  Druid:
949
954
  type: string
950
- pattern: '^druid:[b-df-hjkmnp-tv-z]{2}[0-9]{3}[b-df-hjkmnp-tv-z]{2}[0-9]{4}$'
951
- example: 'druid:bc123df4567'
955
+ pattern: "^druid:[b-df-hjkmnp-tv-z]{2}[0-9]{3}[b-df-hjkmnp-tv-z]{2}[0-9]{4}$"
956
+ example: "druid:bc123df4567"
952
957
  Embargo:
953
958
  type: object
954
959
  additionalProperties: false
@@ -960,7 +965,7 @@ components:
960
965
  description: Date when the Collection is released from an embargo.
961
966
  type: string
962
967
  format: date-time
963
- example: '2029-06-22T07:00:00.000+00:00'
968
+ example: "2029-06-22T07:00:00.000+00:00"
964
969
  useAndReproductionStatement:
965
970
  $ref: "#/components/schemas/UseAndReproductionStatement"
966
971
  required:
@@ -1022,7 +1027,7 @@ components:
1022
1027
  description: The content type of the File.
1023
1028
  type: string
1024
1029
  enum:
1025
- - 'https://cocina.sul.stanford.edu/models/file'
1030
+ - "https://cocina.sul.stanford.edu/models/file"
1026
1031
  externalIdentifier:
1027
1032
  description: 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.
1028
1033
  type: string
@@ -1042,9 +1047,9 @@ components:
1042
1047
  description: MIME Type of the File.
1043
1048
  type: string
1044
1049
  languageTag:
1045
- $ref: '#/components/schemas/LanguageTag'
1050
+ $ref: "#/components/schemas/LanguageTag"
1046
1051
  use:
1047
- $ref: '#/components/schemas/FileUse'
1052
+ $ref: "#/components/schemas/FileUse"
1048
1053
  sdrGeneratedText:
1049
1054
  description: Indicates if the text (OCR/captioning) was generated by SDR.
1050
1055
  type: boolean
@@ -1056,13 +1061,13 @@ components:
1056
1061
  hasMessageDigests:
1057
1062
  type: array
1058
1063
  items:
1059
- $ref: '#/components/schemas/MessageDigest'
1064
+ $ref: "#/components/schemas/MessageDigest"
1060
1065
  access:
1061
- $ref: '#/components/schemas/FileAccess'
1066
+ $ref: "#/components/schemas/FileAccess"
1062
1067
  administrative:
1063
- $ref: '#/components/schemas/FileAdministrative'
1068
+ $ref: "#/components/schemas/FileAdministrative"
1064
1069
  presentation:
1065
- $ref: '#/components/schemas/Presentation'
1070
+ $ref: "#/components/schemas/Presentation"
1066
1071
  required:
1067
1072
  - externalIdentifier
1068
1073
  - label
@@ -1078,12 +1083,12 @@ components:
1078
1083
  additionalProperties: false
1079
1084
  oneOf:
1080
1085
  # Being first, makes DarkAccess the default.
1081
- - $ref: '#/components/schemas/DarkAccess'
1082
- - $ref: '#/components/schemas/ControlledDigitalLendingAccess'
1083
- - $ref: '#/components/schemas/LocationBasedAccess'
1084
- - $ref: '#/components/schemas/LocationBasedDownloadAccess'
1085
- - $ref: '#/components/schemas/StanfordAccess'
1086
- - $ref: '#/components/schemas/WorldAccess'
1086
+ - $ref: "#/components/schemas/DarkAccess"
1087
+ - $ref: "#/components/schemas/ControlledDigitalLendingAccess"
1088
+ - $ref: "#/components/schemas/LocationBasedAccess"
1089
+ - $ref: "#/components/schemas/LocationBasedDownloadAccess"
1090
+ - $ref: "#/components/schemas/StanfordAccess"
1091
+ - $ref: "#/components/schemas/WorldAccess"
1087
1092
  FileAdministrative:
1088
1093
  type: object
1089
1094
  additionalProperties: false
@@ -1110,18 +1115,18 @@ components:
1110
1115
  description: The content type of the Fileset.
1111
1116
  type: string
1112
1117
  enum:
1113
- - 'https://cocina.sul.stanford.edu/models/resources/audio'
1114
- - 'https://cocina.sul.stanford.edu/models/resources/attachment'
1115
- - 'https://cocina.sul.stanford.edu/models/resources/document'
1116
- - 'https://cocina.sul.stanford.edu/models/resources/file'
1117
- - 'https://cocina.sul.stanford.edu/models/resources/image'
1118
- - 'https://cocina.sul.stanford.edu/models/resources/media'
1119
- - 'https://cocina.sul.stanford.edu/models/resources/object'
1120
- - 'https://cocina.sul.stanford.edu/models/resources/page'
1121
- - 'https://cocina.sul.stanford.edu/models/resources/preview'
1122
- - 'https://cocina.sul.stanford.edu/models/resources/3d'
1123
- - 'https://cocina.sul.stanford.edu/models/resources/thumb'
1124
- - 'https://cocina.sul.stanford.edu/models/resources/video'
1118
+ - "https://cocina.sul.stanford.edu/models/resources/audio"
1119
+ - "https://cocina.sul.stanford.edu/models/resources/attachment"
1120
+ - "https://cocina.sul.stanford.edu/models/resources/document"
1121
+ - "https://cocina.sul.stanford.edu/models/resources/file"
1122
+ - "https://cocina.sul.stanford.edu/models/resources/image"
1123
+ - "https://cocina.sul.stanford.edu/models/resources/media"
1124
+ - "https://cocina.sul.stanford.edu/models/resources/object"
1125
+ - "https://cocina.sul.stanford.edu/models/resources/page"
1126
+ - "https://cocina.sul.stanford.edu/models/resources/preview"
1127
+ - "https://cocina.sul.stanford.edu/models/resources/3d"
1128
+ - "https://cocina.sul.stanford.edu/models/resources/thumb"
1129
+ - "https://cocina.sul.stanford.edu/models/resources/video"
1125
1130
  externalIdentifier:
1126
1131
  type: string
1127
1132
  label:
@@ -1131,7 +1136,7 @@ components:
1131
1136
  description: Version for the Fileset within SDR.
1132
1137
  type: integer
1133
1138
  structural:
1134
- $ref: '#/components/schemas/FileSetStructural'
1139
+ $ref: "#/components/schemas/FileSetStructural"
1135
1140
  required:
1136
1141
  - externalIdentifier
1137
1142
  - label
@@ -1146,7 +1151,7 @@ components:
1146
1151
  contains:
1147
1152
  type: array
1148
1153
  items:
1149
- $ref: '#/components/schemas/File'
1154
+ $ref: "#/components/schemas/File"
1150
1155
  FileUse:
1151
1156
  description: Use for the File (e.g. "transcription" for OCR).
1152
1157
  type: string
@@ -1164,7 +1169,8 @@ components:
1164
1169
  - previous folio
1165
1170
  example: folio
1166
1171
  refresh:
1167
- description: Only one of the Folio instance HRIDs should be designated for refreshing.
1172
+ description:
1173
+ Only one of the Folio instance HRIDs should be designated for refreshing.
1168
1174
  This means that this HRID is the one used to pull metadata from the catalog
1169
1175
  if there is more than one HRID present.
1170
1176
  type: boolean
@@ -1172,9 +1178,9 @@ components:
1172
1178
  catalogRecordId:
1173
1179
  description: Record identifier that is unique within the context of the linked record's catalog.
1174
1180
  oneOf:
1175
- - $ref: '#/components/schemas/MigratedFromSymphonyIdentifier'
1176
- - $ref: '#/components/schemas/MigratedFromVoyagerIdentifier'
1177
- - $ref: '#/components/schemas/CreatedInFolioIdentifier'
1181
+ - $ref: "#/components/schemas/MigratedFromSymphonyIdentifier"
1182
+ - $ref: "#/components/schemas/MigratedFromVoyagerIdentifier"
1183
+ - $ref: "#/components/schemas/CreatedInFolioIdentifier"
1178
1184
  partLabel:
1179
1185
  description: Label for use in display of serials via Folio record
1180
1186
  type: string
@@ -1200,24 +1206,25 @@ components:
1200
1206
  additionalProperties: false
1201
1207
  properties:
1202
1208
  barcode:
1203
- $ref: '#/components/schemas/Barcode'
1209
+ $ref: "#/components/schemas/Barcode"
1204
1210
  catalogLinks:
1205
1211
  type: array
1206
1212
  items:
1207
- $ref: '#/components/schemas/CatalogLink'
1213
+ $ref: "#/components/schemas/CatalogLink"
1208
1214
  doi:
1209
- $ref: '#/components/schemas/DOI'
1215
+ $ref: "#/components/schemas/DOI"
1210
1216
  sourceId:
1211
- $ref: '#/components/schemas/SourceId'
1217
+ $ref: "#/components/schemas/SourceId"
1212
1218
  required:
1213
1219
  - sourceId
1214
1220
  LaneMedicalBarcode:
1215
1221
  description: The barcode associated with a Lane Medical Library DRO object, prefixed with 245
1216
1222
  type: string
1217
- pattern: '^245[0-9]{8}$'
1218
- example: '24503259768'
1223
+ pattern: "^245[0-9]{8}$"
1224
+ example: "24503259768"
1219
1225
  Language:
1220
- description: Languages, scripts, symbolic systems, and notations used in all
1226
+ description:
1227
+ Languages, scripts, symbolic systems, and notations used in all
1221
1228
  or part of a resource or its descriptive metadata.
1222
1229
  type: object
1223
1230
  additionalProperties: false
@@ -1254,7 +1261,7 @@ components:
1254
1261
  type: string
1255
1262
  description: present for mapping to additional schemas in the future and for consistency but not otherwise used
1256
1263
  script:
1257
- $ref: '#/components/schemas/DescriptiveValue'
1264
+ $ref: "#/components/schemas/DescriptiveValue"
1258
1265
  # description: An alphabet or other notation used to represent a
1259
1266
  # language or other symbolic system associated with the resource.
1260
1267
  source:
@@ -1291,44 +1298,44 @@ components:
1291
1298
  nullable: true
1292
1299
  LibrariesDOI:
1293
1300
  type: string
1294
- description: '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.'
1301
+ description: "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."
1295
1302
  pattern: '^10\.25936\/[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}$'
1296
- example: '10.25936/629T-bx79'
1303
+ example: "10.25936/629T-bx79"
1297
1304
  License:
1298
1305
  description: The license governing reuse of the DRO. Should be an IRI for known licenses (i.e. CC, RightsStatement.org URI, etc.).
1299
1306
  type: string
1300
1307
  nullable: true
1301
1308
  enum:
1302
- - 'https://www.gnu.org/licenses/agpl.txt'
1303
- - 'https://www.apache.org/licenses/LICENSE-2.0'
1304
- - 'https://opensource.org/licenses/BSD-2-Clause'
1305
- - 'https://opensource.org/licenses/BSD-3-Clause'
1306
- - 'https://creativecommons.org/licenses/by/4.0/legalcode'
1307
- - 'https://creativecommons.org/licenses/by-nc/4.0/legalcode'
1308
- - 'https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode'
1309
- - 'https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode'
1310
- - 'https://creativecommons.org/licenses/by-nd/4.0/legalcode'
1311
- - 'https://creativecommons.org/licenses/by-sa/4.0/legalcode'
1312
- - 'https://creativecommons.org/publicdomain/zero/1.0/legalcode'
1313
- - 'https://opensource.org/licenses/cddl1'
1314
- - 'https://www.eclipse.org/legal/epl-2.0'
1315
- - 'https://www.gnu.org/licenses/gpl-3.0-standalone.html'
1316
- - 'https://www.isc.org/downloads/software-support-policy/isc-license/'
1317
- - 'https://www.gnu.org/licenses/lgpl-3.0-standalone.html'
1318
- - 'https://opensource.org/licenses/MIT'
1319
- - 'https://www.mozilla.org/MPL/2.0/'
1320
- - 'https://opendatacommons.org/licenses/by/1-0/'
1321
- - 'http://opendatacommons.org/licenses/odbl/1.0/' # Non cannonical, but in some of our data
1322
- - 'https://opendatacommons.org/licenses/odbl/1-0/'
1323
- - 'https://creativecommons.org/publicdomain/mark/1.0/'
1324
- - 'https://opendatacommons.org/licenses/pddl/1-0/'
1325
- - 'https://creativecommons.org/licenses/by/3.0/legalcode'
1326
- - 'https://creativecommons.org/licenses/by-sa/3.0/legalcode'
1327
- - 'https://creativecommons.org/licenses/by-nd/3.0/legalcode'
1328
- - 'https://creativecommons.org/licenses/by-nc/3.0/legalcode'
1329
- - 'https://creativecommons.org/licenses/by-nc-sa/3.0/legalcode'
1330
- - 'https://creativecommons.org/licenses/by-nc-nd/3.0/legalcode'
1331
- - 'https://cocina.sul.stanford.edu/licenses/none' # Only used in some legacy ETDs and not actually permitted per the Project Chimera docs.
1309
+ - "https://www.gnu.org/licenses/agpl.txt"
1310
+ - "https://www.apache.org/licenses/LICENSE-2.0"
1311
+ - "https://opensource.org/licenses/BSD-2-Clause"
1312
+ - "https://opensource.org/licenses/BSD-3-Clause"
1313
+ - "https://creativecommons.org/licenses/by/4.0/legalcode"
1314
+ - "https://creativecommons.org/licenses/by-nc/4.0/legalcode"
1315
+ - "https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode"
1316
+ - "https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode"
1317
+ - "https://creativecommons.org/licenses/by-nd/4.0/legalcode"
1318
+ - "https://creativecommons.org/licenses/by-sa/4.0/legalcode"
1319
+ - "https://creativecommons.org/publicdomain/zero/1.0/legalcode"
1320
+ - "https://opensource.org/licenses/cddl1"
1321
+ - "https://www.eclipse.org/legal/epl-2.0"
1322
+ - "https://www.gnu.org/licenses/gpl-3.0-standalone.html"
1323
+ - "https://www.isc.org/downloads/software-support-policy/isc-license/"
1324
+ - "https://www.gnu.org/licenses/lgpl-3.0-standalone.html"
1325
+ - "https://opensource.org/licenses/MIT"
1326
+ - "https://www.mozilla.org/MPL/2.0/"
1327
+ - "https://opendatacommons.org/licenses/by/1-0/"
1328
+ - "http://opendatacommons.org/licenses/odbl/1.0/" # Non cannonical, but in some of our data
1329
+ - "https://opendatacommons.org/licenses/odbl/1-0/"
1330
+ - "https://creativecommons.org/publicdomain/mark/1.0/"
1331
+ - "https://opendatacommons.org/licenses/pddl/1-0/"
1332
+ - "https://creativecommons.org/licenses/by/3.0/legalcode"
1333
+ - "https://creativecommons.org/licenses/by-sa/3.0/legalcode"
1334
+ - "https://creativecommons.org/licenses/by-nd/3.0/legalcode"
1335
+ - "https://creativecommons.org/licenses/by-nc/3.0/legalcode"
1336
+ - "https://creativecommons.org/licenses/by-nc-sa/3.0/legalcode"
1337
+ - "https://creativecommons.org/licenses/by-nc-nd/3.0/legalcode"
1338
+ - "https://cocina.sul.stanford.edu/licenses/none" # Only used in some legacy ETDs and not actually permitted per the Project Chimera docs.
1332
1339
  LocationBasedAccess:
1333
1340
  type: object
1334
1341
  properties:
@@ -1347,12 +1354,12 @@ components:
1347
1354
  description: If access or download is "location-based", which location should have access.
1348
1355
  type: string
1349
1356
  enum:
1350
- - 'spec'
1351
- - 'music'
1352
- - 'ars'
1353
- - 'art'
1354
- - 'hoover'
1355
- - 'm&m'
1357
+ - "spec"
1358
+ - "music"
1359
+ - "ars"
1360
+ - "art"
1361
+ - "hoover"
1362
+ - "m&m"
1356
1363
  controlledDigitalLending:
1357
1364
  type: boolean
1358
1365
  default: false
@@ -1380,12 +1387,12 @@ components:
1380
1387
  description: Which location should have download access.
1381
1388
  type: string
1382
1389
  enum:
1383
- - 'spec'
1384
- - 'music'
1385
- - 'ars'
1386
- - 'art'
1387
- - 'hoover'
1388
- - 'm&m'
1390
+ - "spec"
1391
+ - "music"
1392
+ - "ars"
1393
+ - "art"
1394
+ - "hoover"
1395
+ - "m&m"
1389
1396
  controlledDigitalLending:
1390
1397
  type: boolean
1391
1398
  default: false
@@ -1416,12 +1423,12 @@ components:
1416
1423
  description: A record identifier migrated from Symphony
1417
1424
  type: string
1418
1425
  pattern: '^a\d+$'
1419
- example: 'a11403803'
1426
+ example: "a11403803"
1420
1427
  MigratedFromVoyagerIdentifier:
1421
1428
  description: A record identifier migrated from Voyager
1422
1429
  type: string
1423
1430
  pattern: '^L\d+$'
1424
- example: 'L11403803'
1431
+ example: "L11403803"
1425
1432
  # ObjectMetadata schema should not be copied to sdr-api and dor-services-app.
1426
1433
  ObjectMetadata:
1427
1434
  description: Metadata for a cocina object.
@@ -1443,9 +1450,9 @@ components:
1443
1450
  - lock
1444
1451
  PreregisteredRepositoryDOI:
1445
1452
  type: string
1446
- description: '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.'
1453
+ description: "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."
1447
1454
  pattern: '^10\.(25740|80343)\/[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}$'
1448
- example: '10.80343/12qF-5243'
1455
+ example: "10.80343/12qF-5243"
1449
1456
  Presentation:
1450
1457
  description: Presentation data for the File.
1451
1458
  type: object
@@ -1472,48 +1479,49 @@ components:
1472
1479
  description: The relationship of the related resource to the described resource.
1473
1480
  type: string
1474
1481
  dataCiteRelationType:
1475
- description: The DataCite relationType describing the relationship from the related resource to the described resource.
1482
+ description:
1483
+ The DataCite relationType describing the relationship from the related resource to the described resource.
1476
1484
  See https://datacite-metadata-schema.readthedocs.io/en/4.6/appendices/appendix-1/relationType
1477
1485
  type: string
1478
1486
  enum:
1479
- - 'IsCitedBy'
1480
- - 'Cites'
1481
- - 'IsSupplementTo'
1482
- - 'IsSupplementedBy'
1483
- - 'IsContinuedBy'
1484
- - 'Continues'
1485
- - 'Describes'
1486
- - 'IsDescribedBy'
1487
- - 'HasMetadata'
1488
- - 'IsMetadataFor'
1489
- - 'HasVersion'
1490
- - 'IsVersionOf'
1491
- - 'IsNewVersionOf'
1492
- - 'IsPreviousVersionOf'
1493
- - 'IsPartOf'
1494
- - 'HasPart'
1495
- - 'IsPublishedIn'
1496
- - 'IsReferencedBy'
1497
- - 'References'
1498
- - 'IsDocumentedBy'
1499
- - 'Documents'
1500
- - 'IsCompiledBy'
1501
- - 'Compiles'
1502
- - 'IsVariantFormOf'
1503
- - 'IsOriginalFormOf'
1504
- - 'IsIdenticalTo'
1505
- - 'IsReviewedBy'
1506
- - 'Reviews'
1507
- - 'IsDerivedFrom'
1508
- - 'IsSourceOf'
1509
- - 'IsRequiredBy'
1510
- - 'Requires'
1511
- - 'Obsoletes'
1512
- - 'IsObsoletedBy'
1513
- - 'IsCollectedBy'
1514
- - 'Collects'
1515
- - 'IsTranslationOf'
1516
- - 'HasTranslation'
1487
+ - "IsCitedBy"
1488
+ - "Cites"
1489
+ - "IsSupplementTo"
1490
+ - "IsSupplementedBy"
1491
+ - "IsContinuedBy"
1492
+ - "Continues"
1493
+ - "Describes"
1494
+ - "IsDescribedBy"
1495
+ - "HasMetadata"
1496
+ - "IsMetadataFor"
1497
+ - "HasVersion"
1498
+ - "IsVersionOf"
1499
+ - "IsNewVersionOf"
1500
+ - "IsPreviousVersionOf"
1501
+ - "IsPartOf"
1502
+ - "HasPart"
1503
+ - "IsPublishedIn"
1504
+ - "IsReferencedBy"
1505
+ - "References"
1506
+ - "IsDocumentedBy"
1507
+ - "Documents"
1508
+ - "IsCompiledBy"
1509
+ - "Compiles"
1510
+ - "IsVariantFormOf"
1511
+ - "IsOriginalFormOf"
1512
+ - "IsIdenticalTo"
1513
+ - "IsReviewedBy"
1514
+ - "Reviews"
1515
+ - "IsDerivedFrom"
1516
+ - "IsSourceOf"
1517
+ - "IsRequiredBy"
1518
+ - "Requires"
1519
+ - "Obsoletes"
1520
+ - "IsObsoletedBy"
1521
+ - "IsCollectedBy"
1522
+ - "Collects"
1523
+ - "IsTranslationOf"
1524
+ - "HasTranslation"
1517
1525
  status:
1518
1526
  description: Status of the related resource relative to other related resources.
1519
1527
  type: string
@@ -1526,7 +1534,8 @@ components:
1526
1534
  items:
1527
1535
  $ref: "#/components/schemas/DescriptiveValue"
1528
1536
  contributor:
1529
- description: Agents contributing in some way to the creation and history of the
1537
+ description:
1538
+ Agents contributing in some way to the creation and history of the
1530
1539
  related resource.
1531
1540
  type: array
1532
1541
  items:
@@ -1537,13 +1546,15 @@ components:
1537
1546
  items:
1538
1547
  $ref: "#/components/schemas/Event"
1539
1548
  form:
1540
- description: Characteristics of the related resource's physical, digital, and intellectual
1549
+ description:
1550
+ Characteristics of the related resource's physical, digital, and intellectual
1541
1551
  form and genre, and of its process of creation.
1542
1552
  type: array
1543
1553
  items:
1544
1554
  $ref: "#/components/schemas/DescriptiveValue"
1545
1555
  language:
1546
- description: Languages, scripts, symbolic systems, and notations used in all or
1556
+ description:
1557
+ Languages, scripts, symbolic systems, and notations used in all or
1547
1558
  part of a related resource.
1548
1559
  type: array
1549
1560
  items:
@@ -1587,18 +1598,18 @@ components:
1587
1598
  type: string
1588
1599
  description: "The DOI (Digital Object Identifier, https://www.doi.org) pattern for SDR objects, based on the object's repository identifier. Permits both production and text prefixes to be used to account for objects in different SDR environments. Please note that while DOIs are *not* case-sensitive, we constrain the DOIs we mint for SDR to lowercase for consistency."
1589
1600
  pattern: '^10\.(25740|80343)\/[b-df-hjkmnp-tv-z]{2}[0-9]{3}[b-df-hjkmnp-tv-z]{2}[0-9]{4}$'
1590
- example: '10.25740/bc123df4567'
1601
+ example: "10.25740/bc123df4567"
1591
1602
  RequestAdminPolicy:
1592
1603
  description: Same as an AdminPolicy, but doesn't have an externalIdentifier as one will be created
1593
1604
  type: object
1594
1605
  additionalProperties: false
1595
1606
  properties:
1596
1607
  cocinaVersion:
1597
- $ref: '#/components/schemas/CocinaVersion'
1608
+ $ref: "#/components/schemas/CocinaVersion"
1598
1609
  type:
1599
1610
  type: string
1600
1611
  enum:
1601
- - 'https://cocina.sul.stanford.edu/models/admin_policy'
1612
+ - "https://cocina.sul.stanford.edu/models/admin_policy"
1602
1613
  label:
1603
1614
  type: string
1604
1615
  version:
@@ -1607,9 +1618,9 @@ components:
1607
1618
  enum:
1608
1619
  - 1
1609
1620
  administrative:
1610
- $ref: '#/components/schemas/AdminPolicyAdministrative'
1621
+ $ref: "#/components/schemas/AdminPolicyAdministrative"
1611
1622
  description:
1612
- $ref: '#/components/schemas/RequestDescription'
1623
+ $ref: "#/components/schemas/RequestDescription"
1613
1624
  required:
1614
1625
  - cocinaVersion
1615
1626
  - administrative
@@ -1634,15 +1645,15 @@ components:
1634
1645
  additionalProperties: false
1635
1646
  properties:
1636
1647
  cocinaVersion:
1637
- $ref: '#/components/schemas/CocinaVersion'
1648
+ $ref: "#/components/schemas/CocinaVersion"
1638
1649
  type:
1639
1650
  type: string
1640
1651
  enum:
1641
- - 'https://cocina.sul.stanford.edu/models/collection'
1642
- - 'https://cocina.sul.stanford.edu/models/curated-collection'
1643
- - 'https://cocina.sul.stanford.edu/models/user-collection'
1644
- - 'https://cocina.sul.stanford.edu/models/exhibit'
1645
- - 'https://cocina.sul.stanford.edu/models/series'
1652
+ - "https://cocina.sul.stanford.edu/models/collection"
1653
+ - "https://cocina.sul.stanford.edu/models/curated-collection"
1654
+ - "https://cocina.sul.stanford.edu/models/user-collection"
1655
+ - "https://cocina.sul.stanford.edu/models/exhibit"
1656
+ - "https://cocina.sul.stanford.edu/models/series"
1646
1657
  label:
1647
1658
  type: string
1648
1659
  version:
@@ -1651,13 +1662,13 @@ components:
1651
1662
  enum:
1652
1663
  - 1
1653
1664
  access:
1654
- $ref: '#/components/schemas/CollectionAccess'
1665
+ $ref: "#/components/schemas/CollectionAccess"
1655
1666
  administrative:
1656
- $ref: '#/components/schemas/RequestAdministrative'
1667
+ $ref: "#/components/schemas/RequestAdministrative"
1657
1668
  description:
1658
- $ref: '#/components/schemas/RequestDescription'
1669
+ $ref: "#/components/schemas/RequestDescription"
1659
1670
  identification:
1660
- $ref: '#/components/schemas/CollectionIdentification'
1671
+ $ref: "#/components/schemas/CollectionIdentification"
1661
1672
  required:
1662
1673
  - cocinaVersion
1663
1674
  - access
@@ -1671,25 +1682,25 @@ components:
1671
1682
  additionalProperties: false
1672
1683
  properties:
1673
1684
  cocinaVersion:
1674
- $ref: '#/components/schemas/CocinaVersion'
1685
+ $ref: "#/components/schemas/CocinaVersion"
1675
1686
  type:
1676
1687
  type: string
1677
1688
  enum:
1678
- - 'https://cocina.sul.stanford.edu/models/object'
1679
- - 'https://cocina.sul.stanford.edu/models/3d'
1680
- - 'https://cocina.sul.stanford.edu/models/agreement'
1681
- - 'https://cocina.sul.stanford.edu/models/book'
1682
- - 'https://cocina.sul.stanford.edu/models/document'
1683
- - 'https://cocina.sul.stanford.edu/models/geo'
1684
- - 'https://cocina.sul.stanford.edu/models/image'
1685
- - 'https://cocina.sul.stanford.edu/models/page'
1686
- - 'https://cocina.sul.stanford.edu/models/photograph'
1687
- - 'https://cocina.sul.stanford.edu/models/manuscript'
1688
- - 'https://cocina.sul.stanford.edu/models/map'
1689
- - 'https://cocina.sul.stanford.edu/models/media'
1690
- - 'https://cocina.sul.stanford.edu/models/track'
1691
- - 'https://cocina.sul.stanford.edu/models/webarchive-binary'
1692
- - 'https://cocina.sul.stanford.edu/models/webarchive-seed'
1689
+ - "https://cocina.sul.stanford.edu/models/object"
1690
+ - "https://cocina.sul.stanford.edu/models/3d"
1691
+ - "https://cocina.sul.stanford.edu/models/agreement"
1692
+ - "https://cocina.sul.stanford.edu/models/book"
1693
+ - "https://cocina.sul.stanford.edu/models/document"
1694
+ - "https://cocina.sul.stanford.edu/models/geo"
1695
+ - "https://cocina.sul.stanford.edu/models/image"
1696
+ - "https://cocina.sul.stanford.edu/models/page"
1697
+ - "https://cocina.sul.stanford.edu/models/photograph"
1698
+ - "https://cocina.sul.stanford.edu/models/manuscript"
1699
+ - "https://cocina.sul.stanford.edu/models/map"
1700
+ - "https://cocina.sul.stanford.edu/models/media"
1701
+ - "https://cocina.sul.stanford.edu/models/track"
1702
+ - "https://cocina.sul.stanford.edu/models/webarchive-binary"
1703
+ - "https://cocina.sul.stanford.edu/models/webarchive-seed"
1693
1704
  label:
1694
1705
  type: string
1695
1706
  version:
@@ -1698,17 +1709,17 @@ components:
1698
1709
  enum:
1699
1710
  - 1
1700
1711
  access:
1701
- $ref: '#/components/schemas/DROAccess'
1712
+ $ref: "#/components/schemas/DROAccess"
1702
1713
  administrative:
1703
- $ref: '#/components/schemas/RequestAdministrative'
1714
+ $ref: "#/components/schemas/RequestAdministrative"
1704
1715
  description:
1705
- $ref: '#/components/schemas/RequestDescription'
1716
+ $ref: "#/components/schemas/RequestDescription"
1706
1717
  identification:
1707
- $ref: '#/components/schemas/RequestIdentification'
1718
+ $ref: "#/components/schemas/RequestIdentification"
1708
1719
  structural:
1709
- $ref: '#/components/schemas/RequestDROStructural'
1720
+ $ref: "#/components/schemas/RequestDROStructural"
1710
1721
  geographic:
1711
- $ref: '#/components/schemas/Geographic'
1722
+ $ref: "#/components/schemas/Geographic"
1712
1723
  required:
1713
1724
  - cocinaVersion
1714
1725
  - administrative
@@ -1724,16 +1735,16 @@ components:
1724
1735
  contains:
1725
1736
  type: array
1726
1737
  items:
1727
- $ref: '#/components/schemas/RequestFileSet'
1738
+ $ref: "#/components/schemas/RequestFileSet"
1728
1739
  hasMemberOrders:
1729
1740
  type: array
1730
1741
  items:
1731
- $ref: '#/components/schemas/Sequence'
1742
+ $ref: "#/components/schemas/Sequence"
1732
1743
  isMemberOf:
1733
1744
  description: Collections that this DRO is a member of
1734
1745
  type: array
1735
1746
  items:
1736
- $ref: '#/components/schemas/Druid'
1747
+ $ref: "#/components/schemas/Druid"
1737
1748
  RequestDescription:
1738
1749
  description: Description that is included in a request to create a DRO. This is the same as a Description, except excludes PURL.
1739
1750
  type: object
@@ -1746,7 +1757,8 @@ components:
1746
1757
  items:
1747
1758
  $ref: "#/components/schemas/Title"
1748
1759
  contributor:
1749
- description: Agents contributing in some way to the creation and history of the
1760
+ description:
1761
+ Agents contributing in some way to the creation and history of the
1750
1762
  resource.
1751
1763
  type: array
1752
1764
  items:
@@ -1757,7 +1769,8 @@ components:
1757
1769
  items:
1758
1770
  $ref: "#/components/schemas/Event"
1759
1771
  form:
1760
- description: Characteristics of the resource's physical, digital, and intellectual
1772
+ description:
1773
+ Characteristics of the resource's physical, digital, and intellectual
1761
1774
  form and genre, and of its process of creation.
1762
1775
  type: array
1763
1776
  items:
@@ -1768,7 +1781,8 @@ components:
1768
1781
  items:
1769
1782
  $ref: "#/components/schemas/DescriptiveGeographicMetadata"
1770
1783
  language:
1771
- description: Languages, scripts, symbolic systems, and notations used in all or
1784
+ description:
1785
+ Languages, scripts, symbolic systems, and notations used in all or
1772
1786
  part of a resource.
1773
1787
  type: array
1774
1788
  items:
@@ -1814,7 +1828,7 @@ components:
1814
1828
  type:
1815
1829
  type: string
1816
1830
  enum:
1817
- - 'https://cocina.sul.stanford.edu/models/file'
1831
+ - "https://cocina.sul.stanford.edu/models/file"
1818
1832
  label:
1819
1833
  type: string
1820
1834
  filename:
@@ -1826,11 +1840,11 @@ components:
1826
1840
  hasMimeType:
1827
1841
  type: string
1828
1842
  languageTag:
1829
- $ref: '#/components/schemas/LanguageTag'
1843
+ $ref: "#/components/schemas/LanguageTag"
1830
1844
  externalIdentifier:
1831
1845
  type: string
1832
1846
  use:
1833
- $ref: '#/components/schemas/FileUse'
1847
+ $ref: "#/components/schemas/FileUse"
1834
1848
  sdrGeneratedText:
1835
1849
  description: Indicates if the text (OCR/captioning) was generated by SDR.
1836
1850
  type: boolean
@@ -1842,13 +1856,13 @@ components:
1842
1856
  hasMessageDigests:
1843
1857
  type: array
1844
1858
  items:
1845
- $ref: '#/components/schemas/MessageDigest'
1859
+ $ref: "#/components/schemas/MessageDigest"
1846
1860
  access:
1847
- $ref: '#/components/schemas/FileAccess'
1861
+ $ref: "#/components/schemas/FileAccess"
1848
1862
  administrative:
1849
- $ref: '#/components/schemas/FileAdministrative'
1863
+ $ref: "#/components/schemas/FileAdministrative"
1850
1864
  presentation:
1851
- $ref: '#/components/schemas/Presentation'
1865
+ $ref: "#/components/schemas/Presentation"
1852
1866
  required:
1853
1867
  - label
1854
1868
  - type
@@ -1864,24 +1878,24 @@ components:
1864
1878
  type:
1865
1879
  type: string
1866
1880
  enum:
1867
- - 'https://cocina.sul.stanford.edu/models/resources/audio'
1868
- - 'https://cocina.sul.stanford.edu/models/resources/attachment'
1869
- - 'https://cocina.sul.stanford.edu/models/resources/document'
1870
- - 'https://cocina.sul.stanford.edu/models/resources/file'
1871
- - 'https://cocina.sul.stanford.edu/models/resources/image'
1872
- - 'https://cocina.sul.stanford.edu/models/resources/media'
1873
- - 'https://cocina.sul.stanford.edu/models/resources/object'
1874
- - 'https://cocina.sul.stanford.edu/models/resources/page'
1875
- - 'https://cocina.sul.stanford.edu/models/resources/preview'
1876
- - 'https://cocina.sul.stanford.edu/models/resources/3d'
1877
- - 'https://cocina.sul.stanford.edu/models/resources/thumb'
1878
- - 'https://cocina.sul.stanford.edu/models/resources/video'
1881
+ - "https://cocina.sul.stanford.edu/models/resources/audio"
1882
+ - "https://cocina.sul.stanford.edu/models/resources/attachment"
1883
+ - "https://cocina.sul.stanford.edu/models/resources/document"
1884
+ - "https://cocina.sul.stanford.edu/models/resources/file"
1885
+ - "https://cocina.sul.stanford.edu/models/resources/image"
1886
+ - "https://cocina.sul.stanford.edu/models/resources/media"
1887
+ - "https://cocina.sul.stanford.edu/models/resources/object"
1888
+ - "https://cocina.sul.stanford.edu/models/resources/page"
1889
+ - "https://cocina.sul.stanford.edu/models/resources/preview"
1890
+ - "https://cocina.sul.stanford.edu/models/resources/3d"
1891
+ - "https://cocina.sul.stanford.edu/models/resources/thumb"
1892
+ - "https://cocina.sul.stanford.edu/models/resources/video"
1879
1893
  label:
1880
1894
  type: string
1881
1895
  version:
1882
1896
  type: integer
1883
1897
  structural:
1884
- $ref: '#/components/schemas/RequestFileSetStructural'
1898
+ $ref: "#/components/schemas/RequestFileSetStructural"
1885
1899
  required:
1886
1900
  - label
1887
1901
  - type
@@ -1895,7 +1909,7 @@ components:
1895
1909
  contains:
1896
1910
  type: array
1897
1911
  items:
1898
- $ref: '#/components/schemas/RequestFile'
1912
+ $ref: "#/components/schemas/RequestFile"
1899
1913
  RequestIdentification:
1900
1914
  # Doesn't permit a DOI because our DOIs all use the DRUID as part of the DOI.
1901
1915
  # You have to register the object in order to get the DRUID before you can mint a DOI
@@ -1904,13 +1918,13 @@ components:
1904
1918
  additionalProperties: false
1905
1919
  properties:
1906
1920
  barcode:
1907
- $ref: '#/components/schemas/Barcode'
1921
+ $ref: "#/components/schemas/Barcode"
1908
1922
  catalogLinks:
1909
1923
  type: array
1910
1924
  items:
1911
- $ref: '#/components/schemas/CatalogLink'
1925
+ $ref: "#/components/schemas/CatalogLink"
1912
1926
  sourceId:
1913
- $ref: '#/components/schemas/SourceId'
1927
+ $ref: "#/components/schemas/SourceId"
1914
1928
  required:
1915
1929
  - sourceId
1916
1930
  Sequence:
@@ -1955,7 +1969,7 @@ components:
1955
1969
  type: string
1956
1970
  SourceId:
1957
1971
  type: string
1958
- pattern: '^.+:.+$'
1972
+ pattern: "^.+:.+$"
1959
1973
  description: >
1960
1974
  Unique identifier in some other system. This is because a large proportion of what is deposited in SDR,
1961
1975
  historically and currently, are representations of objects that are also represented in other systems.
@@ -1963,9 +1977,10 @@ components:
1963
1977
  in systems that have their own identifiers. Similarly, books have barcodes, archival materials have collection numbers
1964
1978
  and physical locations, etc. The sourceId allows determining if an item has been deposited before and where to
1965
1979
  look for the original item if you're looking at its SDR representation. The format is: "namespace:identifier"
1966
- example: 'sul:PC0170_s3_Fiesta_Bowl_2012-01-02_210609_2026'
1980
+ example: "sul:PC0170_s3_Fiesta_Bowl_2012-01-02_210609_2026"
1967
1981
  Standard:
1968
- description: Property model for indicating the encoding, standard, or syntax
1982
+ description:
1983
+ Property model for indicating the encoding, standard, or syntax
1969
1984
  to which a value conforms (e.g. RDA).
1970
1985
  type: object
1971
1986
  additionalProperties: false
@@ -1994,8 +2009,8 @@ components:
1994
2009
  description: The standard barcode associated with a DRO object, prefixed with 36105
1995
2010
  type: string
1996
2011
  nullable: true
1997
- pattern: '^36105[0-9]{9}$'
1998
- example: '36105010362304'
2012
+ pattern: "^36105[0-9]{9}$"
2013
+ example: "36105010362304"
1999
2014
  StanfordAccess:
2000
2015
  type: object
2001
2016
  properties:
@@ -2036,7 +2051,8 @@ components:
2036
2051
  - previous symphony
2037
2052
  example: symphony
2038
2053
  refresh:
2039
- description: Only one of the catkeys should be designated for refreshing.
2054
+ description:
2055
+ Only one of the catkeys should be designated for refreshing.
2040
2056
  This means that this key is the one used to pull metadata from the catalog
2041
2057
  if there is more than one key present.
2042
2058
  type: boolean
@@ -2045,7 +2061,7 @@ components:
2045
2061
  description: Record identifier that is unique within the context of the linked record's catalog.
2046
2062
  type: string
2047
2063
  pattern: '^\d+$'
2048
- example: '11403803'
2064
+ example: "11403803"
2049
2065
  required:
2050
2066
  - catalog
2051
2067
  - catalogRecordId