Skip to content

Commit

Permalink
Improve meta-schema consistency
Browse files Browse the repository at this point in the history
  • Loading branch information
rartino committed Mar 21, 2024
1 parent 48ec3b8 commit c095ccc
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion schemas/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The following makefile target processes all Property Definitions (and other sche
```
make schemas
```
This command also generates documentation in markdown and HTML meant to be keept alongside the JSON definition files.
This command also generates documentation in markdown and HTML meant to be kept alongside the JSON definition files.
Once the generation is complete, the property definitions are found under `schemas/output/defs/` using the same directory structure as under `schemas/src`.

You can browse the definitions by starting a browser with the generated index page, e.g.:
Expand Down
10 changes: 5 additions & 5 deletions schemas/src/meta/v1.2/optimade/property_definition.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ $defs:
- "iri": a string instance is valid against this attribute if it is a valid IRI according to RFC 3987.
type: "string"
enum: ["date-time", "date", "time", "duration", "email", "uri", "iri"]
$id:
"$id":
allOf:
- $ref: '#/$defs/id_field'
- description: |-
Expand All @@ -238,7 +238,7 @@ $defs:
- The inclusion or omission of "null" in the type in the outermost layer of the definition.
- Additions of annotating notes to end of the description field.
- Changes to the following specific fields at any level: deprecated, examples, $comment, x-optimade-implementation, and x-optimade-requirements.
$schema:
"$schema":
description: |-
A normalized URI for a meta-schema that validates the Property Definition.
This SHOULD be https://schemas.optimade.org/meta/{OPTIMADE_VERSION}/optimade/physical_unit_definition.json
Expand Down Expand Up @@ -344,7 +344,7 @@ $defs:
- "no"
sortable:
type: boolean
$comment:
"$comment":
type: string
type: object
x-optimade-requirements:
Expand Down Expand Up @@ -396,7 +396,7 @@ $defs:
- should
- may
type: string
$comment:
"$comment":
type: string
type: object
x-optimade-metadata-definition:
Expand All @@ -408,7 +408,7 @@ $defs:
type:
enum:
- ["object", "null"]
$comment:
"$comment":
description: |-
A human-readable comment relevant in the context of the raw definition data.
These comments should normally not be shown to the end users.
Expand Down
6 changes: 3 additions & 3 deletions schemas/src/meta/v1.2/optimade/unit_entity_definition.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ $defs:
patternProperties:
"^_": {}
properties:
$id:
"$id":
allOf:
- $ref: "#/$defs/id_field"
- description: |-
Expand All @@ -33,9 +33,9 @@ $defs:
- Changes to the fields `deprecated` and `$comment` on any level.
Note that this means that the version number part of the URL is *retained* even in newer releases of the OPTIMADE standard as long as the definition remains functionally identical.
$comment:
"$comment":
type: string
$schema:
"$schema":
description: |-
A normalized URI for a meta-schema that validates the definition.
approximate-relations:
Expand Down

0 comments on commit c095ccc

Please sign in to comment.