| 1 |
$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" |
| 2 |
$id: "https://schemas.optimade.org/defs/v1.2/properties/core/id" |
| 3 |
title: "ID" |
| 4 |
x-optimade-type: "string" |
| 5 |
x-optimade-definition: |
| 6 |
label: "id_core" |
| 7 |
kind: "property" |
| 8 |
version: "1.2.0" |
| 9 |
format: "1.2" |
| 10 |
name: "id" |
| 11 |
type: |
| 12 |
- "string" |
| 13 |
description: |- |
| 14 |
A unique string referencing a specific entry in the database. |
| 15 |
|
| 16 |
**Requirements/Conventions:** |
| 17 |
|
| 18 |
- Taken together, the ID and entry type MUST uniquely identify the entry. |
| 19 |
- Reasonably short IDs are encouraged and SHOULD NOT be longer than 255 characters. |
| 20 |
- IDs MAY change over time. |
| 21 |
examples: |
| 22 |
- "db/1234567" |
| 23 |
- "cod/2000000" |
| 24 |
- "cod/2000000@1234567" |
| 25 |
- "nomad/L1234567890" |
| 26 |
- "42" |
| 27 |
x-optimade-unit: "inapplicable" |