| 1 |
$schema: "https://json-schema.org/draft/2020-12/schema" |
| 2 |
$id: "https://schemas.optimade.org/meta/v1.2/optimade/x-optimade-definition-field" |
| 3 |
type: object |
| 4 |
required: ["kind", "format", "name", "label"] |
| 5 |
properties: |
| 6 |
label: |
| 7 |
type: string |
| 8 |
description: |- |
| 9 |
An expanded version of the name that clarifies its context sufficiently to be unique within definitions issued together as a set. |
| 10 |
pattern: ^[a-z_][a-z_0-9]*$ |
| 11 |
name: |
| 12 |
type: string |
| 13 |
description: |- |
| 14 |
Gives the definition a short name. |
| 15 |
pattern: ^[a-z_][a-z_0-9]*$ |
| 16 |
kind: |
| 17 |
type: string |
| 18 |
description: |- |
| 19 |
Specifies the kind of Property Definition. |
| 20 |
enum: ["property", "unit", "constant", "prefix", "entrytype", "unitsystem", "standard"] |
| 21 |
format: |
| 22 |
description: |- |
| 23 |
Specifies the minor version of the Property Definitions format that the definition is expressed in. |
| 24 |
This field MUST be included in standalone definitions, i.e., when they are not embedded inside other definitions or contexts that already declares a Property Definitions format. |
| 25 |
pattern: ^[0-9]+\.[0-9]+$ |
| 26 |
version: |
| 27 |
description: |- |
| 28 |
The version string of the referenced standard. |
| 29 |
The string SHOULD be in the format described by the [semantic versioning v2](https://semver.org/spec/v2.0.0.html) standard. |
| 30 |
pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$ |
| 31 |
$comment: "This pattern is the suggested regular expression from: https://semver.org/spec/v2.0.0.html" |
| 32 |
type: string |
| 33 |
resources: |
| 34 |
$$inherit: "/v1.2/common/resource_list" |
| 35 |
patternProperties: |
| 36 |
"^x-(?!optimade-)": {} |
| 37 |
additionalProperties: false |