-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yml
2231 lines (2231 loc) · 79.8 KB
/
openapi.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
description: Stanford Digital Repository API
version: 1.0.0
title: SDR API
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
servers:
- url: 'https://sdr-api-{env}.stanford.edu'
description: Production service
variables:
env:
default: prod
- url: 'https://sdr-api-{env}.stanford.edu'
description: Staging service
variables:
env:
default: stage
tags:
- name: authentication
description: Authenticate the user
- name: objects
description: Digital Repository Objects
- name: files
description: upload binary files
paths:
/v1/direct_uploads:
post:
tags:
- files
summary: Creates a new file resource
responses:
'200':
description: OK
content:
application/json:
example: {"id":56,"key":"3eh3k0x16eysn9ivndmqjo5jdf4d","filename":"Gemfile.lock","content_type":"text/html","metadata":{},"byte_size":1082,"checksum":"A72Iwi4DGf80H7WM4VHuUw==","created_at":"2020-01-07T23:18:08.818Z","signed_id":"eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBQUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--8802f5d43bd2c192ef783e02c55481d129a51a72","direct_upload":{"url":"http://localhost:3000/rails/active_storage/disk/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDVG9JYTJWNVNTSWhNMlZvTTJzd2VERTJaWGx6YmpscGRtNWtiWEZxYnpWcVpHWTBaQVk2QmtWVU9oRmpiMjUwWlc1MFgzUjVjR1ZKSWc1MFpYaDBMMmgwYld3R093WlVPaE5qYjI1MFpXNTBYMnhsYm1kMGFHa0NPZ1E2RFdOb1pXTnJjM1Z0U1NJZFFUY3lTWGRwTkVSSFpqZ3dTRGRYVFRSV1NIVlZkejA5QmpzR1ZBPT0iLCJleHAiOiIyMDIwLTAxLTA3VDIzOjIzOjA4LjgyNFoiLCJwdXIiOiJibG9iX3Rva2VuIn19--ae7c0227ed5840f30b3293d2f2b6c8109397527a","headers":{"Content-Type":"text/html"}}}
/v1/disk/{id}:
put:
tags:
- files
summary: |
Upload the binary file resource
Note that the 'content_type' of the file posted will be set to 'application/octet-stream' if not supplied.
Additional values in 'content_type' after a semicolon will be removed (e.g. ';v15' is removed in 'application/text;v15')
You may post JSON files with 'content_type' of 'application/x-stanford-json' to avoid 400 errors if posted JSON file is invalid.
The system will automatically change the content type to 'application/json' after upload.
responses:
'200':
description: OK
parameters:
- name: id
in: path
required: true
example: eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDVG9JYTJWNVNTSWhhbkk1YlRNeFpuQnJkbmwxZG1zM01qYzFOM042ZURRMWRXYzBOQVk2QmtWVU9oRmpiMjUwWlc1MFgzUjVjR1ZKSWc1MFpYaDBMMmgwYld3R093WlVPaE5qYjI1MFpXNTBYMnhsYm1kMGFHa0Jrem9OWTJobFkydHpkVzFKSWgxemFURXZURE5xVEV0M05GRjVVRGw0UjNaMEsyRlJQVDBHT3daVSIsImV4cCI6IjIwMjAtMDEtMDlUMjE6MzI6NDguNDc1WiIsInB1ciI6ImJsb2JfdG9rZW4ifX0=--da785217f57ab55fe37e8de0a9c26b4d7612c187
schema:
type: string
/v1/background_job_results/{id}:
get:
tags:
- jobs
summary: View results of a background job
description: Used to allow the application run long-running processes out of the request/response cycle
operationId: 'background_job_results#show'
responses:
'200':
description: The background job has completed
content:
application/json:
schema:
$ref: '#/components/schemas/BackgroundJobResultResponse'
'202':
description: The background job is pending or processing
content:
application/json:
schema:
$ref: '#/components/schemas/BackgroundJobResultResponse'
'404':
description: The background job with the given id was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
parameters:
- name: id
in: path
description: ID of background job result
required: true
schema:
type: integer
/v1/resources:
post:
tags:
- objects
summary: Creates a new object
description: 'Does registration and accessioning of the object'
operationId: 'objects#create'
responses:
'200':
description: OK
headers:
Location:
schema:
type: string
format: uri
description: URL to retrieve background job results.
content:
application/json:
schema:
$ref: '#/components/schemas/CreateObjectResponse'
parameters:
- in: query
name: accession
description: If set to true the version will be closed
schema:
type: boolean
- in: query
name: priority
schema:
type: string
enum:
- 'default'
- 'low'
- in: query
name: assign_doi
schema:
type: boolean
- in: query
name: user_versions
description: Create, update, or do nothing with user versions on close
schema:
type: string
enum:
- "none"
- "new"
- "update"
requestBody:
description: The metadata for the object
required: true
content:
application/json:
schema:
oneOf:
# Need to set additionalProperties to true for RequestDRO to allow accession parameter.
- $ref: '#/components/schemas/RequestDRO'
- $ref: '#/components/schemas/RequestCollection'
/v1/resources/{id}:
get:
tags:
- objects
summary: Retrieve the object metadata
description: 'Returns a JSON representation of an object, collection or admin policy.'
operationId: 'resources#show'
responses:
'200':
description: OK
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/DRO'
- $ref: '#/components/schemas/Collection'
- $ref: '#/components/schemas/AdminPolicy'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
parameters:
- name: id
in: path
description: ID of object
required: true
schema:
$ref: '#/components/schemas/Druid'
put:
tags:
- objects
summary: Update an existing object
description: 'Does update and re-accessioning of the object'
operationId: 'objects#update'
responses:
'200':
description: OK
headers:
Location:
schema:
type: string
format: uri
description: URL to retrieve background job results.
content:
application/json:
schema:
$ref: '#/components/schemas/CreateObjectResponse'
parameters:
- name: id
in: path
description: ID of object
required: true
schema:
$ref: '#/components/schemas/Druid'
- name: accession
in: query
description: If set to true the version will be closed
schema:
type: boolean
- name: versionDescription
in: query
schema:
type: string
- name: user_versions
in: query
description: Create, update, or do nothing with user versions on close
schema:
type: string
enum:
- "none"
- "new"
- "update"
requestBody:
description: The metadata for the object
required: true
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/DRO'
- $ref: '#/components/schemas/Collection'
- $ref: '#/components/schemas/AdminPolicy'
/v1/auth/login:
post:
tags:
- authentication
summary: Retrieve a JSON web token for subsequent requests
operationId: 'authentication#login'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
token:
type: string
description: The access token
example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
exp:
type: string
description: When the token will expire
example: 09-13-2023 23:00
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- email
- password
properties:
email:
description: email address of the user
type: string
format: email
password:
description: password of the user
type: string
example: sekr3t!
/v1/auth/proxy:
post:
tags:
- authentication
summary: Retrieve a JSON web token for a different user
operationId: 'authentication#proxy'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
token:
type: string
description: The access token
example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
exp:
type: string
description: When the token will expire
example: 09-13-2023 23:00
parameters:
- in: query
name: to
description: The email of the user to proxy to
required: true
schema:
type: string
components:
schemas:
Access:
type: object
oneOf:
# Being first, makes DarkAccess the default.
- $ref: '#/components/schemas/DarkAccess'
- $ref: '#/components/schemas/CitationOnlyAccess'
- $ref: '#/components/schemas/ControlledDigitalLendingAccess'
- $ref: '#/components/schemas/LocationBasedAccess'
- $ref: '#/components/schemas/LocationBasedDownloadAccess'
- $ref: '#/components/schemas/StanfordAccess'
- $ref: '#/components/schemas/WorldAccess'
AccessRole:
description: Access role conferred by an AdminPolicy to objects within it. (used by Argo)
type: object
additionalProperties: false
properties:
name:
description: Name of role
type: string
enum:
- 'dor-apo-depositor'
- 'dor-apo-manager'
- 'dor-apo-viewer'
- 'sdr-administrator'
- 'sdr-viewer'
- 'hydrus-collection-creator'
- 'hydrus-collection-manager'
- 'hydrus-collection-depositor'
- 'hydrus-collection-item-depositor'
- 'hydrus-collection-reviewer'
- 'hydrus-collection-viewer'
members:
description: The users and groups that are members of the role
type: array
items:
$ref: '#/components/schemas/AccessRoleMember'
required:
- members
- name
AccessRoleMember:
description: Represents a user or group that is a member of an AccessRole
type: object
additionalProperties: false
properties:
type:
description: Name of role
type: string
enum:
- 'sunetid'
- 'workgroup'
identifier:
type: string
required:
- identifier
- type
AdminPolicy:
type: object
additionalProperties: true
properties:
cocinaVersion:
$ref: '#/components/schemas/CocinaVersion'
type:
type: string
enum:
- 'https://cocina.sul.stanford.edu/models/admin_policy'
externalIdentifier:
$ref: '#/components/schemas/Druid'
label:
type: string
version:
type: integer
administrative:
$ref: '#/components/schemas/AdminPolicyAdministrative'
description:
$ref: '#/components/schemas/Description'
required:
- cocinaVersion
- administrative
- externalIdentifier
- label
- type
- version
Administrative:
type: object
additionalProperties: false
properties:
hasAdminPolicy:
$ref: '#/components/schemas/Druid'
required:
- hasAdminPolicy
AdminPolicyAccessTemplate:
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.'
type: object
additionalProperties: false
oneOf:
- $ref: '#/components/schemas/DarkAccess'
- $ref: '#/components/schemas/CitationOnlyAccess'
- $ref: '#/components/schemas/ControlledDigitalLendingAccess'
- $ref: '#/components/schemas/LocationBasedAccess'
- $ref: '#/components/schemas/LocationBasedDownloadAccess'
- $ref: '#/components/schemas/StanfordAccess'
- $ref: '#/components/schemas/WorldAccess'
properties:
copyright:
$ref: "#/components/schemas/Copyright"
useAndReproductionStatement:
$ref: "#/components/schemas/UseAndReproductionStatement"
license:
$ref: "#/components/schemas/License"
AdminPolicyAdministrative:
description: Administrative properties for an AdminPolicy
type: object
additionalProperties: false
properties:
accessTemplate:
$ref: '#/components/schemas/AdminPolicyAccessTemplate'
registrationWorkflow:
description: When you register an item with this admin policy, these are the workflows that are available.
type: array
items:
type: string
disseminationWorkflow:
description: An additional workflow to start for objects managed by this admin policy once the end-accession workflow step is complete
example: wasCrawlPreassemblyWF
type: string
collectionsForRegistration:
description: When you register an item with this admin policy, these are the collections that are available.
type: array
items:
type: string
hasAdminPolicy:
$ref: '#/components/schemas/Druid'
hasAgreement:
$ref: '#/components/schemas/Druid'
roles:
description: The access roles conferred by this AdminPolicy (used by Argo)
type: array
items:
$ref: '#/components/schemas/AccessRole'
required:
- hasAdminPolicy
- hasAgreement
- accessTemplate
AppliesTo:
description: Property model for indicating the parts, aspects, or versions of the resource to which a
descriptive element is applicable.
type: object
additionalProperties: false
properties:
appliesTo:
type: array
items:
$ref: "#/components/schemas/DescriptiveBasicValue"
Barcode:
description: 'A barcode'
oneOf:
- $ref: '#/components/schemas/BusinessBarcode'
- $ref: '#/components/schemas/LaneMedicalBarcode'
- $ref: '#/components/schemas/CatkeyBarcode'
- $ref: '#/components/schemas/StandardBarcode'
BusinessBarcode:
description: The barcode associated with a business library DRO object, prefixed with 2050
type: string
pattern: '^2050[0-9]{7}$'
example: '20503740296'
CatalogLink:
description: 'A linkage between an object and a catalog record'
oneOf:
- $ref: '#/components/schemas/FolioCatalogLink'
- $ref: '#/components/schemas/SymphonyCatalogLink'
CatkeyBarcode:
description: The barcode associated with a DRO object based on catkey, prefixed with a catkey followed by a hyphen
type: string
pattern: '^[0-9]+-[0-9]+$'
example: '6772719-1001'
CitationOnlyAccess:
type: object
properties:
view:
description: Access level.
type: string
enum:
- citation-only
download:
description: Download access level.
type: string
enum:
- 'none'
location:
description: Not used for this access type, must be null.
type: string
nullable: true
enum:
- null
controlledDigitalLending:
type: boolean
default: false
enum:
- false
required:
- view
- 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: true
properties:
cocinaVersion:
$ref: '#/components/schemas/CocinaVersion'
type:
description: The content type of the Collection. Selected from an established set of values.
type: string
enum:
- 'https://cocina.sul.stanford.edu/models/collection'
- 'https://cocina.sul.stanford.edu/models/curated-collection'
- 'https://cocina.sul.stanford.edu/models/user-collection'
- 'https://cocina.sul.stanford.edu/models/exhibit'
- 'https://cocina.sul.stanford.edu/models/series'
externalIdentifier:
$ref: '#/components/schemas/Druid'
label:
description: Primary processing label (can be same as title) for a Collection.
type: string
version:
description: Version for the Collection within SDR.
type: integer
access:
$ref: '#/components/schemas/CollectionAccess'
administrative:
$ref: '#/components/schemas/Administrative'
description:
$ref: '#/components/schemas/Description'
identification:
$ref: '#/components/schemas/CollectionIdentification'
required:
- cocinaVersion
- description
- externalIdentifier
- label
- type
- version
- access
- administrative
- identification
CollectionAccess:
description: Access metadata for collections
type: object
additionalProperties: false
properties:
view:
description: Access level
type: string
enum:
- 'world'
- 'dark'
default: 'dark'
copyright:
$ref: "#/components/schemas/Copyright"
useAndReproductionStatement:
$ref: "#/components/schemas/UseAndReproductionStatement"
license:
$ref: "#/components/schemas/License"
CollectionIdentification:
type: object
additionalProperties: false
properties:
catalogLinks:
type: array
items:
$ref: '#/components/schemas/CatalogLink'
sourceId:
$ref: '#/components/schemas/SourceId'
Contributor:
description: Property model for describing agents contributing in some way to
the creation and history of the resource.
type: object
additionalProperties: false
properties:
name:
description: Names associated with a contributor.
type: array
items:
$ref: "#/components/schemas/DescriptiveValue"
type:
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.
type: string
status:
description: Status of the contributor relative to other parallel contributors
(e.g. the primary author among a group of contributors).
type: string
role:
description: Relationships of the contributor to the resource or to an event
in its history.
type: array
items:
$ref: "#/components/schemas/DescriptiveValue"
identifier:
description: Identifiers and URIs associated with the contributor entity.
type: array
items:
$ref: "#/components/schemas/DescriptiveValue"
note:
description: Other information associated with the contributor.
type: array
items:
$ref: "#/components/schemas/DescriptiveValue"
valueAt:
description: URL or other pointer to the location of the contributor information.
type: string
parallelContributor:
description: For multiple representations of information about the same contributor (e.g. in different languages).
type: array
items:
$ref: "#/components/schemas/DescriptiveParallelContributor"
ControlledDigitalLendingAccess:
type: object
properties:
view:
description: Access level.
type: string
enum:
- stanford
download:
description: Download access level.
type: string
enum:
- none
location:
description: Not used for this access type, must be null.
type: string
nullable: true
enum:
- null
controlledDigitalLending:
description: Available for controlled digital lending.
type: boolean
default: false
required:
- view
- download
Copyright:
description: The human readable copyright statement that applies
example: Copyright World Trade Organization
type: string
nullable: true
CreatedInFolioIdentifier:
description: A record identifier created in Folio
type: string
pattern: '^in\d+$'
example: 'in11403803'
DOI:
description: Digital Object Identifier (https://www.doi.org)
oneOf:
- $ref: '#/components/schemas/DoiPattern'
- $ref: '#/components/schemas/DoiExceptions'
DRO:
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.
type: object
additionalProperties: true
properties:
cocinaVersion:
$ref: '#/components/schemas/CocinaVersion'
type:
description: The content type of the DRO. Selected from an established set of values.
type: string
enum:
- 'https://cocina.sul.stanford.edu/models/object'
- 'https://cocina.sul.stanford.edu/models/3d'
- 'https://cocina.sul.stanford.edu/models/agreement'
- 'https://cocina.sul.stanford.edu/models/book'
- 'https://cocina.sul.stanford.edu/models/document'
- 'https://cocina.sul.stanford.edu/models/geo'
- 'https://cocina.sul.stanford.edu/models/image'
- 'https://cocina.sul.stanford.edu/models/page'
- 'https://cocina.sul.stanford.edu/models/photograph'
- 'https://cocina.sul.stanford.edu/models/manuscript'
- 'https://cocina.sul.stanford.edu/models/map'
- 'https://cocina.sul.stanford.edu/models/media'
- 'https://cocina.sul.stanford.edu/models/track'
- 'https://cocina.sul.stanford.edu/models/webarchive-binary'
- 'https://cocina.sul.stanford.edu/models/webarchive-seed'
externalIdentifier:
$ref: '#/components/schemas/Druid'
label:
description: Primary processing label (can be same as title) for a DRO.
type: string
version:
description: Version for the DRO within SDR.
type: integer
access:
$ref: '#/components/schemas/DROAccess'
administrative:
$ref: '#/components/schemas/Administrative'
description:
$ref: '#/components/schemas/Description'
identification:
$ref: '#/components/schemas/Identification'
structural:
$ref: '#/components/schemas/DROStructural'
geographic:
$ref: '#/components/schemas/Geographic'
required:
- cocinaVersion
- access
- administrative
- description
- externalIdentifier
- label
- type
- version
- identification
- structural
DROAccess:
type: object
additionalProperties: false
allOf:
- $ref: "#/components/schemas/Access"
- type: object
properties:
copyright:
$ref: "#/components/schemas/Copyright"
embargo:
$ref: '#/components/schemas/Embargo'
useAndReproductionStatement:
$ref: "#/components/schemas/UseAndReproductionStatement"
license:
$ref: "#/components/schemas/License"
DROStructural:
description: Structural metadata
type: object
additionalProperties: false
properties:
contains:
description: Filesets that contain the digital representations (Files)
type: array
items:
$ref: '#/components/schemas/FileSet'
hasMemberOrders:
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.).
type: array
items:
$ref: '#/components/schemas/Sequence'
isMemberOf:
description: Collections that this DRO is a member of
type: array
items:
$ref: '#/components/schemas/Druid'
DarkAccess:
type: object
properties:
view:
description: Access level.
type: string
default: 'dark'
enum:
- dark
download:
description: Download access level.
type: string
default: 'none'
enum:
- 'none'
location:
description: Not used for this access type, must be null.
type: string
nullable: true
default: null
enum:
- null
controlledDigitalLending:
type: boolean
default: false
enum:
- false
Description:
type: object
additionalProperties: false
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
additionalProperties: false
properties:
url:
description: URLs where the resource may be accessed in full or part.
type: array
items:
$ref: "#/components/schemas/DescriptiveValue"
physicalLocation:
description: Location of a physical version of the resource.
type: array
items:
$ref: "#/components/schemas/DescriptiveValue"
digitalLocation:
description: Location of a digital version of the resource, such as a file path for a born digital resource.
type: array
items:
$ref: "#/components/schemas/DescriptiveValue"
accessContact:
description: The library, organization, or person responsible for access to the resource.
type: array
items:
$ref: "#/components/schemas/DescriptiveValue"
digitalRepository:
description: The digital repositories that hold the resource.
type: array
items:
$ref: "#/components/schemas/DescriptiveValue"
note:
description: Other information related to accessing the resource.
type: array
items:
$ref: "#/components/schemas/DescriptiveValue"
DescriptiveAdminMetadata:
description: Information about this resource description.
type: object
additionalProperties: false
properties:
contributor:
description: Contributors to this resource description.
type: array
items:
$ref: "#/components/schemas/Contributor"
event:
description: Events in the history of this resource description.
type: array
items:
$ref: "#/components/schemas/Event"
language:
description: Languages, scripts, symbolic systems, and notations used
in this resource description.
type: array
items:
$ref: "#/components/schemas/Language"
note:
description: Other information related to this resource description.
type: array
items:
$ref: "#/components/schemas/DescriptiveValue"
metadataStandard:
description: Descriptive or content standard(s) to which this resource description conforms.
type: array
items:
$ref: "#/components/schemas/Standard"
identifier:
description: Identifiers associated with this resource description.
type: array
items:
$ref: "#/components/schemas/DescriptiveValue"
DescriptiveBasicValue:
description: Basic value model for descriptive elements. Can only have one of value, parallelValue, groupedValue, or structuredValue.
type: object
# additionalProperties breaks the validator for allOf, unclear as to why.
# additionalProperties: false
allOf:
- $ref: "#/components/schemas/DescriptiveStructuredValue"
- $ref: "#/components/schemas/DescriptiveParallelValue"
- $ref: "#/components/schemas/DescriptiveGroupedValue"
- type: object
# additionalProperties breaks the validator for DescriptiveValue, unclear as to why.
# additionalProperties: false
properties:
value:
description: String or integer value of the descriptive element.
oneOf:
- type: string
# Title note (nonsorting character count) was supposed to be able to accept an integer value,
# but this triggered a bug in committee:
# https://github.com/interagent/committee/issues/286
# - type: integer
type:
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.
type: string
status:
description: Status of the descriptive element value relative to other instances
of the element.
type: string
code:
description: Code value of the descriptive element.
type: string
uri:
description: URI value of the descriptive element.
type: string
format: uri
standard:
# description: Descriptive or content standard to which the value conforms.
$ref: "#/components/schemas/Standard"
encoding:
# description: Encoding schema, standard, or syntax to which the value conforms.
$ref: "#/components/schemas/Standard"
identifier:
description: Identifiers and URIs associated with the descriptive element.
type: array
items:
$ref: "#/components/schemas/DescriptiveValue"
source:
$ref: "#/components/schemas/Source"
displayLabel:
description: The preferred display label to use for the descriptive element in access systems.
type: string
qualifier:
description: A term providing information about the circumstances of the statement (e.g., approximate dates).
type: string
note:
description: Other information related to the descriptive element.
type: array
items:
$ref: "#/components/schemas/DescriptiveValue"
valueLanguage:
$ref: "#/components/schemas/DescriptiveValueLanguage"
valueAt:
description: URL or other pointer to the location of the value of the descriptive element.
type: string
DescriptiveGeographicMetadata:
description: Value model for mods geographic extension metadata
type: object
additionalProperties: false
properties:
form:
type: array
items:
$ref: "#/components/schemas/DescriptiveValue"
subject:
description: Terms associated with the intellectual content of the related resource.
type: array
items:
$ref: "#/components/schemas/DescriptiveValue"
DescriptiveGroupedValue:
description: Value model for a set of descriptive elements grouped together in an unstructured way.
type: object
additionalProperties: false
properties:
groupedValue:
type: array
items:
$ref: "#/components/schemas/DescriptiveValue"
DescriptiveParallelContributor:
description: Value model for multiple representations of information about the same contributor (e.g. in different languages).
deprecated: true
type: object
additionalProperties: false
properties:
name:
description: Names associated with a contributor.
type: array
items:
$ref: "#/components/schemas/DescriptiveValue"
type:
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.
type: string
status:
description: Status of the contributor relative to other parallel contributors (e.g. the primary author among a group of contributors).
type: string
role:
description: Relationships of the contributor to the resource or to an event in its history.
type: array
items:
$ref: "#/components/schemas/DescriptiveValue"
identifier:
description: Identifiers and URIs associated with the contributor entity.
type: array
items:
$ref: "#/components/schemas/DescriptiveValue"
note:
description: Other information associated with the contributor.
type: array
items:
$ref: "#/components/schemas/DescriptiveValue"
valueAt:
description: URL or other pointer to the location of the contributor information.
type: string
valueLanguage:
# description: Language of the descriptive element value