cocina-models 0.40.0 → 0.40.1
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.
- checksums.yaml +4 -4
- data/README.md +10 -0
- data/lib/cocina/models/descriptive_basic_value.rb +1 -1
- data/lib/cocina/models/descriptive_value.rb +1 -1
- data/lib/cocina/models/descriptive_value_language.rb +17 -0
- data/lib/cocina/models/descriptive_value_required.rb +1 -1
- data/lib/cocina/models/language.rb +1 -1
- data/lib/cocina/models/version.rb +1 -1
- data/openapi.yml +28 -14
- metadata +3 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b1a41a02c7e3c3d58b65f4b94e4afdbc885795920eee91fa83f87374a207c0c1
|
4
|
+
data.tar.gz: 3c70761dd272739012387d78df18c69d114ab5a152d79283131f8d727112dcb9
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e7f56d6aa41f0d13d2dcf17a2aef82354b566025caf04ffff84b2857fabfcc8c703c16f3aae00cf43c4654922f7b9240ededef6366ed9b111b2b4690f5a11fd2
|
7
|
+
data.tar.gz: b452f06a8f0525035a0699e74345b8bd1fb7f96d5b3f9cfbd996f1f65bd99b82d7ffbd9fa71cd2a5c32e60ef8731df159833b2bae98070ddf9f40803316b3caf
|
data/README.md
CHANGED
@@ -42,6 +42,16 @@ which pushes the gem to rubygems.org. Next write up the release notes: https://
|
|
42
42
|
|
43
43
|
Finally, you must release versions of [sdr-client](https://github.com/sul-dlss/sdr-client) and [dor-services-client](https://github.com/sul-dlss/dor-services-client/) pinned to this version because [Argo](https://github.com/sul-dlss/argo) depends on both of those. When [dor-services-app](https://github.com/sul-dlss/dor-services-app) is updated to use the new models (via the auto-update script), the clients must be updated at the same time or there is risk of models produced by dor-services-app not being acceptable to the clients.
|
44
44
|
|
45
|
+
### Dependent Services
|
46
|
+
|
47
|
+
Once the above listed gems are updated all the following services that use cocina-models should be updated and released at the same time:
|
48
|
+
|
49
|
+
* sul-dlss/sdr-api
|
50
|
+
* sul-dlss/dor-services-app
|
51
|
+
* sul-dlss/google-books
|
52
|
+
* sul-dlss/common-accessioning
|
53
|
+
* sul-dlss/argo
|
54
|
+
* sul-dlss/pre-assembly
|
45
55
|
|
46
56
|
## Using this gem
|
47
57
|
|
@@ -23,7 +23,7 @@ module Cocina
|
|
23
23
|
# A term providing information about the circumstances of the statement (e.g., approximate dates).
|
24
24
|
attribute :qualifier, Types::Strict::String.meta(omittable: true)
|
25
25
|
attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
|
26
|
-
attribute :
|
26
|
+
attribute :valueLanguage, DescriptiveValueLanguage.optional.meta(omittable: true)
|
27
27
|
end
|
28
28
|
end
|
29
29
|
end
|
@@ -23,7 +23,7 @@ module Cocina
|
|
23
23
|
# A term providing information about the circumstances of the statement (e.g., approximate dates).
|
24
24
|
attribute :qualifier, Types::Strict::String.meta(omittable: true)
|
25
25
|
attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
|
26
|
-
attribute :
|
26
|
+
attribute :valueLanguage, DescriptiveValueLanguage.optional.meta(omittable: true)
|
27
27
|
attribute :appliesTo, Types::Strict::Array.of(DescriptiveBasicValue).meta(omittable: true)
|
28
28
|
end
|
29
29
|
end
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Cocina
|
4
|
+
module Models
|
5
|
+
class DescriptiveValueLanguage < Struct
|
6
|
+
# Code representing the standard or encoding.
|
7
|
+
attribute :code, Types::Strict::String.meta(omittable: true)
|
8
|
+
# URI for the standard or encoding.
|
9
|
+
attribute :uri, Types::Strict::String.meta(omittable: true)
|
10
|
+
# String describing the standard or encoding.
|
11
|
+
attribute :value, Types::Strict::String.meta(omittable: true)
|
12
|
+
attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
|
13
|
+
attribute :source, Source.optional.meta(omittable: true)
|
14
|
+
attribute :valueScript, Standard.optional.meta(omittable: true)
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
@@ -23,7 +23,7 @@ module Cocina
|
|
23
23
|
# A term providing information about the circumstances of the statement (e.g., approximate dates).
|
24
24
|
attribute :qualifier, Types::Strict::String.meta(omittable: true)
|
25
25
|
attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
|
26
|
-
attribute :
|
26
|
+
attribute :valueLanguage, DescriptiveValueLanguage.optional.meta(omittable: true)
|
27
27
|
attribute :appliesTo, Types::Strict::Array.of(DescriptiveBasicValue).meta(omittable: true)
|
28
28
|
end
|
29
29
|
end
|
@@ -23,7 +23,7 @@ module Cocina
|
|
23
23
|
# A term providing information about the circumstances of the statement (e.g., approximate dates).
|
24
24
|
attribute :qualifier, Types::Strict::String.meta(omittable: true)
|
25
25
|
attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
|
26
|
-
attribute :
|
26
|
+
attribute :valueLanguage, DescriptiveValueLanguage.optional.meta(omittable: true)
|
27
27
|
attribute :appliesTo, Types::Strict::Array.of(DescriptiveBasicValue).meta(omittable: true)
|
28
28
|
attribute :script, DescriptiveValue.optional.meta(omittable: true)
|
29
29
|
end
|
data/openapi.yml
CHANGED
@@ -467,9 +467,8 @@ components:
|
|
467
467
|
type: array
|
468
468
|
items:
|
469
469
|
$ref: "#/components/schemas/DescriptiveValue"
|
470
|
-
|
471
|
-
|
472
|
-
$ref: "#/components/schemas/Standard"
|
470
|
+
valueLanguage:
|
471
|
+
$ref: "#/components/schemas/DescriptiveValueLanguage"
|
473
472
|
DescriptiveParallelValue:
|
474
473
|
description: Value model for multiple representations of the same information (e.g. in different languages).
|
475
474
|
type: object
|
@@ -495,6 +494,18 @@ components:
|
|
495
494
|
allOf:
|
496
495
|
- $ref: "#/components/schemas/DescriptiveBasicValue"
|
497
496
|
- $ref: "#/components/schemas/AppliesTo"
|
497
|
+
DescriptiveValueLanguage:
|
498
|
+
description: Language of the descriptive element value
|
499
|
+
type: object
|
500
|
+
additionalProperties: false
|
501
|
+
allOf:
|
502
|
+
- $ref: "#/components/schemas/Standard"
|
503
|
+
- type: object
|
504
|
+
properties:
|
505
|
+
valueScript:
|
506
|
+
$ref: '#/components/schemas/Standard'
|
507
|
+
# description: An alphabet or other notation used to represent a
|
508
|
+
# language or other symbolic system of the descriptive element value.
|
498
509
|
DescriptiveValueRequired:
|
499
510
|
type: object
|
500
511
|
additionalProperties: false
|
@@ -507,6 +518,9 @@ components:
|
|
507
518
|
- type: object
|
508
519
|
required:
|
509
520
|
- structuredValue
|
521
|
+
- type: object
|
522
|
+
required:
|
523
|
+
- parallelValue
|
510
524
|
DRO:
|
511
525
|
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.
|
512
526
|
type: object
|
@@ -1220,6 +1234,17 @@ components:
|
|
1220
1234
|
type: array
|
1221
1235
|
items:
|
1222
1236
|
$ref: "#/components/schemas/DescriptiveValue"
|
1237
|
+
SourceId:
|
1238
|
+
type: string
|
1239
|
+
pattern: '^.+:.+$'
|
1240
|
+
description: >
|
1241
|
+
Unique identifier in some other system. This is because a large proportion of what is deposited in SDR,
|
1242
|
+
historically and currently, are representations of objects that are also represented in other systems.
|
1243
|
+
For example, digitized paper and A/V collections have physical manifestations, and those physical objects are managed
|
1244
|
+
in systems that have their own identifiers. Similarly, books have barcodes, archival materials have collection numbers
|
1245
|
+
and physical locations, etc. The sourceId allows determining if an item has been deposited before and where to
|
1246
|
+
look for the original item if you're looking at its SDR representation. The format is: "namespace:identifier"
|
1247
|
+
example: 'sul:PC0170_s3_Fiesta_Bowl_2012-01-02_210609_2026'
|
1223
1248
|
Standard:
|
1224
1249
|
description: Property model for indicating the encoding, standard, or syntax
|
1225
1250
|
to which a value conforms.
|
@@ -1243,14 +1268,3 @@ components:
|
|
1243
1268
|
$ref: "#/components/schemas/DescriptiveValue"
|
1244
1269
|
source:
|
1245
1270
|
$ref: "#/components/schemas/Source"
|
1246
|
-
SourceId:
|
1247
|
-
type: string
|
1248
|
-
pattern: '^.+:.+$'
|
1249
|
-
description: >
|
1250
|
-
Unique identifier in some other system. This is because a large proportion of what is deposited in SDR,
|
1251
|
-
historically and currently, are representations of objects that are also represented in other systems.
|
1252
|
-
For example, digitized paper and A/V collections have physical manifestations, and those physical objects are managed
|
1253
|
-
in systems that have their own identifiers. Similarly, books have barcodes, archival materials have collection numbers
|
1254
|
-
and physical locations, etc. The sourceId allows determining if an item has been deposited before and where to
|
1255
|
-
look for the original item if you're looking at its SDR representation. The format is: "namespace:identifier"
|
1256
|
-
example: 'sul:PC0170_s3_Fiesta_Bowl_2012-01-02_210609_2026'
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: cocina-models
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.40.
|
4
|
+
version: 0.40.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Justin Coyne
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-09-
|
11
|
+
date: 2020-09-10 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: activesupport
|
@@ -270,6 +270,7 @@ files:
|
|
270
270
|
- lib/cocina/models/descriptive_parallel_value.rb
|
271
271
|
- lib/cocina/models/descriptive_structured_value.rb
|
272
272
|
- lib/cocina/models/descriptive_value.rb
|
273
|
+
- lib/cocina/models/descriptive_value_language.rb
|
273
274
|
- lib/cocina/models/descriptive_value_required.rb
|
274
275
|
- lib/cocina/models/dro.rb
|
275
276
|
- lib/cocina/models/dro_access.rb
|