Directory Entry
Purpose
A directory is a predefined list of permitted values used in Dateno to describe standardized attributes of datasets and catalogs. Directories ensure consistent categorization and enable accurate filtering and search across large collections of metadata.
Directories are used wherever values must be selected from a fixed set—such as countries, languages, data formats, catalog types, or topics. This approach guarantees uniformity in metadata and prevents issues caused by typos, ambiguity, or inconsistent naming.
Each value in a directory is called a directory entry.
A directory entry is a structured object that represents one item in a directory. It provides both a persistent identifier and a human-readable label for the value.
Directories are essential in:
- Metadata records in dataset descriptors and dataset cards
- Facets in the web interface
- Filters in API queries
Structure
Each directory entry is a JSON object that contains the following required properties.
Property | Description |
---|---|
id | Stable identifier for internal processing and filtering (e.g., "FR" for France) |
name | Human-readable label for display in the user interface (e.g., "France" ) |
The property names id
and name
are typical, but in some directories alternative names such as code
or title
may be used. Some directories may also include additional properties relevant to the domain, such as region codes, MIME types, or software identifiers.
Localization Note
While the id
remains fixed regardless of interface language, the name
may vary depending on localization settings. For example, the country "FR"
can be labeled as "Ֆրանսիա"
when the UI language is Armenian. Currently, only English is supported in Dateno, but additional languages may be added in the future.
Examples
/* Directory entry in the countries array */
"countries": [
{
"id": "CA",
"name": "Canada"
}
]
/* Directory entry in the langs array */
"langs": [
{
"id": "FR",
"name": "French"
}
]