Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

All changes that impact users of this module are documented in this file, in the [Common Changelog](https://common-changelog.org) format with some additional specifications defined in the CONTRIBUTING file. This codebase adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Unreleased [patch]

> Development of this release was supported by the [French Ministry for Foreign Affairs](https://www.diplomatie.gouv.fr/fr/politique-etrangere-de-la-france/diplomatie-numerique/) through its ministerial [State Startups incubator](https://beta.gouv.fr/startups/open-terms-archive.html) under the aegis of the Ambassador for Digital Affairs.

### Fixed

- Fix documentation of collection metadata in the collection API

## 4.0.0 - 2024-12-04

_Full changeset and discussions: [#1123](https://github.com/OpenTermsArchive/engine/pull/1123)._
Expand All @@ -10,7 +18,7 @@ _Full changeset and discussions: [#1123](https://github.com/OpenTermsArchive/eng

### Added

- Expose collection metadata through the collection API; requires a [metadata file](https://docs.opentermsarchive.org/collections/metadata/) at the root of your collection folder
- **Breaking:** Expose collection metadata through the collection API; ensure to add the required [metadata file](https://docs.opentermsarchive.org/collections/metadata/) at the root of your collection folder

### Changed

Expand Down
56 changes: 21 additions & 35 deletions src/collection-api/routes/metadata.js
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,10 @@ const PACKAGE_JSON_PATH = '../../../package.json';
* type: string
* format: uri
* description: URL to the snapshots repository
* donations:
* type: string
* format: uri
* description: URL to the donations page
* logo:
* type: string
* format: uri
Expand Down Expand Up @@ -94,41 +98,23 @@ const PACKAGE_JSON_PATH = '../../../package.json';
* description: The date when tracking ended for this period
* governance:
* type: object
* properties:
* hosts:
* type: array
* items:
* $ref: '#/components/schemas/Organization'
* administrators:
* type: array
* items:
* $ref: '#/components/schemas/Organization'
* curators:
* type: array
* items:
* $ref: '#/components/schemas/Organization'
* maintainers:
* type: array
* items:
* $ref: '#/components/schemas/Organization'
* sponsors:
* type: array
* items:
* $ref: '#/components/schemas/Organization'
* Organization:
* type: object
* properties:
* name:
* type: string
* description: Name of the organization
* url:
* type: string
* format: uri
* description: URL to the organization's website
* logo:
* type: string
* format: uri
* description: URL to the organization's logo
* additionalProperties:
* type: object
* properties:
* url:
* type: string
* format: uri
* description: URL to the entity's website
* logo:
* type: string
* format: uri
* description: URL to the entity's logo
* roles:
* type: array
* items:
* type: string
* enum: [host, administrator, curator, maintainer, sponsor]
* description: Roles of the entity within the governance
*/
export default async function metadataRouter(collectionPath, services) {
const router = express.Router();
Expand Down
Loading