From 0e69ddd8b7f59afe9af981e2f1fc3e9a83a531c7 Mon Sep 17 00:00:00 2001 From: Michelle Weidling Date: Thu, 31 Mar 2022 14:31:48 +0200 Subject: [PATCH 01/17] chore: add samples files from JSON schema MR --- sample_server/collection.json | 26 ++++++++++++ sample_server/item.json | 38 ++++++++++++++++++ sample_server/manifest.json | 75 +++++++++++++++++++++++++++++++++++ 3 files changed, 139 insertions(+) create mode 100644 sample_server/collection.json create mode 100644 sample_server/item.json create mode 100644 sample_server/manifest.json diff --git a/sample_server/collection.json b/sample_server/collection.json new file mode 100644 index 0000000..8af1a30 --- /dev/null +++ b/sample_server/collection.json @@ -0,0 +1,26 @@ +{ + "textapi": "1.0.0", + "title": [ + { + "title": "Main Collection Title", + "type": "main" + } + ], + "collector": [ + { + "name": "Hans Wurst", + "role": [ + "collector" + ] + } + ], + "description": "This is the sample collection.", + "sequence": [ + { + "id": "https://example.com/textapi/mycollection/foo/manifest.json", + "type": "manifest" + } + ], + "annotationCollection": "https://example.com/annotationCollection.json" + } + \ No newline at end of file diff --git a/sample_server/item.json b/sample_server/item.json new file mode 100644 index 0000000..ff735f5 --- /dev/null +++ b/sample_server/item.json @@ -0,0 +1,38 @@ +{ + "textapi": "1.0.0", + "title": [ + { + "title": "A Sample Item", + "type": "main" + }, + { + "title": "A Subtitle", + "type": "sub" + } + ], + "type": "section", + "n": "one", + "lang": [ + "fre", "aci" + ], + "langAlt": ["karshuni"], + "content": [ + { + "type": "text/html", + "url": "https://example.com/html-serialization-one.html" + }, + { + "type": "text/xml", + "url": "https://example.com/xml-serialization-two.xml" + } + ], + "description": "This is Section one of the Sample Manifest", + "image": { + "id": "https://example.com/image.png", + "license": { + "id": "CC-BY-4.0" + } + }, + "annotationCollection": "https://example.com/one/annotationCollection.json" + } + \ No newline at end of file diff --git a/sample_server/manifest.json b/sample_server/manifest.json new file mode 100644 index 0000000..0611e22 --- /dev/null +++ b/sample_server/manifest.json @@ -0,0 +1,75 @@ +{ + "textapi": "1.0.0", + "id": "https://example.com/textapi/mycollection/foo/manifest.json", + "label": "Sample Manifest", + "actor": [ + { + "role": ["developer"], + "name": "Jane Doe", + "id": "this_edition$jane_doe", + "idref": { + "base": "https://www.wikidata.org/wiki/", + "id": "Q56314893", + "type": "wikidata" + } + } + ], + "repository": [ + { + "baseUrl": "https://textgridrep.org/", + "id": "textgrid:12345", + "label": "TextGrid Repository", + "url": "https://textgrid.de" + } + ], + "image": { + "id": "https://example.com/myimage.png", + "license": { + "id": "WTFPL", + "notes": "open free libre" + } + }, + + "support": [ + { + "type": "css", + "mime": "text/css", + "url": "https://example.com/resources/mystyle.css" + } + ], + "license": [ + {"id": "CC-BY-SA-4.0"} + ], + "description": "This is a sample manifest. URLs are not meant to be resolved.", + "annotationCollection": "https://example.com/anotherAnnotationCollection.json", + "sequence": [ + { + "id": "https://example.com/textapi/collection/manifest/item1/latest/item.json", + "type": "item" + } + ], + "metadata": [ + { + "key": "my key", + "value": "my value" + }, + { + "key": "a list", + "value": "test", + "metadata": [ + { + "key": "list key one", + "value": "the bullet point" + }, + { + "key": "list key 2", + "value": "another bullet point" + } + ] + } + ], + "x-somekey": 42, + "x-custom-thing": "untyped additional property (xeno data)" + + } + \ No newline at end of file -- GitLab From 0def3c81b4f89cd37514d36216789274ceb6126a Mon Sep 17 00:00:00 2001 From: Michelle Weidling Date: Tue, 5 Apr 2022 07:32:44 +0200 Subject: [PATCH 02/17] fix: remove errors in build (closes #63) --- themes/beautifulhugo/i18n/en.yaml | 4 +--- themes/beautifulhugo/layouts/_default/list.html | 14 -------------- themes/beautifulhugo/layouts/partials/head.html | 4 ---- 3 files changed, 1 insertion(+), 21 deletions(-) diff --git a/themes/beautifulhugo/i18n/en.yaml b/themes/beautifulhugo/i18n/en.yaml index 64c2f7b..56f76bc 100644 --- a/themes/beautifulhugo/i18n/en.yaml +++ b/themes/beautifulhugo/i18n/en.yaml @@ -1,8 +1,6 @@ # Content - id: dateFormat translation: "January 2, 2006" -- id: postedOnDate - translation: "Posted on {{ .Count }}" - id: translationsLabel translation: "Other languages: " - id: translationsSeparator @@ -24,7 +22,7 @@ # Footer - id: poweredBy # Accepts HTML - translation: 'Hugo v{{ .Hugo.Version }} powered  •  Theme by Beautiful Jekyll adapted to Beautiful Hugo' + translation: 'Hugo powered  •  Theme by Beautiful Jekyll adapted to Beautiful Hugo' # Navigation - id: toggleNavigation diff --git a/themes/beautifulhugo/layouts/_default/list.html b/themes/beautifulhugo/layouts/_default/list.html index e9f4c65..5647d09 100644 --- a/themes/beautifulhugo/layouts/_default/list.html +++ b/themes/beautifulhugo/layouts/_default/list.html @@ -59,20 +59,6 @@ {{ end }} - {{ if or (.Paginator.HasPrev) (.Paginator.HasNext) }} - - {{ end }} diff --git a/themes/beautifulhugo/layouts/partials/head.html b/themes/beautifulhugo/layouts/partials/head.html index fd0b8a0..6cde585 100644 --- a/themes/beautifulhugo/layouts/partials/head.html +++ b/themes/beautifulhugo/layouts/partials/head.html @@ -30,13 +30,9 @@ {{- with .Site.Params.fb_app_id }} {{- end }} - - - {{ .Hugo.Generator -}} - -- GitLab From 9153e22f4140ea56f9ee737cb67d4db73d8dbcb7 Mon Sep 17 00:00:00 2001 From: Michelle Weidling Date: Tue, 5 Apr 2022 07:35:16 +0200 Subject: [PATCH 03/17] ci: copy sample server --- .gitlab-ci.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index a59201c..f918902 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -33,6 +33,7 @@ pages: rules: - if: '$CI_COMMIT_TITLE == "update versions"' script: + - cp -r sample_server content - hugo artifacts: paths: -- GitLab From c4aa41710b56a502bfcbff5d5f9afa93a01f70d9 Mon Sep 17 00:00:00 2001 From: Michelle Weidling Date: Tue, 5 Apr 2022 07:43:32 +0200 Subject: [PATCH 04/17] ci: add sample server --- .gitlab-ci.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index f918902..28e0543 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -10,11 +10,13 @@ test: stage: test image: docker.gitlab.gwdg.de/subugoe/emo/text-api:hugo script: + - cp -r sample_server content - hugo except: - main - tags + release: stage: release image: docker.gitlab.gwdg.de/subugoe/emo/text-api:latest -- GitLab From d422b2aec259c515edeacaae53518cfafbc08f07 Mon Sep 17 00:00:00 2001 From: Michelle Weidling Date: Tue, 5 Apr 2022 07:53:01 +0200 Subject: [PATCH 05/17] feat: implement sample server --- openapi_3.0.2_specification.yml | 2 +- sample_server/collection.json | 2 +- sample_server/{ => latest}/item.json | 0 sample_server/manifest.json | 4 ++-- 4 files changed, 4 insertions(+), 4 deletions(-) rename sample_server/{ => latest}/item.json (100%) diff --git a/openapi_3.0.2_specification.yml b/openapi_3.0.2_specification.yml index 4687598..ba3781d 100644 --- a/openapi_3.0.2_specification.yml +++ b/openapi_3.0.2_specification.yml @@ -11,7 +11,7 @@ info: url: https://creativecommons.org/licenses/by-nd/4.0/legalcode servers: - - url: https://api.server.test/v1 + - url: https://subugoe.pages.gwdg.de/emo/text-api/sample_server/collection.json description: The URL of the server you implement the TextAPI at. paths: diff --git a/sample_server/collection.json b/sample_server/collection.json index 8af1a30..ec67f98 100644 --- a/sample_server/collection.json +++ b/sample_server/collection.json @@ -17,7 +17,7 @@ "description": "This is the sample collection.", "sequence": [ { - "id": "https://example.com/textapi/mycollection/foo/manifest.json", + "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/manifest.json", "type": "manifest" } ], diff --git a/sample_server/item.json b/sample_server/latest/item.json similarity index 100% rename from sample_server/item.json rename to sample_server/latest/item.json diff --git a/sample_server/manifest.json b/sample_server/manifest.json index 0611e22..cc04dde 100644 --- a/sample_server/manifest.json +++ b/sample_server/manifest.json @@ -1,6 +1,6 @@ { "textapi": "1.0.0", - "id": "https://example.com/textapi/mycollection/foo/manifest.json", + "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/manifest.json", "label": "Sample Manifest", "actor": [ { @@ -44,7 +44,7 @@ "annotationCollection": "https://example.com/anotherAnnotationCollection.json", "sequence": [ { - "id": "https://example.com/textapi/collection/manifest/item1/latest/item.json", + "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/latest/item.json", "type": "item" } ], -- GitLab From 462a30b418bc2988252ba0f780af2e3acd3340c6 Mon Sep 17 00:00:00 2001 From: Michelle Weidling Date: Tue, 5 Apr 2022 07:53:20 +0200 Subject: [PATCH 06/17] ci: add artifacts for testing --- .gitlab-ci.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 28e0543..8341739 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -15,6 +15,9 @@ test: except: - main - tags + artifacts: + paths: + - public release: -- GitLab From cbd34e0a4b4d96995eae64e9b6f682a0666204a9 Mon Sep 17 00:00:00 2001 From: Michelle Weidling Date: Tue, 5 Apr 2022 08:04:54 +0200 Subject: [PATCH 07/17] ci: update image (cf. #63) --- .gitlab-ci.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 8341739..0c73ca5 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -8,7 +8,7 @@ stages: test: stage: test - image: docker.gitlab.gwdg.de/subugoe/emo/text-api:hugo + image: registry.gitlab.com/pages/hugo/hugo:latest script: - cp -r sample_server content - hugo @@ -33,7 +33,7 @@ release: pages: stage: publish - image: docker.gitlab.gwdg.de/subugoe/emo/text-api:hugo + image: registry.gitlab.com/pages/hugo/hugo:latest # "update versions" is the commit title we set in archive-version.sh rules: - if: '$CI_COMMIT_TITLE == "update versions"' -- GitLab From bb1d5d6f88f56cd568c4d250b377ac6abfc0244e Mon Sep 17 00:00:00 2001 From: Michelle Weidling Date: Tue, 5 Apr 2022 08:06:38 +0200 Subject: [PATCH 08/17] ci: remove surplus Dockerfile --- Dockerfile.hugo | 1 - 1 file changed, 1 deletion(-) delete mode 100644 Dockerfile.hugo diff --git a/Dockerfile.hugo b/Dockerfile.hugo deleted file mode 100644 index debc94e..0000000 --- a/Dockerfile.hugo +++ /dev/null @@ -1 +0,0 @@ -FROM registry.gitlab.com/pages/hugo/hugo:0.92.2 \ No newline at end of file -- GitLab From 890a5f43ac87de2362ca18ffc54979c383760053 Mon Sep 17 00:00:00 2001 From: Michelle Weidling Date: Tue, 5 Apr 2022 08:10:12 +0200 Subject: [PATCH 09/17] chore: update config --- config.toml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/config.toml b/config.toml index 767d5bd..046e4ca 100644 --- a/config.toml +++ b/config.toml @@ -51,6 +51,11 @@ pygmentCodeFences = true url = "page/faq/" weight = 5 +[[menu.main]] + name = "Sample Server" + url = "sample_server/collection.json" + weight = 7 + [[menu.main]] identifier = "archive" name = "Older versions" -- GitLab From b3b2637567833821da9fb00bc183e7ef8e305a35 Mon Sep 17 00:00:00 2001 From: Michelle Weidling Date: Tue, 5 Apr 2022 08:13:35 +0200 Subject: [PATCH 10/17] docs: update README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7354744..b0c7f77 100644 --- a/README.md +++ b/README.md @@ -31,12 +31,12 @@ Read more at Hugo's [documentation](https://gohugo.io/overview/introduction/). If you clone or download this project to your local computer and run `hugo server`, your site can be accessed under `localhost:1313/hugo/`. -The theme used is adapted from . +The theme used is adapted from and changed to work for Hugo > 0.92.0. ## Deployment This project's static Pages are built by GitLab CI, following the steps defined in [`.gitlab-ci.yml`](.gitlab-ci.yml). -The page is built after each commit to the `master` branch and deployed to . +The page is built after each commit to the `main` branch and deployed to . Since this repository is still protected, only logged in members of the `subugoe` can see the GitLab page. ## Versioning -- GitLab From 4cb203f5f207a2e66e47342b633ae5cd3b5afafe Mon Sep 17 00:00:00 2001 From: Michelle Weidling Date: Tue, 5 Apr 2022 08:17:14 +0200 Subject: [PATCH 11/17] docs: update links --- openapi_3.0.2_specification.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/openapi_3.0.2_specification.yml b/openapi_3.0.2_specification.yml index ba3781d..e72eeea 100644 --- a/openapi_3.0.2_specification.yml +++ b/openapi_3.0.2_specification.yml @@ -42,7 +42,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CollectionObject' - example: https://subugoe.pages.gwdg.de/emo/text-api/page/specs/#collectionjson + example: https://subugoe.pages.gwdg.de/emo/text-api/sample_server/collection.json /{collection}/{manifest}/manifest.json: get: @@ -75,7 +75,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ManifestObject' - example: https://subugoe.pages.gwdg.de/emo/text-api/page/specs/#manifestjson + example: https://subugoe.pages.gwdg.de/emo/text-api/sample_server/manifest.json /{collection}/{manifest}/{item}/{revision}/item.json: @@ -126,7 +126,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ItemObject' - example: https://subugoe.pages.gwdg.de/emo/text-api/page/specs/#itemjson + example: https://subugoe.pages.gwdg.de/emo/text-api/sample_server/latest/item.json /{collection}/{manifest}/{item}/{revision}/full.json: @@ -163,7 +163,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ItemObject' - example: https://subugoe.pages.gwdg.de/emo/text-api/page/specs/#itemjson + example: https://subugoe.pages.gwdg.de/emo/text-api/sample_server/latest/item.json components: schemas: -- GitLab From 6224d54fb3e27423ae16d92e556236da5cada209 Mon Sep 17 00:00:00 2001 From: Michelle Weidling Date: Tue, 5 Apr 2022 08:25:47 +0200 Subject: [PATCH 12/17] docs: adjust link --- openapi_3.0.2_specification.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openapi_3.0.2_specification.yml b/openapi_3.0.2_specification.yml index e72eeea..63aeb78 100644 --- a/openapi_3.0.2_specification.yml +++ b/openapi_3.0.2_specification.yml @@ -11,7 +11,7 @@ info: url: https://creativecommons.org/licenses/by-nd/4.0/legalcode servers: - - url: https://subugoe.pages.gwdg.de/emo/text-api/sample_server/collection.json + - url: https://subugoe.pages.gwdg.de/emo/text-api/sample_server/ description: The URL of the server you implement the TextAPI at. paths: -- GitLab From 1187d55c0d0993850d2c9661f5df7a729dc21144 Mon Sep 17 00:00:00 2001 From: Michelle Weidling Date: Tue, 5 Apr 2022 08:29:39 +0200 Subject: [PATCH 13/17] docs: update examples --- openapi_3.0.2_specification.yml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/openapi_3.0.2_specification.yml b/openapi_3.0.2_specification.yml index 63aeb78..f064302 100644 --- a/openapi_3.0.2_specification.yml +++ b/openapi_3.0.2_specification.yml @@ -31,10 +31,10 @@ paths: examples: semanticID: summary: An identifier that has a meaning for humans - value: {"semanticID": "ShakespearesWorks"} + value: "ShakespearesWorks" ID: summary: An identifier with no special meaning for humans - value: {"ID": "12a34b"} + value: "12a34b" responses: '200': description: OK @@ -64,10 +64,10 @@ paths: examples: semanticID: summary: An identifier that has a meaning for humans - value: {"semanticID": "Othello"} + value: "Othello" ID: summary: An identifier with no special meaning for humans - value: {"ID": "12a34b"} + value: "12a34b" responses: '200': description: OK @@ -103,10 +103,10 @@ paths: examples: semanticID: summary: An identifier that has a meaning for humans - value: {"semanticID": "page90"} + value: "page90" ID: summary: An identifier with no special meaning for humans - value: {"ID": "3x_2"} + value: "3x_2" - name: revision in: path description: The revision of the item to be delivered. @@ -115,10 +115,10 @@ paths: examples: semanticID: summary: A revision that has a meaning for humans - value: {"semanticID": "1"} + value: "1" ID: summary: An revision with no special meaning for humans - value: {"ID": "fb406b265a779b43afa635bc8da79d81"} + value: "fb406b265a779b43afa635bc8da79d81" responses: '200': description: OK -- GitLab From eb913c6d198c39a0709b2bad25bdb8612b1e333a Mon Sep 17 00:00:00 2001 From: Michelle Weidling Date: Tue, 5 Apr 2022 08:35:35 +0200 Subject: [PATCH 14/17] chore: typo --- openapi_3.0.2_specification.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openapi_3.0.2_specification.yml b/openapi_3.0.2_specification.yml index f064302..29e1aa7 100644 --- a/openapi_3.0.2_specification.yml +++ b/openapi_3.0.2_specification.yml @@ -117,7 +117,7 @@ paths: summary: A revision that has a meaning for humans value: "1" ID: - summary: An revision with no special meaning for humans + summary: A revision with no special meaning for humans value: "fb406b265a779b43afa635bc8da79d81" responses: '200': -- GitLab From 469deedc0b1b492ac69afe8314ae4fbd5ca6ce2b Mon Sep 17 00:00:00 2001 From: Michelle Weidling Date: Tue, 5 Apr 2022 08:44:35 +0200 Subject: [PATCH 15/17] chore: remove smaple server from nav bar --- config.toml | 5 ----- 1 file changed, 5 deletions(-) diff --git a/config.toml b/config.toml index 046e4ca..767d5bd 100644 --- a/config.toml +++ b/config.toml @@ -51,11 +51,6 @@ pygmentCodeFences = true url = "page/faq/" weight = 5 -[[menu.main]] - name = "Sample Server" - url = "sample_server/collection.json" - weight = 7 - [[menu.main]] identifier = "archive" name = "Older versions" -- GitLab From 207a7b17d4ea872442f42fe491a3b7600b969fd2 Mon Sep 17 00:00:00 2001 From: Michelle Weidling Date: Tue, 5 Apr 2022 08:44:57 +0200 Subject: [PATCH 16/17] docs: adjust sample server to docs --- .../12a34b/3x_2/1}/item.json | 0 .../item.json | 38 ++++++++ .../{ => 12a34b/12a34b}/manifest.json | 16 +++- .../12a34b/12a34b/page90/1/item.json | 38 ++++++++ .../item.json | 38 ++++++++ sample_server/12a34b/Othello/3x_2/1/item.json | 38 ++++++++ .../item.json | 38 ++++++++ sample_server/12a34b/Othello/manifest.json | 87 +++++++++++++++++++ .../12a34b/Othello/page90/1/item.json | 38 ++++++++ .../item.json | 38 ++++++++ sample_server/{ => 12a34b}/collection.json | 8 +- .../ShakespearesWorks/12a34b/3x_2/1/item.json | 38 ++++++++ .../item.json | 38 ++++++++ .../ShakespearesWorks/12a34b/manifest.json | 87 +++++++++++++++++++ .../12a34b/page90/1/item.json | 38 ++++++++ .../item.json | 38 ++++++++ .../Othello/3x_2/1/item.json | 38 ++++++++ .../item.json | 38 ++++++++ .../ShakespearesWorks/Othello/manifest.json | 87 +++++++++++++++++++ .../Othello/page90/1/item.json | 38 ++++++++ .../item.json | 38 ++++++++ .../ShakespearesWorks/collection.json | 30 +++++++ 22 files changed, 881 insertions(+), 4 deletions(-) rename sample_server/{latest => 12a34b/12a34b/3x_2/1}/item.json (100%) create mode 100644 sample_server/12a34b/12a34b/3x_2/fb406b265a779b43afa635bc8da79d81/item.json rename sample_server/{ => 12a34b/12a34b}/manifest.json (75%) create mode 100644 sample_server/12a34b/12a34b/page90/1/item.json create mode 100644 sample_server/12a34b/12a34b/page90/fb406b265a779b43afa635bc8da79d81/item.json create mode 100644 sample_server/12a34b/Othello/3x_2/1/item.json create mode 100644 sample_server/12a34b/Othello/3x_2/fb406b265a779b43afa635bc8da79d81/item.json create mode 100644 sample_server/12a34b/Othello/manifest.json create mode 100644 sample_server/12a34b/Othello/page90/1/item.json create mode 100644 sample_server/12a34b/Othello/page90/fb406b265a779b43afa635bc8da79d81/item.json rename sample_server/{ => 12a34b}/collection.json (67%) create mode 100644 sample_server/ShakespearesWorks/12a34b/3x_2/1/item.json create mode 100644 sample_server/ShakespearesWorks/12a34b/3x_2/fb406b265a779b43afa635bc8da79d81/item.json create mode 100644 sample_server/ShakespearesWorks/12a34b/manifest.json create mode 100644 sample_server/ShakespearesWorks/12a34b/page90/1/item.json create mode 100644 sample_server/ShakespearesWorks/12a34b/page90/fb406b265a779b43afa635bc8da79d81/item.json create mode 100644 sample_server/ShakespearesWorks/Othello/3x_2/1/item.json create mode 100644 sample_server/ShakespearesWorks/Othello/3x_2/fb406b265a779b43afa635bc8da79d81/item.json create mode 100644 sample_server/ShakespearesWorks/Othello/manifest.json create mode 100644 sample_server/ShakespearesWorks/Othello/page90/1/item.json create mode 100644 sample_server/ShakespearesWorks/Othello/page90/fb406b265a779b43afa635bc8da79d81/item.json create mode 100644 sample_server/ShakespearesWorks/collection.json diff --git a/sample_server/latest/item.json b/sample_server/12a34b/12a34b/3x_2/1/item.json similarity index 100% rename from sample_server/latest/item.json rename to sample_server/12a34b/12a34b/3x_2/1/item.json diff --git a/sample_server/12a34b/12a34b/3x_2/fb406b265a779b43afa635bc8da79d81/item.json b/sample_server/12a34b/12a34b/3x_2/fb406b265a779b43afa635bc8da79d81/item.json new file mode 100644 index 0000000..ff735f5 --- /dev/null +++ b/sample_server/12a34b/12a34b/3x_2/fb406b265a779b43afa635bc8da79d81/item.json @@ -0,0 +1,38 @@ +{ + "textapi": "1.0.0", + "title": [ + { + "title": "A Sample Item", + "type": "main" + }, + { + "title": "A Subtitle", + "type": "sub" + } + ], + "type": "section", + "n": "one", + "lang": [ + "fre", "aci" + ], + "langAlt": ["karshuni"], + "content": [ + { + "type": "text/html", + "url": "https://example.com/html-serialization-one.html" + }, + { + "type": "text/xml", + "url": "https://example.com/xml-serialization-two.xml" + } + ], + "description": "This is Section one of the Sample Manifest", + "image": { + "id": "https://example.com/image.png", + "license": { + "id": "CC-BY-4.0" + } + }, + "annotationCollection": "https://example.com/one/annotationCollection.json" + } + \ No newline at end of file diff --git a/sample_server/manifest.json b/sample_server/12a34b/12a34b/manifest.json similarity index 75% rename from sample_server/manifest.json rename to sample_server/12a34b/12a34b/manifest.json index cc04dde..ced3727 100644 --- a/sample_server/manifest.json +++ b/sample_server/12a34b/12a34b/manifest.json @@ -1,6 +1,6 @@ { "textapi": "1.0.0", - "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/manifest.json", + "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/12a34b/12a34b/manifest.json", "label": "Sample Manifest", "actor": [ { @@ -44,7 +44,19 @@ "annotationCollection": "https://example.com/anotherAnnotationCollection.json", "sequence": [ { - "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/latest/item.json", + "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/12a34b/12a34b/3x_2/fb406b265a779b43afa635bc8da79d81/item.json", + "type": "item" + }, + { + "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/12a34b/12a34b/3x_2/1/item.json", + "type": "item" + }, + { + "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/12a34b/12a34b/page90/fb406b265a779b43afa635bc8da79d81/item.json", + "type": "item" + }, + { + "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/12a34b/12a34b/page90/1/item.json", "type": "item" } ], diff --git a/sample_server/12a34b/12a34b/page90/1/item.json b/sample_server/12a34b/12a34b/page90/1/item.json new file mode 100644 index 0000000..ff735f5 --- /dev/null +++ b/sample_server/12a34b/12a34b/page90/1/item.json @@ -0,0 +1,38 @@ +{ + "textapi": "1.0.0", + "title": [ + { + "title": "A Sample Item", + "type": "main" + }, + { + "title": "A Subtitle", + "type": "sub" + } + ], + "type": "section", + "n": "one", + "lang": [ + "fre", "aci" + ], + "langAlt": ["karshuni"], + "content": [ + { + "type": "text/html", + "url": "https://example.com/html-serialization-one.html" + }, + { + "type": "text/xml", + "url": "https://example.com/xml-serialization-two.xml" + } + ], + "description": "This is Section one of the Sample Manifest", + "image": { + "id": "https://example.com/image.png", + "license": { + "id": "CC-BY-4.0" + } + }, + "annotationCollection": "https://example.com/one/annotationCollection.json" + } + \ No newline at end of file diff --git a/sample_server/12a34b/12a34b/page90/fb406b265a779b43afa635bc8da79d81/item.json b/sample_server/12a34b/12a34b/page90/fb406b265a779b43afa635bc8da79d81/item.json new file mode 100644 index 0000000..ff735f5 --- /dev/null +++ b/sample_server/12a34b/12a34b/page90/fb406b265a779b43afa635bc8da79d81/item.json @@ -0,0 +1,38 @@ +{ + "textapi": "1.0.0", + "title": [ + { + "title": "A Sample Item", + "type": "main" + }, + { + "title": "A Subtitle", + "type": "sub" + } + ], + "type": "section", + "n": "one", + "lang": [ + "fre", "aci" + ], + "langAlt": ["karshuni"], + "content": [ + { + "type": "text/html", + "url": "https://example.com/html-serialization-one.html" + }, + { + "type": "text/xml", + "url": "https://example.com/xml-serialization-two.xml" + } + ], + "description": "This is Section one of the Sample Manifest", + "image": { + "id": "https://example.com/image.png", + "license": { + "id": "CC-BY-4.0" + } + }, + "annotationCollection": "https://example.com/one/annotationCollection.json" + } + \ No newline at end of file diff --git a/sample_server/12a34b/Othello/3x_2/1/item.json b/sample_server/12a34b/Othello/3x_2/1/item.json new file mode 100644 index 0000000..ff735f5 --- /dev/null +++ b/sample_server/12a34b/Othello/3x_2/1/item.json @@ -0,0 +1,38 @@ +{ + "textapi": "1.0.0", + "title": [ + { + "title": "A Sample Item", + "type": "main" + }, + { + "title": "A Subtitle", + "type": "sub" + } + ], + "type": "section", + "n": "one", + "lang": [ + "fre", "aci" + ], + "langAlt": ["karshuni"], + "content": [ + { + "type": "text/html", + "url": "https://example.com/html-serialization-one.html" + }, + { + "type": "text/xml", + "url": "https://example.com/xml-serialization-two.xml" + } + ], + "description": "This is Section one of the Sample Manifest", + "image": { + "id": "https://example.com/image.png", + "license": { + "id": "CC-BY-4.0" + } + }, + "annotationCollection": "https://example.com/one/annotationCollection.json" + } + \ No newline at end of file diff --git a/sample_server/12a34b/Othello/3x_2/fb406b265a779b43afa635bc8da79d81/item.json b/sample_server/12a34b/Othello/3x_2/fb406b265a779b43afa635bc8da79d81/item.json new file mode 100644 index 0000000..ff735f5 --- /dev/null +++ b/sample_server/12a34b/Othello/3x_2/fb406b265a779b43afa635bc8da79d81/item.json @@ -0,0 +1,38 @@ +{ + "textapi": "1.0.0", + "title": [ + { + "title": "A Sample Item", + "type": "main" + }, + { + "title": "A Subtitle", + "type": "sub" + } + ], + "type": "section", + "n": "one", + "lang": [ + "fre", "aci" + ], + "langAlt": ["karshuni"], + "content": [ + { + "type": "text/html", + "url": "https://example.com/html-serialization-one.html" + }, + { + "type": "text/xml", + "url": "https://example.com/xml-serialization-two.xml" + } + ], + "description": "This is Section one of the Sample Manifest", + "image": { + "id": "https://example.com/image.png", + "license": { + "id": "CC-BY-4.0" + } + }, + "annotationCollection": "https://example.com/one/annotationCollection.json" + } + \ No newline at end of file diff --git a/sample_server/12a34b/Othello/manifest.json b/sample_server/12a34b/Othello/manifest.json new file mode 100644 index 0000000..e3bf33f --- /dev/null +++ b/sample_server/12a34b/Othello/manifest.json @@ -0,0 +1,87 @@ +{ + "textapi": "1.0.0", + "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/12a34b/Othello/manifest.json", + "label": "Sample Manifest", + "actor": [ + { + "role": ["developer"], + "name": "Jane Doe", + "id": "this_edition$jane_doe", + "idref": { + "base": "https://www.wikidata.org/wiki/", + "id": "Q56314893", + "type": "wikidata" + } + } + ], + "repository": [ + { + "baseUrl": "https://textgridrep.org/", + "id": "textgrid:12345", + "label": "TextGrid Repository", + "url": "https://textgrid.de" + } + ], + "image": { + "id": "https://example.com/myimage.png", + "license": { + "id": "WTFPL", + "notes": "open free libre" + } + }, + + "support": [ + { + "type": "css", + "mime": "text/css", + "url": "https://example.com/resources/mystyle.css" + } + ], + "license": [ + {"id": "CC-BY-SA-4.0"} + ], + "description": "This is a sample manifest. URLs are not meant to be resolved.", + "annotationCollection": "https://example.com/anotherAnnotationCollection.json", + "sequence": [ + { + "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/12a34b/Othello/3x_2/fb406b265a779b43afa635bc8da79d81/item.json", + "type": "item" + }, + { + "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/12a34b/Othello/3x_2/1/item.json", + "type": "item" + }, + { + "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/12a34b/Othello/page90/fb406b265a779b43afa635bc8da79d81/item.json", + "type": "item" + }, + { + "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/12a34b/Othello/page90/1/item.json", + "type": "item" + } + ], + "metadata": [ + { + "key": "my key", + "value": "my value" + }, + { + "key": "a list", + "value": "test", + "metadata": [ + { + "key": "list key one", + "value": "the bullet point" + }, + { + "key": "list key 2", + "value": "another bullet point" + } + ] + } + ], + "x-somekey": 42, + "x-custom-thing": "untyped additional property (xeno data)" + + } + \ No newline at end of file diff --git a/sample_server/12a34b/Othello/page90/1/item.json b/sample_server/12a34b/Othello/page90/1/item.json new file mode 100644 index 0000000..ff735f5 --- /dev/null +++ b/sample_server/12a34b/Othello/page90/1/item.json @@ -0,0 +1,38 @@ +{ + "textapi": "1.0.0", + "title": [ + { + "title": "A Sample Item", + "type": "main" + }, + { + "title": "A Subtitle", + "type": "sub" + } + ], + "type": "section", + "n": "one", + "lang": [ + "fre", "aci" + ], + "langAlt": ["karshuni"], + "content": [ + { + "type": "text/html", + "url": "https://example.com/html-serialization-one.html" + }, + { + "type": "text/xml", + "url": "https://example.com/xml-serialization-two.xml" + } + ], + "description": "This is Section one of the Sample Manifest", + "image": { + "id": "https://example.com/image.png", + "license": { + "id": "CC-BY-4.0" + } + }, + "annotationCollection": "https://example.com/one/annotationCollection.json" + } + \ No newline at end of file diff --git a/sample_server/12a34b/Othello/page90/fb406b265a779b43afa635bc8da79d81/item.json b/sample_server/12a34b/Othello/page90/fb406b265a779b43afa635bc8da79d81/item.json new file mode 100644 index 0000000..ff735f5 --- /dev/null +++ b/sample_server/12a34b/Othello/page90/fb406b265a779b43afa635bc8da79d81/item.json @@ -0,0 +1,38 @@ +{ + "textapi": "1.0.0", + "title": [ + { + "title": "A Sample Item", + "type": "main" + }, + { + "title": "A Subtitle", + "type": "sub" + } + ], + "type": "section", + "n": "one", + "lang": [ + "fre", "aci" + ], + "langAlt": ["karshuni"], + "content": [ + { + "type": "text/html", + "url": "https://example.com/html-serialization-one.html" + }, + { + "type": "text/xml", + "url": "https://example.com/xml-serialization-two.xml" + } + ], + "description": "This is Section one of the Sample Manifest", + "image": { + "id": "https://example.com/image.png", + "license": { + "id": "CC-BY-4.0" + } + }, + "annotationCollection": "https://example.com/one/annotationCollection.json" + } + \ No newline at end of file diff --git a/sample_server/collection.json b/sample_server/12a34b/collection.json similarity index 67% rename from sample_server/collection.json rename to sample_server/12a34b/collection.json index ec67f98..296824c 100644 --- a/sample_server/collection.json +++ b/sample_server/12a34b/collection.json @@ -2,7 +2,7 @@ "textapi": "1.0.0", "title": [ { - "title": "Main Collection Title", + "title": "Shakespeares Works", "type": "main" } ], @@ -17,7 +17,11 @@ "description": "This is the sample collection.", "sequence": [ { - "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/manifest.json", + "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/12a34b/Othello/manifest.json", + "type": "manifest" + }, + { + "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/12a34b/12a34b/manifest.json", "type": "manifest" } ], diff --git a/sample_server/ShakespearesWorks/12a34b/3x_2/1/item.json b/sample_server/ShakespearesWorks/12a34b/3x_2/1/item.json new file mode 100644 index 0000000..ff735f5 --- /dev/null +++ b/sample_server/ShakespearesWorks/12a34b/3x_2/1/item.json @@ -0,0 +1,38 @@ +{ + "textapi": "1.0.0", + "title": [ + { + "title": "A Sample Item", + "type": "main" + }, + { + "title": "A Subtitle", + "type": "sub" + } + ], + "type": "section", + "n": "one", + "lang": [ + "fre", "aci" + ], + "langAlt": ["karshuni"], + "content": [ + { + "type": "text/html", + "url": "https://example.com/html-serialization-one.html" + }, + { + "type": "text/xml", + "url": "https://example.com/xml-serialization-two.xml" + } + ], + "description": "This is Section one of the Sample Manifest", + "image": { + "id": "https://example.com/image.png", + "license": { + "id": "CC-BY-4.0" + } + }, + "annotationCollection": "https://example.com/one/annotationCollection.json" + } + \ No newline at end of file diff --git a/sample_server/ShakespearesWorks/12a34b/3x_2/fb406b265a779b43afa635bc8da79d81/item.json b/sample_server/ShakespearesWorks/12a34b/3x_2/fb406b265a779b43afa635bc8da79d81/item.json new file mode 100644 index 0000000..ff735f5 --- /dev/null +++ b/sample_server/ShakespearesWorks/12a34b/3x_2/fb406b265a779b43afa635bc8da79d81/item.json @@ -0,0 +1,38 @@ +{ + "textapi": "1.0.0", + "title": [ + { + "title": "A Sample Item", + "type": "main" + }, + { + "title": "A Subtitle", + "type": "sub" + } + ], + "type": "section", + "n": "one", + "lang": [ + "fre", "aci" + ], + "langAlt": ["karshuni"], + "content": [ + { + "type": "text/html", + "url": "https://example.com/html-serialization-one.html" + }, + { + "type": "text/xml", + "url": "https://example.com/xml-serialization-two.xml" + } + ], + "description": "This is Section one of the Sample Manifest", + "image": { + "id": "https://example.com/image.png", + "license": { + "id": "CC-BY-4.0" + } + }, + "annotationCollection": "https://example.com/one/annotationCollection.json" + } + \ No newline at end of file diff --git a/sample_server/ShakespearesWorks/12a34b/manifest.json b/sample_server/ShakespearesWorks/12a34b/manifest.json new file mode 100644 index 0000000..5239d40 --- /dev/null +++ b/sample_server/ShakespearesWorks/12a34b/manifest.json @@ -0,0 +1,87 @@ +{ + "textapi": "1.0.0", + "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/ShakespearesWorks/12a34b/manifest.json", + "label": "Sample Manifest", + "actor": [ + { + "role": ["developer"], + "name": "Jane Doe", + "id": "this_edition$jane_doe", + "idref": { + "base": "https://www.wikidata.org/wiki/", + "id": "Q56314893", + "type": "wikidata" + } + } + ], + "repository": [ + { + "baseUrl": "https://textgridrep.org/", + "id": "textgrid:12345", + "label": "TextGrid Repository", + "url": "https://textgrid.de" + } + ], + "image": { + "id": "https://example.com/myimage.png", + "license": { + "id": "WTFPL", + "notes": "open free libre" + } + }, + + "support": [ + { + "type": "css", + "mime": "text/css", + "url": "https://example.com/resources/mystyle.css" + } + ], + "license": [ + {"id": "CC-BY-SA-4.0"} + ], + "description": "This is a sample manifest. URLs are not meant to be resolved.", + "annotationCollection": "https://example.com/anotherAnnotationCollection.json", + "sequence": [ + { + "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/ShakespearesWorks/12a34b/3x_2/fb406b265a779b43afa635bc8da79d81/item.json", + "type": "item" + }, + { + "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/ShakespearesWorks/12a34b/3x_2/1/item.json", + "type": "item" + }, + { + "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/ShakespearesWorks/12a34b/page90/fb406b265a779b43afa635bc8da79d81/item.json", + "type": "item" + }, + { + "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/ShakespearesWorks/12a34b/page90/1/item.json", + "type": "item" + } + ], + "metadata": [ + { + "key": "my key", + "value": "my value" + }, + { + "key": "a list", + "value": "test", + "metadata": [ + { + "key": "list key one", + "value": "the bullet point" + }, + { + "key": "list key 2", + "value": "another bullet point" + } + ] + } + ], + "x-somekey": 42, + "x-custom-thing": "untyped additional property (xeno data)" + + } + \ No newline at end of file diff --git a/sample_server/ShakespearesWorks/12a34b/page90/1/item.json b/sample_server/ShakespearesWorks/12a34b/page90/1/item.json new file mode 100644 index 0000000..ff735f5 --- /dev/null +++ b/sample_server/ShakespearesWorks/12a34b/page90/1/item.json @@ -0,0 +1,38 @@ +{ + "textapi": "1.0.0", + "title": [ + { + "title": "A Sample Item", + "type": "main" + }, + { + "title": "A Subtitle", + "type": "sub" + } + ], + "type": "section", + "n": "one", + "lang": [ + "fre", "aci" + ], + "langAlt": ["karshuni"], + "content": [ + { + "type": "text/html", + "url": "https://example.com/html-serialization-one.html" + }, + { + "type": "text/xml", + "url": "https://example.com/xml-serialization-two.xml" + } + ], + "description": "This is Section one of the Sample Manifest", + "image": { + "id": "https://example.com/image.png", + "license": { + "id": "CC-BY-4.0" + } + }, + "annotationCollection": "https://example.com/one/annotationCollection.json" + } + \ No newline at end of file diff --git a/sample_server/ShakespearesWorks/12a34b/page90/fb406b265a779b43afa635bc8da79d81/item.json b/sample_server/ShakespearesWorks/12a34b/page90/fb406b265a779b43afa635bc8da79d81/item.json new file mode 100644 index 0000000..ff735f5 --- /dev/null +++ b/sample_server/ShakespearesWorks/12a34b/page90/fb406b265a779b43afa635bc8da79d81/item.json @@ -0,0 +1,38 @@ +{ + "textapi": "1.0.0", + "title": [ + { + "title": "A Sample Item", + "type": "main" + }, + { + "title": "A Subtitle", + "type": "sub" + } + ], + "type": "section", + "n": "one", + "lang": [ + "fre", "aci" + ], + "langAlt": ["karshuni"], + "content": [ + { + "type": "text/html", + "url": "https://example.com/html-serialization-one.html" + }, + { + "type": "text/xml", + "url": "https://example.com/xml-serialization-two.xml" + } + ], + "description": "This is Section one of the Sample Manifest", + "image": { + "id": "https://example.com/image.png", + "license": { + "id": "CC-BY-4.0" + } + }, + "annotationCollection": "https://example.com/one/annotationCollection.json" + } + \ No newline at end of file diff --git a/sample_server/ShakespearesWorks/Othello/3x_2/1/item.json b/sample_server/ShakespearesWorks/Othello/3x_2/1/item.json new file mode 100644 index 0000000..ff735f5 --- /dev/null +++ b/sample_server/ShakespearesWorks/Othello/3x_2/1/item.json @@ -0,0 +1,38 @@ +{ + "textapi": "1.0.0", + "title": [ + { + "title": "A Sample Item", + "type": "main" + }, + { + "title": "A Subtitle", + "type": "sub" + } + ], + "type": "section", + "n": "one", + "lang": [ + "fre", "aci" + ], + "langAlt": ["karshuni"], + "content": [ + { + "type": "text/html", + "url": "https://example.com/html-serialization-one.html" + }, + { + "type": "text/xml", + "url": "https://example.com/xml-serialization-two.xml" + } + ], + "description": "This is Section one of the Sample Manifest", + "image": { + "id": "https://example.com/image.png", + "license": { + "id": "CC-BY-4.0" + } + }, + "annotationCollection": "https://example.com/one/annotationCollection.json" + } + \ No newline at end of file diff --git a/sample_server/ShakespearesWorks/Othello/3x_2/fb406b265a779b43afa635bc8da79d81/item.json b/sample_server/ShakespearesWorks/Othello/3x_2/fb406b265a779b43afa635bc8da79d81/item.json new file mode 100644 index 0000000..ff735f5 --- /dev/null +++ b/sample_server/ShakespearesWorks/Othello/3x_2/fb406b265a779b43afa635bc8da79d81/item.json @@ -0,0 +1,38 @@ +{ + "textapi": "1.0.0", + "title": [ + { + "title": "A Sample Item", + "type": "main" + }, + { + "title": "A Subtitle", + "type": "sub" + } + ], + "type": "section", + "n": "one", + "lang": [ + "fre", "aci" + ], + "langAlt": ["karshuni"], + "content": [ + { + "type": "text/html", + "url": "https://example.com/html-serialization-one.html" + }, + { + "type": "text/xml", + "url": "https://example.com/xml-serialization-two.xml" + } + ], + "description": "This is Section one of the Sample Manifest", + "image": { + "id": "https://example.com/image.png", + "license": { + "id": "CC-BY-4.0" + } + }, + "annotationCollection": "https://example.com/one/annotationCollection.json" + } + \ No newline at end of file diff --git a/sample_server/ShakespearesWorks/Othello/manifest.json b/sample_server/ShakespearesWorks/Othello/manifest.json new file mode 100644 index 0000000..733b799 --- /dev/null +++ b/sample_server/ShakespearesWorks/Othello/manifest.json @@ -0,0 +1,87 @@ +{ + "textapi": "1.0.0", + "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/ShakespearesWorks/Othello/manifest.json", + "label": "Sample Manifest", + "actor": [ + { + "role": ["developer"], + "name": "Jane Doe", + "id": "this_edition$jane_doe", + "idref": { + "base": "https://www.wikidata.org/wiki/", + "id": "Q56314893", + "type": "wikidata" + } + } + ], + "repository": [ + { + "baseUrl": "https://textgridrep.org/", + "id": "textgrid:12345", + "label": "TextGrid Repository", + "url": "https://textgrid.de" + } + ], + "image": { + "id": "https://example.com/myimage.png", + "license": { + "id": "WTFPL", + "notes": "open free libre" + } + }, + + "support": [ + { + "type": "css", + "mime": "text/css", + "url": "https://example.com/resources/mystyle.css" + } + ], + "license": [ + {"id": "CC-BY-SA-4.0"} + ], + "description": "This is a sample manifest. URLs are not meant to be resolved.", + "annotationCollection": "https://example.com/anotherAnnotationCollection.json", + "sequence": [ + { + "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/ShakespearesWorks/Othello/3x_2/fb406b265a779b43afa635bc8da79d81/item.json", + "type": "item" + }, + { + "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/ShakespearesWorks/Othello/3x_2/1/item.json", + "type": "item" + }, + { + "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/ShakespearesWorks/Othello/page90/fb406b265a779b43afa635bc8da79d81/item.json", + "type": "item" + }, + { + "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/ShakespearesWorks/Othello/page90/1/item.json", + "type": "item" + } + ], + "metadata": [ + { + "key": "my key", + "value": "my value" + }, + { + "key": "a list", + "value": "test", + "metadata": [ + { + "key": "list key one", + "value": "the bullet point" + }, + { + "key": "list key 2", + "value": "another bullet point" + } + ] + } + ], + "x-somekey": 42, + "x-custom-thing": "untyped additional property (xeno data)" + + } + \ No newline at end of file diff --git a/sample_server/ShakespearesWorks/Othello/page90/1/item.json b/sample_server/ShakespearesWorks/Othello/page90/1/item.json new file mode 100644 index 0000000..ff735f5 --- /dev/null +++ b/sample_server/ShakespearesWorks/Othello/page90/1/item.json @@ -0,0 +1,38 @@ +{ + "textapi": "1.0.0", + "title": [ + { + "title": "A Sample Item", + "type": "main" + }, + { + "title": "A Subtitle", + "type": "sub" + } + ], + "type": "section", + "n": "one", + "lang": [ + "fre", "aci" + ], + "langAlt": ["karshuni"], + "content": [ + { + "type": "text/html", + "url": "https://example.com/html-serialization-one.html" + }, + { + "type": "text/xml", + "url": "https://example.com/xml-serialization-two.xml" + } + ], + "description": "This is Section one of the Sample Manifest", + "image": { + "id": "https://example.com/image.png", + "license": { + "id": "CC-BY-4.0" + } + }, + "annotationCollection": "https://example.com/one/annotationCollection.json" + } + \ No newline at end of file diff --git a/sample_server/ShakespearesWorks/Othello/page90/fb406b265a779b43afa635bc8da79d81/item.json b/sample_server/ShakespearesWorks/Othello/page90/fb406b265a779b43afa635bc8da79d81/item.json new file mode 100644 index 0000000..ff735f5 --- /dev/null +++ b/sample_server/ShakespearesWorks/Othello/page90/fb406b265a779b43afa635bc8da79d81/item.json @@ -0,0 +1,38 @@ +{ + "textapi": "1.0.0", + "title": [ + { + "title": "A Sample Item", + "type": "main" + }, + { + "title": "A Subtitle", + "type": "sub" + } + ], + "type": "section", + "n": "one", + "lang": [ + "fre", "aci" + ], + "langAlt": ["karshuni"], + "content": [ + { + "type": "text/html", + "url": "https://example.com/html-serialization-one.html" + }, + { + "type": "text/xml", + "url": "https://example.com/xml-serialization-two.xml" + } + ], + "description": "This is Section one of the Sample Manifest", + "image": { + "id": "https://example.com/image.png", + "license": { + "id": "CC-BY-4.0" + } + }, + "annotationCollection": "https://example.com/one/annotationCollection.json" + } + \ No newline at end of file diff --git a/sample_server/ShakespearesWorks/collection.json b/sample_server/ShakespearesWorks/collection.json new file mode 100644 index 0000000..464e2ba --- /dev/null +++ b/sample_server/ShakespearesWorks/collection.json @@ -0,0 +1,30 @@ +{ + "textapi": "1.0.0", + "title": [ + { + "title": "Shakespeares Works", + "type": "main" + } + ], + "collector": [ + { + "name": "Hans Wurst", + "role": [ + "collector" + ] + } + ], + "description": "This is the sample collection.", + "sequence": [ + { + "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/ShakespearesWorks/Othello/manifest.json", + "type": "manifest" + }, + { + "id": "https://subugoe.pages.gwdg.de/emo/text-api/sample_server/ShakespearesWorks/12a34b/manifest.json", + "type": "manifest" + } + ], + "annotationCollection": "https://example.com/annotationCollection.json" + } + \ No newline at end of file -- GitLab From 98a048395608493134c17c7bb3c40e6cbcfb39c3 Mon Sep 17 00:00:00 2001 From: Michelle Weidling Date: Tue, 5 Apr 2022 08:53:24 +0200 Subject: [PATCH 17/17] docs: add missing examples --- openapi_3.0.2_specification.yml | 42 +++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/openapi_3.0.2_specification.yml b/openapi_3.0.2_specification.yml index 29e1aa7..9104930 100644 --- a/openapi_3.0.2_specification.yml +++ b/openapi_3.0.2_specification.yml @@ -56,6 +56,13 @@ paths: description: The identifier of the collection schema: {$ref: '#/components/schemas/Collection'} required: true + examples: + semanticID: + summary: An identifier that has a meaning for humans + value: "ShakespearesWorks" + ID: + summary: An identifier with no special meaning for humans + value: "12a34b" - name: manifest in: path description: The identifier of the manifest @@ -90,11 +97,25 @@ paths: description: The identifier of the collection schema: {$ref: '#/components/schemas/Collection'} required: true + examples: + semanticID: + summary: An identifier that has a meaning for humans + value: "ShakespearesWorks" + ID: + summary: An identifier with no special meaning for humans + value: "12a34b" - name: manifest in: path description: The identifier of the manifest schema: {$ref: '#/components/schemas/Manifest'} required: true + examples: + semanticID: + summary: An identifier that has a meaning for humans + value: "Othello" + ID: + summary: An identifier with no special meaning for humans + value: "12a34b" - name: item in: path description: The identifier of the item @@ -141,11 +162,25 @@ paths: description: The identifier of the collection schema: {$ref: '#/components/schemas/Collection'} required: true + examples: + semanticID: + summary: An identifier that has a meaning for humans + value: "ShakespearesWorks" + ID: + summary: An identifier with no special meaning for humans + value: "12a34b" - name: manifest in: path description: The identifier of the manifest schema: {$ref: '#/components/schemas/Manifest'} required: true + examples: + semanticID: + summary: An identifier that has a meaning for humans + value: "Othello" + ID: + summary: An identifier with no special meaning for humans + value: "12a34b" - name: item in: path description: The identifier of the item @@ -156,6 +191,13 @@ paths: description: The revision of the item to be delivered. schema: {$ref: '#/components/schemas/Revision'} required: true + examples: + semanticID: + summary: A revision that has a meaning for humans + value: "1" + ID: + summary: A revision with no special meaning for humans + value: "fb406b265a779b43afa635bc8da79d81" responses: '200': description: OK -- GitLab