From 832b8141b851e738c15e0661578a3d0d6ee281be Mon Sep 17 00:00:00 2001 From: Michelle Weidling Date: Mon, 11 Apr 2022 10:14:42 +0200 Subject: [PATCH 1/5] feat: add jsonlds --- jsonld/actor.jsonld | 7 +++++++ jsonld/collection.jsonld | 13 +++++++++++++ jsonld/content.jsonld | 7 +++++++ jsonld/idref.jsonld | 6 ++++++ jsonld/image.jsonld | 8 ++++++++ jsonld/item.jsonld | 15 +++++++++++++++ jsonld/manifest.jsonld | 16 ++++++++++++++++ jsonld/repository.jsonld | 7 +++++++ jsonld/sequence.jsonld | 6 ++++++ jsonld/support.jsonld | 7 +++++++ jsonld/title.jsonld | 6 ++++++ 11 files changed, 98 insertions(+) create mode 100644 jsonld/actor.jsonld create mode 100644 jsonld/collection.jsonld create mode 100644 jsonld/content.jsonld create mode 100644 jsonld/idref.jsonld create mode 100644 jsonld/image.jsonld create mode 100644 jsonld/item.jsonld create mode 100644 jsonld/manifest.jsonld create mode 100644 jsonld/repository.jsonld create mode 100644 jsonld/sequence.jsonld create mode 100644 jsonld/support.jsonld create mode 100644 jsonld/title.jsonld diff --git a/jsonld/actor.jsonld b/jsonld/actor.jsonld new file mode 100644 index 0000000..24cfff7 --- /dev/null +++ b/jsonld/actor.jsonld @@ -0,0 +1,7 @@ +{ + "@context": + { + "role": "https://schema.org/roleName", + "name": "https://schema.org/name" + } +} diff --git a/jsonld/collection.jsonld b/jsonld/collection.jsonld new file mode 100644 index 0000000..c8fdeac --- /dev/null +++ b/jsonld/collection.jsonld @@ -0,0 +1,13 @@ +{ + "@context": + { + "textapi": "https://schema.org/version", + "title": "http://purl.org/dc/terms/title", + "collector": "https://schema.org/Person", + "description": + { + "@id": "http://purl.org/dc/terms/description", + "@type": "xsd:string" + } + } +} diff --git a/jsonld/content.jsonld b/jsonld/content.jsonld new file mode 100644 index 0000000..349f16b --- /dev/null +++ b/jsonld/content.jsonld @@ -0,0 +1,7 @@ +{ + "@context": + { + "url": "https://schema.org/url", + "type": "https://schema.org/fileFormat" + } +} diff --git a/jsonld/idref.jsonld b/jsonld/idref.jsonld new file mode 100644 index 0000000..2c22a7a --- /dev/null +++ b/jsonld/idref.jsonld @@ -0,0 +1,6 @@ +{ + "@context": + { + "type": "https://schema.org/name" + } +} diff --git a/jsonld/image.jsonld b/jsonld/image.jsonld new file mode 100644 index 0000000..7779dec --- /dev/null +++ b/jsonld/image.jsonld @@ -0,0 +1,8 @@ +{ + "@context": + { + "id": "https:schema.org/url", + "manifest": "https:schema.org/url", + "license": "http://purl.org/dc/elements/1.1/rights" + } +} diff --git a/jsonld/item.jsonld b/jsonld/item.jsonld new file mode 100644 index 0000000..8a2eb8f --- /dev/null +++ b/jsonld/item.jsonld @@ -0,0 +1,15 @@ +{ + "@context": + { + "textapi": "https://schema.org/version", + "title": "http://purl.org/dc/terms/title", + "lang": "https://schema.org/language", + "langAlt": "https://schema.org/language", + "description": + { + "@id": "http://purl.org/dc/terms/description", + "@type": "xsd:string" + }, + "image": "https://schema.org/ImageObject" + } +} diff --git a/jsonld/manifest.jsonld b/jsonld/manifest.jsonld new file mode 100644 index 0000000..fe04886 --- /dev/null +++ b/jsonld/manifest.jsonld @@ -0,0 +1,16 @@ +{ + "@context": + { + "textapi": "https://schema.org/version", + "id": "https://schema.org/url", + "label": "https://schema.org/name", + "actor": "https://schema.org/Person", + "image": "https://schema.org/ImageObject", + "license": "http://purl.org/dc/elements/1.1/rights", + "description": + { + "@id": "http://purl.org/dc/terms/description", + "@type": "xsd:string" + } + } +} diff --git a/jsonld/repository.jsonld b/jsonld/repository.jsonld new file mode 100644 index 0000000..9db7f64 --- /dev/null +++ b/jsonld/repository.jsonld @@ -0,0 +1,7 @@ +{ + "@context": + { + "label": "https://schema.org/name", + "url": "https://schema.org/url" + } +} diff --git a/jsonld/sequence.jsonld b/jsonld/sequence.jsonld new file mode 100644 index 0000000..f0a293d --- /dev/null +++ b/jsonld/sequence.jsonld @@ -0,0 +1,6 @@ +{ + "@context": + { + "id": "https://schema.org/url" + } +} diff --git a/jsonld/support.jsonld b/jsonld/support.jsonld new file mode 100644 index 0000000..950f53f --- /dev/null +++ b/jsonld/support.jsonld @@ -0,0 +1,7 @@ +{ + "@context": + { + "mime": "https://schema.org/fileFormat", + "url": "https://schema.org/url" + } +} diff --git a/jsonld/title.jsonld b/jsonld/title.jsonld new file mode 100644 index 0000000..2ff4f2b --- /dev/null +++ b/jsonld/title.jsonld @@ -0,0 +1,6 @@ +{ + "@context": + { + "title": "https://schema.org/name" + } +} -- GitLab From ad7d0c7425d9794232def7b383fdd439ca11e9f9 Mon Sep 17 00:00:00 2001 From: Michelle Weidling Date: Mon, 11 Apr 2022 10:22:11 +0200 Subject: [PATCH 2/5] feat: add `@context` to specs --- content/page/specs.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/content/page/specs.md b/content/page/specs.md index 19ea833..1d1b9ab 100644 --- a/content/page/specs.md +++ b/content/page/specs.md @@ -93,6 +93,7 @@ It is REQUIRED to be served at the corresponding [endpoint](#collection). | Field Name | Cardinality | Type | Description | |----|----|----|----| +| @context | 1 | URL | the JSON-LD context of this object. MUST be `https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/collection.jsonld` | | textapi | 1 | semver | the TextAPI version covered by the implementation | | title | 1 | \[[Title Object](#title-object)\] | the title of the collection | | collector | 1 | \[[Actor Object](#actor-object)\] | a personal entity responsible for the collection (collector) | @@ -109,6 +110,7 @@ An item that represents a complete manifest (i.e. that has the type `full`) MUST | Field Name | Cardinality | Type | Description | |----|----|----|----| +| @context | 1 | URL | the JSON-LD context of this object. MUST be `https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/sequence.jsonld` | | id | 1 | URL | URL to find a [Manifest Object](#manifest-object), [Collection Object](#collection-object) or [Item Object](#item-object) | | type | 1 | string | one of `collection`, `manifest`, `item` | @@ -132,6 +134,7 @@ It is REQUIRED to be served at the corresponding [endpoint](#manifest). | Field Name | Cardinality | Type | Description | |----|----|----|----| +| @context | 1 | URL | the JSON-LD context of this object. MUST be `https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/manifest.jsonld` | | textapi | 1 | semver | version number satisfied by the implementation | | id | 1 | URL | URL pointing to this manifest | | label | 1 | string | human-readable name or title | @@ -153,6 +156,7 @@ versions. | Field Name | Cardinality | Type | Description | |----|----|----|----| +| @context | 1 | URL | the JSON-LD context of this object. MUST be `https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/repository.jsonld` | | label | ? | string | the label as given by the hosting institution | | url | 1 | URL | URL pointing to the website of the institution | | baseUrl | 1 | URL | a base URL where `id` can be resolved | @@ -162,6 +166,7 @@ versions. | Field Name | Cardinality | Type | Description | |----|----|----|----| +| @context | 1 | URL | the JSON-LD context of this object. MUST be `https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/actor.jsonld` | | role | 1 | [string] | the role of a personal entity in relation to the parent object, MUST be `collector` in case of collections | | name | 1 | string | the principal name of the person | | id | ? | string | internal identifier | @@ -185,6 +190,7 @@ It is recommended that a [IIIF Image API](https://iiif.io/api/image/2.0/) servic | Field Name | Cardinality | Type | Description | |----|----|----|----| +| @context | 1 | URL | the JSON-LD context of this object. MUST be `https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/image.jsonld` | | id | 1 | URL | URL pointing to the image | | manifest | ? | URL | URL pointing to the image's manifest object | | license | 1 | [License Object](#license-object) | the license for the image that MUST be used | @@ -207,6 +213,7 @@ be added on request. | Field Name | Cardinality | Type | Description | |----|----|----|----| +| @context | 1 | URL | the JSON-LD context of this object. MUST be `https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/support.jsonld` | | type | 1 | one of `font`, `css` | | mime | 1 | MIME type | the MIME type for the resource | | url | 1 | URL | URL pointing to the resource | @@ -221,6 +228,7 @@ Any other (sliced) material is either a `section` or a `page`. | Field Name | Cardinality | Type | Description | |----|----|----|----| +| @context | 1 | URL | the JSON-LD context of this object. MUST be `https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/item.jsonld` | | textapi | 1 | semver | version number satisfied by the implementation | | title | ? | \[[Title Object](#title-object)\] | the title of the item | | type | 1 | string | one of `section`, `page`, `full` | @@ -237,6 +245,7 @@ Any other (sliced) material is either a `section` or a `page`. | Field Name | Cardinality | Type | Description | |----|----|----|----| +| @context | 1 | URL | the JSON-LD context of this object. MUST be `https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/content.jsonld` | | url | 1 | URL | URL pointing to the content | | type | 1 | MIME type | a MIME type. If several Content Objects with the same MIME type are provided, these SHOULD be distinguished with a [MIME type parameter](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types#structure_of_a_mime_type) where the key is type and the value can be freely chosen, e.g. text/html;type=transcription. | | integrity | ? | [Data Integrity Object](#data-integrity-object) | information on data integrity | @@ -245,6 +254,7 @@ Any other (sliced) material is either a `section` or a `page`. | Field Name | Cardinality | Type | Description | |----|----|----|----| +| @context | 1 | URL | the JSON-LD context of this object. MUST be `https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/title.jsonld` | | title | 1 | string | a single title | | type | 1 | string | one of `main`, `sub`. if several titles are provided, at least one of them MUST have the type `main` | @@ -252,6 +262,7 @@ Any other (sliced) material is either a `section` or a `page`. | Field Name | Cardinality | Type | Description | |----|----|----|----| +| @context | 1 | URL | the JSON-LD context of this object. MUST be `https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/idref.jsonld` | | base | ? | URL | the base URL to the authority file | | type | 1 | string | short title of the referenced authority | | id | 1 | string | the main ID referenced | -- GitLab From 806ecf779e73e961aa0728c1bf8e70d6eb74b1a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mathias=20G=C3=B6bel?= Date: Mon, 11 Apr 2022 14:34:58 +0200 Subject: [PATCH 3/5] feat: make json-ld `@context` mandatory --- schema/actor.json | 5 ++++- schema/collection.json | 5 ++++- schema/content.json | 5 ++++- schema/idref.json | 5 ++++- schema/image.json | 5 ++++- schema/integrity.json | 5 ++++- schema/item.json | 5 ++++- schema/license.json | 5 ++++- schema/manifest.json | 5 ++++- schema/metadata-value.json | 3 +++ schema/repository.json | 5 ++++- schema/sequence.json | 5 ++++- schema/support.json | 5 ++++- schema/title.json | 5 ++++- 14 files changed, 55 insertions(+), 13 deletions(-) diff --git a/schema/actor.json b/schema/actor.json index 8e88d1c..a1157f5 100644 --- a/schema/actor.json +++ b/schema/actor.json @@ -4,6 +4,9 @@ "title": "TextAPI: Actor", "type": "object", "properties": { + "@context": { + "enum": ["https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/actor.jsonld"] + }, "role": { "description": "the role of a personal entity in relation to the parent object, MUST be collector in case of collections", "type": "array", @@ -25,7 +28,7 @@ "$ref": "idref.json" } }, - "required": [ "role", "name" ], + "required": [ "@context", "role", "name" ], "patternProperties": { "^x-": {} } diff --git a/schema/collection.json b/schema/collection.json index bd224b6..713c187 100644 --- a/schema/collection.json +++ b/schema/collection.json @@ -5,6 +5,9 @@ "description": "A simple API for delivering metadata on and references to texts.", "type": "object", "properties": { + "@context": { + "enum": ["https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/collection.jsonld"] + }, "textapi": { "description": "the TextAPI version covered by the implementation", "type": "string", @@ -61,7 +64,7 @@ } }, - "required": [ "textapi", "title", "collector", "sequence" ], + "required": [ "@context", "textapi", "title", "collector", "sequence" ], "patternProperties": { "^x-": {} }, diff --git a/schema/content.json b/schema/content.json index bf56c26..edd3665 100644 --- a/schema/content.json +++ b/schema/content.json @@ -4,6 +4,9 @@ "title": "TextAPI: Content", "type": "object", "properties": { + "@context": { + "enum": ["https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/content.jsonld"] + }, "url": { "description": "URL pointing to the content", "type": "string", @@ -19,7 +22,7 @@ "$ref": "integrity.json" } }, - "required": [ "url", "type" ], + "required": [ "@context", "url", "type" ], "patternProperties": { "^x-": {} }, diff --git a/schema/idref.json b/schema/idref.json index c9dd8cc..61a7826 100644 --- a/schema/idref.json +++ b/schema/idref.json @@ -4,6 +4,9 @@ "title": "TextAPI: Idref", "type": "object", "properties": { + "@context": { + "enum": ["https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/idref.jsonld"] + }, "base": { "description": "the base URL to the authority file", "type": "string", @@ -21,7 +24,7 @@ } }, - "required": [ "type", "id" ], + "required": [ "@context", "type", "id" ], "patternProperties": { "^x-": {} }, diff --git a/schema/image.json b/schema/image.json index 6ff0d2b..a870588 100644 --- a/schema/image.json +++ b/schema/image.json @@ -5,6 +5,9 @@ "description": "An image representing the source or its provider. It is recommended that a IIIF Image API service is available for this image for manipulations such as resizing.", "type": "object", "properties": { + "@context": { + "enum": ["https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/image.jsonld"] + }, "id": { "description": "URL pointing to the image", "type": "string", @@ -20,7 +23,7 @@ "$ref": "license.json" } }, - "required": [ "id", "license" ], + "required": [ "@context", "id", "license" ], "patternProperties": { "^x-": {} }, diff --git a/schema/integrity.json b/schema/integrity.json index 76086f3..5e57a58 100644 --- a/schema/integrity.json +++ b/schema/integrity.json @@ -5,6 +5,9 @@ "description": "Data integrity properties to a file, esp. checksums", "type": "object", "properties": { + "@context": { + "enum": ["https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/integrity.jsonld"] + }, "type": { "description": "algorithm to calculate checksum (e.g. `MD5`, `SHA-256`)", "type": "string", @@ -16,7 +19,7 @@ "minLength": 8 } }, - "required": [ "type", "value" ], + "required": [ "@context", "type", "value" ], "patternProperties": { "^x-": {} }, diff --git a/schema/item.json b/schema/item.json index 5c004eb..d67d6ce 100644 --- a/schema/item.json +++ b/schema/item.json @@ -5,6 +5,9 @@ "description": "This is the main object to represent a single unit as part of a text, or the complete text.", "type": "object", "properties": { + "@context": { + "enum": ["https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/item.jsonld"] + }, "textapi": { "description": "the TextAPI version covered by the implementation", "type": "string", @@ -82,7 +85,7 @@ } }, - "required": [ "textapi", "type", "lang", "content" ], + "required": [ "@context", "textapi", "type", "lang", "content" ], "patternProperties": { "^x-": {} }, diff --git a/schema/license.json b/schema/license.json index 6b1e8fe..cb73bc7 100644 --- a/schema/license.json +++ b/schema/license.json @@ -5,6 +5,9 @@ "description": "The license or any other appropriate rights statement the resources is served under. It is REQUIRED to use one of SPDX.", "type": "object", "properties": { + "@context": { + "enum": ["https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/license.jsonld"] + }, "id": { "description": "an SPDX identifier", "type": "string", @@ -15,7 +18,7 @@ "type": "string" } }, - "required": [ "id" ], + "required": [ "@context", "id" ], "patternProperties": { "^x-": {} }, diff --git a/schema/manifest.json b/schema/manifest.json index 2395d89..dea5709 100644 --- a/schema/manifest.json +++ b/schema/manifest.json @@ -5,6 +5,9 @@ "description": "This is the main object in the schema to represent a single text, its derivatives (e.g. html) and therefore containing the metadata. It is REQUIRED to be served at the corresponding endpoint.", "type": "object", "properties": { + "@context": { + "enum": ["https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/manifest.jsonld"] + }, "textapi": { "description": "the TextAPI version covered by the implementation", "type": "string", @@ -98,7 +101,7 @@ } }, - "required": [ "textapi", "id", "label", "sequence", "license" ], + "required": [ "@context", "textapi", "id", "label", "sequence", "license" ], "patternProperties": { "^x-": {} }, diff --git a/schema/metadata-value.json b/schema/metadata-value.json index 141f72f..6591dc9 100644 --- a/schema/metadata-value.json +++ b/schema/metadata-value.json @@ -5,6 +5,9 @@ "description": "A set of metadata describing the source or its context. Mainly used for key-value pairs.", "type": "object", "properties": { + "@context": { + "enum": ["https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/metadata-value.jsonld"] + }, "key": { "description": "label", "type": "string" diff --git a/schema/repository.json b/schema/repository.json index 5e82445..8235b8c 100644 --- a/schema/repository.json +++ b/schema/repository.json @@ -5,6 +5,9 @@ "description": "A repository archiving the source or derivates, e.g. facsimiles or digitized versions.", "type": "object", "properties": { + "@context": { + "enum": ["https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/repository.jsonld"] + }, "label": { "description": "the label as given by the hosting institution", "type": "string" @@ -24,7 +27,7 @@ "type": "string" } }, - "required": [ "url", "baseUrl", "id" ], + "required": [ "@context", "url", "baseUrl", "id" ], "patternProperties": { "^x-": {} }, diff --git a/schema/sequence.json b/schema/sequence.json index 3c0c56c..df91478 100644 --- a/schema/sequence.json +++ b/schema/sequence.json @@ -5,6 +5,9 @@ "description": "Represents a sequence of collections, manifests or items. Within a manifest it SHOULD contain items exclusively.", "type": "object", "properties": { + "@context": { + "enum": ["https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/secuence.jsonld"] + }, "id": { "description": "URL to find a Manifest Object, Collection Object or Item Object", "type": "string", @@ -15,7 +18,7 @@ "enum": [ "collection", "manifest", "item" ] } }, - "required": [ "id", "type" ], + "required": [ "@context", "id", "type" ], "patternProperties": { "^x-": {} }, diff --git a/schema/support.json b/schema/support.json index 89be143..a8dc926 100644 --- a/schema/support.json +++ b/schema/support.json @@ -5,6 +5,9 @@ "description": "Any material supporting the view is described and referenced in this object. This encompasses fonts and CSS, but also other material to support the rendering MAY be added on request.", "type": "object", "properties": { + "@context": { + "enum": ["https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/support.jsonld"] + }, "type": { "description": "the type of the resource", "enum": [ "font", "css" ] @@ -24,7 +27,7 @@ "$ref": "integrity.json" } }, - "required": [ "type", "mime", "url" ], + "required": [ "@context", "type", "mime", "url" ], "patternProperties": { "^x-": {} }, diff --git a/schema/title.json b/schema/title.json index f09a2ba..8c4b260 100644 --- a/schema/title.json +++ b/schema/title.json @@ -4,6 +4,9 @@ "title": "TextAPI: Title", "type": "object", "properties": { + "@context": { + "enum": ["https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/title.jsonld"] + }, "title": { "description": "a single title", "type": "string", @@ -15,7 +18,7 @@ "enum": [ "main", "sub" ] } }, - "required": [ "title", "type" ], + "required": [ "@context", "title", "type" ], "patternProperties": { "^x-": {} }, -- GitLab From 3c7a7147f4b2da29dd09a73ccbea15cbb2c2541e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mathias=20G=C3=B6bel?= Date: Mon, 11 Apr 2022 14:35:25 +0200 Subject: [PATCH 4/5] feat: add some JSON-LD contexts --- jsonld/integrity.jsonld | 7 +++++++ jsonld/license.jsonld | 11 +++++++++++ jsonld/metadata-value.jsonld | 7 +++++++ 3 files changed, 25 insertions(+) create mode 100644 jsonld/integrity.jsonld create mode 100644 jsonld/license.jsonld create mode 100644 jsonld/metadata-value.jsonld diff --git a/jsonld/integrity.jsonld b/jsonld/integrity.jsonld new file mode 100644 index 0000000..5424000 --- /dev/null +++ b/jsonld/integrity.jsonld @@ -0,0 +1,7 @@ +{ + "@context": + { + "type": "https://www.wikidata.org/entity/Q218341", + "value": "https://www.wikidata.org/entity/P4092" + } +} diff --git a/jsonld/license.jsonld b/jsonld/license.jsonld new file mode 100644 index 0000000..33fb486 --- /dev/null +++ b/jsonld/license.jsonld @@ -0,0 +1,11 @@ +{ + "@context": + { + "id": "https://spdx.org/rdf/terms/#licenseId", + "notes": + { + "@id": "http://purl.org/dc/terms/description", + "@type": "xsd:string" + } + } +} diff --git a/jsonld/metadata-value.jsonld b/jsonld/metadata-value.jsonld new file mode 100644 index 0000000..03cd4b9 --- /dev/null +++ b/jsonld/metadata-value.jsonld @@ -0,0 +1,7 @@ +{ + "@context": + { + "key": "https://schema.org/propertyID", + "value": "https://schema.org/value" + } +} -- GitLab From 66db2d076900da6e1ed075dfa0a958b0ccffefbd Mon Sep 17 00:00:00 2001 From: Michelle Weidling Date: Tue, 12 Apr 2022 07:36:38 +0200 Subject: [PATCH 5/5] fix: add context to OpenAPI --- openapi_3.0.2_specification.yml | 52 +++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) diff --git a/openapi_3.0.2_specification.yml b/openapi_3.0.2_specification.yml index c128db6..8b778cc 100644 --- a/openapi_3.0.2_specification.yml +++ b/openapi_3.0.2_specification.yml @@ -228,11 +228,15 @@ components: CollectionObject: type: object required: + - \@context - textapi - title - collector - sequence properties: + \@context: + type: string + pattern: 'https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/collection.jsonld' textapi: $ref: '#/components/schemas/TextAPIVersion' title: @@ -261,9 +265,13 @@ components: TitleMainObject: type: object required: + - \@context - title - type properties: + \@context: + type: string + pattern: 'https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/title.jsonld' title: type: string type: @@ -273,9 +281,13 @@ components: TitleObject: type: object required: + - \@context - title - type properties: + \@context: + type: string + pattern: 'https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/title.jsonld' title: type: string type: @@ -285,9 +297,13 @@ components: ActorObject: type: object required: + - \@context - role - name properties: + \@context: + type: string + pattern: 'https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/actor.jsonld' role: $ref: '#/components/schemas/StringArray' name: @@ -297,9 +313,13 @@ components: idref: type: object required: + - \@context - type - id properties: + \@context: + type: string + pattern: 'https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/idref.jsonld' base: $ref: '#/components/schemas/URL' type: @@ -333,12 +353,16 @@ components: ManifestObject: type: object required: + - \@context - textapi - id - label - sequence - license properties: + \@context: + type: string + pattern: 'https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/manifest.jsonld' textapi: $ref: '#/components/schemas/TextAPIVersion' id: @@ -358,10 +382,14 @@ components: items: type: object required: + - \@context - url - baseUrl - id properties: + \@context: + type: string + pattern: 'https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/repository.jsonld' label: type: string url: @@ -381,10 +409,14 @@ components: items: type: object required: + - \@context - type - mime - url properties: + \@context: + type: string + pattern: 'https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/support.jsonld' type: type: string pattern: '(font|css)' @@ -408,9 +440,13 @@ components: ImageObject: type: object required: + - \@context - id - license properties: + \@context: + type: string + pattern: 'https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/image.jsonld' id: $ref: '#/components/schemas/URL' manifest: @@ -426,9 +462,13 @@ components: MetadataObjectValue: type: object required: + - \@context - key - value properties: + \@context: + type: string + pattern: 'https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/metadata-value.jsonld' key: type: string value: @@ -450,8 +490,12 @@ components: LicenseObject: type: object required: + - \@context - id properties: + \@context: + type: string + pattern: 'https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/license.jsonld' id: type: string externalDocs: @@ -465,11 +509,15 @@ components: ItemObject: type: object required: + - \@context - textapi - type - lang - content properties: + \@context: + type: string + pattern: 'https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/item.jsonld' textapi: $ref: '#/components/schemas/TextAPIVersion' title: @@ -492,9 +540,13 @@ components: items: type: object required: + - \@context - url - type properties: + \@context: + type: string + pattern: 'https://gitlab.gwdg.de/subugoe/emo/text-api/-/raw/main/jsonld/content.jsonld' url: $ref: '#/components/schemas/URL' type: -- GitLab