Skip to content

Commit d1a63ea

Browse files
committed
Update Metadata specs
1 parent c9ffdeb commit d1a63ea

File tree

1 file changed

+22
-17
lines changed

1 file changed

+22
-17
lines changed

src/collection-api/routes/metadata.js

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,15 @@ const PACKAGE_JSON_PATH = '../../../package.json';
3030
* id:
3131
* type: string
3232
* description: Unique identifier derived from name (acronyms, dash-separated).
33-
* example: pga
33+
* example: demo
3434
* name:
3535
* type: string
3636
* description: Display name of the collection.
37-
* example: Platform Governance Archive
37+
* example: Demo Collection
3838
* tagline:
3939
* type: string
4040
* description: Concise description of collection topic.
41-
* example: Major global social media services
41+
* example: Services used by Open Terms Archive
4242
* languages:
4343
* type: array
4444
* description: List of [ISO 639-1 (two-letter)](https://en.wikipedia.org/wiki/ISO_639) language codes representing languages allowed in the collection.
@@ -57,13 +57,9 @@ const PACKAGE_JSON_PATH = '../../../package.json';
5757
* type: string
5858
* description: Detailed description of the collection
5959
* example: |
60-
* The **Platform Governance Archive** (PGA) collection tracks the terms of major global social media services.
60+
* The **Demo** collection tracks changes to the terms of use of services used by Open Terms Archive.
6161
*
62-
* This data is maintained and analysed by the [Platform Governance Archive](https://www.platformgovernancearchive.org/) at the Universität Bremen's [Center for Media Communication and Information Research (ZeMKI)](https://www.uni-bremen.de/zemki).
63-
*
64-
* This initiative offers researchers, journalists and citizens the tools to analyze how platforms structure and regulate communication and interaction in our societies.
65-
*
66-
* It also aims to promote greater transparency and accountability of these powerful digital services.
62+
* This provides a reference collection for best practices and enables the Open Terms Archive Core Team to be a user of the software it produces.
6763
* totalTerms:
6864
* type: integer
6965
* description: Total number of terms tracked in the collection.
@@ -80,22 +76,22 @@ const PACKAGE_JSON_PATH = '../../../package.json';
8076
* type: string
8177
* format: uri
8278
* description: URL to the dataset releases.
83-
* example: https://github.com/OpenTermsArchive/pga-versions/releases
79+
* example: https://github.com/OpenTermsArchive/demo-versions/releases
8480
* declarations:
8581
* type: string
8682
* format: uri
8783
* description: URL to the declarations repository.
88-
* example: https://github.com/OpenTermsArchive/pga-declarations
84+
* example: https://github.com/OpenTermsArchive/demo-declarations
8985
* versions:
9086
* type: string
9187
* format: uri
9288
* description: URL to the versions repository.
93-
* example: https://github.com/OpenTermsArchive/pga-versions
89+
* example: https://github.com/OpenTermsArchive/demo-versions
9490
* snapshots:
9591
* type: string
9692
* format: uri
9793
* description: URL to the snapshots repository.
98-
* example: https://github.com/OpenTermsArchive/pga-snapshots
94+
* example: https://github.com/OpenTermsArchive/demo-snapshots
9995
* donations:
10096
* type: string
10197
* format: uri
@@ -104,7 +100,8 @@ const PACKAGE_JSON_PATH = '../../../package.json';
104100
* logo:
105101
* type: string
106102
* format: uri
107-
* description: URL to the collection's logo. Optimized PNG transparent image (min width 240px).
103+
* description: URL to the collection's logo. Optimized PNG transparent image (minimum width 240px).
104+
* example: https://opentermsarchive.org/images/logo/logo-open-terms-archive-black.png
108105
* trackingPeriods:
109106
* type: array
110107
* items:
@@ -127,8 +124,8 @@ const PACKAGE_JSON_PATH = '../../../package.json';
127124
* example: 0 0 * * *
128125
* serverLocation:
129126
* type: string
130-
* description: The geographic location of the tracking server (city name, ISO 3166-2 country code).
131-
* example: London, GB
127+
* description: The geographic location of the tracking server (city name and ISO 3166-2 country code).
128+
* example: Paris, FR
132129
* endDate:
133130
* type: string
134131
* format: date
@@ -151,7 +148,7 @@ const PACKAGE_JSON_PATH = '../../../package.json';
151148
* logo:
152149
* type: string
153150
* format: uri
154-
* description: URL to the entity's logo. Optimized PNG transparent image (min width 240px).
151+
* description: URL to the entity's logo. Optimized PNG transparent image (minimum width 240px).
155152
* example: https://opentermsarchive.org/images/logo/logo-open-terms-archive-black.png
156153
* roles:
157154
* type: array
@@ -163,6 +160,14 @@ const PACKAGE_JSON_PATH = '../../../package.json';
163160
* i18n:
164161
* type: object
165162
* description: Internationalization of any of the Metadata properties (except i18n itself) for different language codes
163+
* example: |
164+
* fr:
165+
* name: Démo
166+
* tagline: Services utilisés par Open Terms Archive
167+
* governance:
168+
* Ministry for Europe and Foreign Affairs:
169+
* name: Ministère de l'Europe et des Affaires étrangères
170+
* url: https://www.diplomatie.gouv.fr
166171
* additionalProperties:
167172
* type: object
168173
*/

0 commit comments

Comments
 (0)