Skip to content

Commit 31c9526

Browse files
committed
Update Metadata specs
1 parent d1a63ea commit 31c9526

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

src/collection-api/routes/metadata.js

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ const PACKAGE_JSON_PATH = '../../../package.json';
3838
* tagline:
3939
* type: string
4040
* description: Concise description of collection topic.
41-
* example: Services used by Open Terms Archive
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,9 +57,9 @@ const PACKAGE_JSON_PATH = '../../../package.json';
5757
* type: string
5858
* description: Detailed description of the collection
5959
* example: |
60-
* The **Demo** collection tracks changes to the terms of use of services used by Open Terms Archive.
60+
* The **Demo** collection tracks changes to the terms of use of services used by Open Terms Archive.
6161
*
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.
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.
6363
* totalTerms:
6464
* type: integer
6565
* description: Total number of terms tracked in the collection.
@@ -104,6 +104,7 @@ const PACKAGE_JSON_PATH = '../../../package.json';
104104
* example: https://opentermsarchive.org/images/logo/logo-open-terms-archive-black.png
105105
* trackingPeriods:
106106
* type: array
107+
* description: List of time periods during which terms were tracked, with their tracking configuration. Gaps between periods indicate times when tracking was interrupted.
107108
* items:
108109
* type: object
109110
* additionalProperties: false
@@ -133,7 +134,7 @@ const PACKAGE_JSON_PATH = '../../../package.json';
133134
* example: 2023-12-01
134135
* governance:
135136
* type: object
136-
* description: Map of organizations involved in the collection's governance, with organization names as keys
137+
* description: Map of organizations involved in the collection's governance, with organization names as keys and governance objects as values.
137138
* additionalProperties:
138139
* type: object
139140
* additionalProperties: false

0 commit comments

Comments
 (0)