Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add machine-readable property definitions to repository #445

Merged
merged 239 commits into from
Mar 22, 2024
Merged
Changes from 1 commit
Commits
Show all changes
239 commits
Select commit Hold shift + click to select a range
644c836
Start adding property definitions
rartino Dec 22, 2022
86c7936
Minor language fixes from review
rartino Jan 11, 2023
3a557b6
Merge branch 'develop' into add-property-definitons-3
rartino Jan 11, 2023
f37a1ff
Add property definitions processing script
rartino Feb 20, 2023
896cffc
Improve process_propdefs.py script
rartino Feb 20, 2023
9a5b506
Improve process_propdefs.py
rartino Feb 21, 2023
99bed0f
Merge branch 'develop' into add-property-definitons-3
rartino Feb 21, 2023
270b0bf
Prepare to separate input and output property definition files
rartino Feb 21, 2023
d1250bb
Handle paths better in process_propdefs.py
rartino Feb 21, 2023
70e4293
Fix issues with process_propdefs.py and a bug in properties/structure…
rartino Feb 21, 2023
b7a4a70
Make process_propdefs output rst
rartino Feb 21, 2023
edfaee8
Improve rst output of process_propdefs + added/improved property defi…
rartino Feb 23, 2023
2a3fa2c
Allow processing of whole dirs in process_propdefs.py
rartino Feb 25, 2023
0f3b3dd
Clean up logging/debugging in process_propdefs.py
rartino Feb 26, 2023
ecdbb3f
Restructure properties directory structure
rartino Feb 26, 2023
d42ae0c
Rework of property generation paths, etc.
rartino Feb 27, 2023
5783984
Property definitions restructuring
rartino Feb 27, 2023
4412e46
Property definitions restructuring
rartino Feb 27, 2023
928429c
Property definitions now handle placeholder {OPTIMADE_VERSION}
rartino Feb 27, 2023
73ea1f5
Adjustments to property definitions
rartino Feb 27, 2023
a914e15
Fix spelling error
rartino Feb 27, 2023
e9c11b7
Further adjustments to the property definition text
rartino Feb 27, 2023
2cfd324
Further adjustments to the property definition text
rartino Feb 27, 2023
9f9027c
Possible controversial change of forcing type in property definitions…
rartino Feb 27, 2023
980ec63
Apply suggestions from review
rartino Feb 27, 2023
88d391f
Correct minor grammar error from review
rartino Feb 28, 2023
422fee7
Add internal hyperlinks to be helpful in property definition cross-re…
rartino Feb 28, 2023
2d12f19
Add support for x-propdefs-inherit-ref in process_propdefs.py
rartino Feb 28, 2023
3fe0d05
Handle property version symlinks better
rartino Feb 28, 2023
d3a04f3
Restructuring; adding definitions of units under properties
rartino Feb 28, 2023
65f457b
Update angstrom unit
rartino Mar 1, 2023
b2c405f
Add meter definition
rartino Mar 1, 2023
93f783d
Improved categorization of units
rartino Mar 1, 2023
175fd20
More properties in property definitions
rartino Mar 1, 2023
1fe5711
Correct capitalization of ångström unit when written out
rartino Mar 1, 2023
bc89ad7
Apply suggestions from review
rartino Mar 1, 2023
e022a82
Prepare for freestanding Unit Definitions
rartino Mar 1, 2023
7311537
Improvement of Physical Unit Definitions
rartino Mar 2, 2023
03b8d66
Formatting fixes
rartino Mar 2, 2023
0a57fa0
Formatting fixes for math expression in Physical Unit Definitions
rartino Mar 2, 2023
d6ca26a
Slight adjustment of formulation for Unit Definitions
rartino Mar 2, 2023
39d1283
Clarify example defining relation formula
rartino Mar 2, 2023
823747c
Clarify not to use defining relation for unit definitions if the rela…
rartino Mar 2, 2023
71e08bc
Apply suggestions from review
rartino Mar 2, 2023
f2c29e3
Fix defining relation formula in Physical Unit Definitions
rartino Mar 2, 2023
b477cb3
Fix Physial Unit Definitions ambiguity on optimal fields, add Propert…
rartino Mar 2, 2023
f7f0f0e
Apply suggestions from review
rartino Mar 2, 2023
790cf25
Update based on review
rartino Mar 2, 2023
1643e67
Add field approximate-relations to unit definitions
rartino Mar 8, 2023
0429a81
Many defined units
rartino Mar 9, 2023
dc04d18
Unit definitions fixes
rartino Mar 9, 2023
52f7950
Reorganize property definition schema files
rartino Mar 9, 2023
c533517
Fix for Makelocals-schemas
rartino Mar 9, 2023
1adfbfb
Add new elements to chemical_symbol property definition
rartino Mar 9, 2023
f5a55b6
Add new elements everwhere relevant in property definitions
rartino Mar 9, 2023
2fb96c3
Fix failing trailing whitespace check
rartino Mar 9, 2023
ddd4c67
Step towards schema generation by grouping property definitions in st…
rartino Mar 10, 2023
9bf9885
Add some files property definitions
rartino Mar 10, 2023
560a0eb
Further adjust equality of property definitions
rartino Mar 13, 2023
5075796
Update references to URIs to IRIs and replace references in field nam…
rartino Mar 13, 2023
aa8bcd7
Fix formatting error
rartino Mar 16, 2023
1f766ef
Prepare property definitions for json-ld contexts
rartino Mar 16, 2023
9401ce4
Build complete schemas from property definitions
rartino Mar 16, 2023
2a66036
Allow annotations to the end of description; reorganize for less repe…
rartino Mar 17, 2023
b7aee26
Reorganize schemas
rartino Mar 17, 2023
7933505
Add a way in property definitions to express that some fields, e.g., …
rartino Mar 17, 2023
5a0fb74
Property definitions reorganize and update process script to be more …
rartino Mar 17, 2023
450b610
Fix issues with the json-ld schemas
rartino Mar 17, 2023
f9f3df0
Fix incorrect response-default-level in property definition
rartino Mar 18, 2023
8222c8e
Improve organization of external standards
rartino Mar 18, 2023
3aad5d6
Fix symlink to jsonapi schema in property definitions
rartino Mar 18, 2023
6598a52
Validate property definitions against meta schemas
rartino Mar 19, 2023
9c9ac03
Add alternate-symbols to Physical Unit Definitions
rartino Mar 19, 2023
1f3ae2d
Change unit definitions so the way we reference the standard from sch…
rartino Mar 19, 2023
e306ea3
Add fields to Property and Unit definitions, and REQUIRE it and for…
rartino Mar 19, 2023
737cfc2
Apply suggestions from review
rartino Mar 19, 2023
f2c8390
Further adjustment based on review comments
rartino Mar 19, 2023
cef9298
Reorder, clarify, and simplify meta-schema for Property Definitions a…
rartino Mar 19, 2023
196d572
Reorganize units schemas, improve validation
rartino Mar 20, 2023
08f0a1b
Adjust REQUIRED status to OPTIONAL on some fields in Unit Definitions
rartino Mar 20, 2023
47f7620
Refine compound unit expression definition
rartino Mar 20, 2023
d62e07f
Unit definitions: reorganize and add older SI units
rartino Mar 21, 2023
8ba9faa
Further Unit Definition updates
rartino Mar 21, 2023
dc5665d
Property definitions: revert parts of the unit prefix text and allow …
rartino Mar 22, 2023
9a66c5c
Property definitions: revert parts of the unit prefix text and allow …
rartino Mar 22, 2023
127bfd7
Reorganization - add implementation example
rartino Mar 23, 2023
a405f65
Reorganizing property definitions
rartino Mar 23, 2023
383ed1d
Outputformat-agnostic schema notation in property definitions
rartino Mar 23, 2023
ac34e91
Allow multiple inheritance in process_schemas preprocessor
rartino Mar 24, 2023
1febe01
Improve schema handling for property definitions; correct schema bugs
rartino Mar 25, 2023
ae86899
Generate documentation pages for property definitions
rartino Mar 26, 2023
21414d0
Improve example schema generation
rartino Mar 26, 2023
29f12e7
Property definitions index pages
rartino Mar 26, 2023
960eb04
Fix math in second unit
rartino Mar 26, 2023
50cbd41
Fix math in mol unit
rartino Mar 26, 2023
89a925d
Fix bug in process_schemas.py merge_deep
rartino Mar 27, 2023
771a0e1
Clean up unit and property definitions
rartino Mar 27, 2023
4f11f31
Regorganization, introducing unitsets for property definitions
rartino Mar 28, 2023
68a292e
More formalized definitions of units
rartino Apr 1, 2023
fa1e691
Further work on units
rartino Apr 1, 2023
57f353a
Further updates to unit definitions
rartino Apr 3, 2023
5aac3c0
Add binary prefixes, reorganize prefixes
rartino Apr 3, 2023
3d1652a
Add older Si unit systems
rartino Apr 4, 2023
206e78a
Improve html output of property definitions
rartino Apr 5, 2023
6e5605c
Prepare placeholders for non-SI units defined by SI
rartino Apr 10, 2023
5ace2bf
Adjust electronvolt definition
rartino Apr 28, 2023
3685958
Add generalized SI unit definitions
rartino Apr 30, 2023
199cc79
Improve 1960 SI unit descriptions
rartino May 3, 2023
2b2354f
Improve 1960 1967 SI unit definitions
rartino May 3, 2023
b9851bf
Change generalizes-unit to compatibility in unit definitions
rartino May 4, 2023
5ba16e8
Cleanup of 1967 SI unit definitions
rartino May 4, 2023
384914b
Updates to 1970 SI units
rartino May 4, 2023
4ab7260
Fix exponential notation in units to validate
rartino May 8, 2023
950e23a
Add Bohr magneton unit
May 9, 2023
7a76610
Merge pull request #2 from lkasillas/add-property-definitons-3
rartino May 14, 2023
9255795
Minor fixes to unit definitions
rartino May 15, 2023
2ec06f0
Improve 1970 SI unit descriptions
rartino May 15, 2023
e558442
Improve 1970 SI unit definitions
rartino May 15, 2023
6b46ede
Work on SI cgs definitions
rartino May 15, 2023
ba64444
Improve unit definitions, remove non-si units under si directory
rartino Jun 1, 2023
2d6717b
Further cleanup of unit defnitions
rartino Jun 2, 2023
487f0f3
Update of SI unit definition, now done up to 2019
rartino Jun 3, 2023
e3f4271
Update si/general unit definitions
rartino Jun 3, 2023
c6764ac
Update unit systems, fix minor bugs in unit definitions
rartino Jun 3, 2023
e497ec5
Add references property definitions
rartino Jun 3, 2023
118705c
Fix pre-commit-config to avoid trailing whitespace check for GNU Unit…
rartino Jun 5, 2023
3f63386
Fix audit_schemas dependencies for ci
rartino Jun 5, 2023
72a0f1e
Fix audit_schemas dependencies for ci
rartino Jun 5, 2023
b635722
Fix audit_schemas dependencies for ci
rartino Jun 5, 2023
30afa59
Fix unitsystem definitions; add html extension output
rartino Jun 5, 2023
3e87f36
Adjust property definitions html generation
rartino Jun 5, 2023
6a6c141
Fix incorrect property definition ids
rartino Jun 5, 2023
a960da7
Fix incorrect years in SI unit system definitions
rartino Jun 7, 2023
3a509e6
Make schemas_web makes nicely css:ed html files for schema.optimade.org
rartino Jun 9, 2023
0e14e29
Merge branch 'add-property-definitons-3' of https://github.com/rartin…
oke464 Jun 28, 2023
4428d82
Fix systemic spelling error in unit definitions
rartino Jun 30, 2023
5214ac1
Improve handling of schema html file variants and preserve order in p…
rartino Jul 3, 2023
7881d0a
Property definitions add sanity check [WIP]
rartino Jul 3, 2023
c4d9465
Property definitions complete sanity check
rartino Jul 4, 2023
2b9bacd
Move out property definitions example to own directory
rartino Jul 4, 2023
0999b4a
Merge branch 'add-property-definitons-3' of https://github.com/rartin…
oke464 Jul 4, 2023
b9edfbf
Improve html representation of example property definitions
rartino Jul 4, 2023
d51d976
Property definitions: fix example
rartino Jul 4, 2023
312caa6
Reorganize and update doumentation of property definitions
rartino Jul 4, 2023
05afa16
Property definitions change versioning to match README text
rartino Jul 4, 2023
3f36937
Property definitions add lost prefix definitions
rartino Jul 4, 2023
a6b5bb3
Reorganization of property definitions for saner versions handling
rartino Jul 5, 2023
82dfdf5
Further reorganization to handle versions properly
rartino Jul 6, 2023
48a3a42
Property definitions adjustments for unit systems; update README
rartino Jul 6, 2023
f1425e5
Fix bohr magneton constant display-symbol
rartino Jul 6, 2023
062f86d
Improve sanity check, fix found errors, update README
rartino Jul 7, 2023
c3a594c
Merge branch 'add-property-definitons-3' of https://github.com/rartin…
oke464 Jul 7, 2023
19bcccb
Final fixes of property definitions
rartino Jul 7, 2023
fcae20d
Merge branch 'add-property-definitons-3' of https://github.com/rartin…
oke464 Jul 13, 2023
5c8d6fc
Apply suggestions from review
rartino Jul 14, 2023
e6d40ac
Merge upstream develop
rartino Jul 14, 2023
23320ab
Updated ID links in the data schemas from defining-relation, approxim…
oke464 Nov 30, 2023
416c3a5
Merge branch 'develop' into add-property-definitons-3
rartino Dec 1, 2023
d887361
Merge id fixes from oke464/add-property-definitons-3
rartino Dec 1, 2023
b7529d6
WIP: Fix incorrect ids, add sanity check in tool to detect them
rartino Dec 1, 2023
cd54355
Fix electronvolt relation to other units to be approximate relations
rartino Dec 3, 2023
2b6fa47
Fix indentation error for two electronvolt entries
rartino Dec 11, 2023
ab1445d
Fix long symbols that should be short
rartino Dec 11, 2023
424efb0
Create unit_entity_definition meta-schema and let all unit-related sc…
rartino Dec 11, 2023
e8c705d
Add missing AdditionalProperties: false in meta-schemas
rartino Dec 11, 2023
632a316
Fix misspelled fields from review
rartino Dec 11, 2023
0a591a2
Fix misspelled fields from review
rartino Dec 11, 2023
08b18f6
Fix misspelled fields from review
rartino Dec 11, 2023
2e4fe46
Fix remaining issues showing up with improved metaschema validation
rartino Dec 11, 2023
d8e5cb7
Adjust fields for the standards part of unit definitions
rartino Dec 12, 2023
c44e56d
Merge branch 'develop' into add-property-definitons-3
rartino Dec 20, 2023
dc8baed
Add required label field to x-optimade-definition, add 'standard' to …
rartino Dec 20, 2023
d653684
Merge branch 'develop' into update_to_property_defs_2
rartino Dec 22, 2023
40526eb
Further updates to match latest property definitions; be less stringe…
rartino Dec 23, 2023
46f4e0b
Add space_group_symmetry_operations_xyz and sub-definition
ml-evs Dec 23, 2023
1bacff5
Remove pattern for space_group_symmetry_operations_xyz
ml-evs Jan 4, 2024
3e44ec7
Merge branch 'develop' into add-property-definitons-3
rartino Jan 5, 2024
1ade132
Merge pull request #4 from ml-evs/add-property-definitons-3
rartino Jan 5, 2024
01564aa
Merge branch 'develop' into update_to_property_defs_2
rartino Jan 5, 2024
cf9e468
Add pattern to string validation
rartino Jan 5, 2024
48d7bde
Merge matching changes to OPTIMADE specification into this PR
rartino Jan 5, 2024
37339aa
Merge matching changes to OPTIMADE specification into this PR
rartino Jan 5, 2024
bad70b8
Make space_group_symmetry_operation_xyz validate
rartino Jan 6, 2024
413166a
Fix remaining properties for current status of symmetry info for stru…
rartino Jan 6, 2024
dac6609
Move process_schemas to external repo, added as a submodule
rartino Jan 8, 2024
85a0cd1
Fix ci to properly init submodules
rartino Jan 8, 2024
e5300ce
Remove example files duplicated in optimade-property-tools and adjust…
rartino Jan 8, 2024
c85977d
Update optimade-property-tools dependency to fix bug
rartino Jan 8, 2024
610aa94
Minor fix in optimade-property-tools
rartino Jan 8, 2024
3c7f67e
Fix minor markdown formatting issues of symmetry properties
rartino Jan 8, 2024
3d4871a
Abstract resource and symbol list meta schemas to be able to reuse them
rartino Jan 8, 2024
914a1ec
Update optimade-property-tools dependency
rartino Jan 8, 2024
5a601ab
Add optimade-metadata-defintion according to specification and improv…
rartino Jan 8, 2024
43e0df9
Fix errors via review
rartino Jan 8, 2024
9736843
Minor fixes to property definitions, schemas README, and adjust param…
rartino Jan 9, 2024
5be33c3
Add non-SI binary prefixes to the expanded SI and OPTIMADE unit systems
rartino Jan 9, 2024
0e7e804
Fix typos and other minor issues with definitions via review
rartino Jan 10, 2024
f2d0d08
Update optimade-property-tools dependency to latest version
rartino Jan 10, 2024
dadd35b
Fix typos and other minor issues with definitions via review
rartino Jan 10, 2024
669906f
Add intermediate 'installers' dir.
vaitkus Jan 11, 2024
e89b71f
Add dependency installers for Debian 10, 11 and 12.
vaitkus Jan 11, 2024
8a023ac
Remove dependency installer for Debian 8 since the OS is no longer su…
vaitkus Jan 11, 2024
c8923d1
Add 'ant' as a dependency.
vaitkus Jan 15, 2024
1973131
Add more dependencies required by the 'optimade-property-tools' submo…
vaitkus Jan 15, 2024
bff4bb5
Add 'make' as a dependency.
vaitkus Jan 15, 2024
765f905
Update Debian dependencies for optimade-property-tools
rartino Jan 15, 2024
92ca336
external/json-schema no longer needed (available in dependency)
rartino Jan 15, 2024
f0bbedf
Restructure meta-schemas for broader compatibility with various editi…
rartino Jan 16, 2024
e2e4331
Merge branch 'develop' into add-property-definitons-3
rartino Jan 16, 2024
0c23ebd
Support schemas generation with Python < 3.8
rartino Jan 16, 2024
c1233a3
Fix formatting and links
rartino Jan 16, 2024
95679da
Revert definition of pattern field (to be reinstated when we have agr…
rartino Mar 19, 2024
f89e89c
Merge branch 'develop' into add-property-definitons-3
rartino Mar 19, 2024
5ddf4ff
Reformat markdown-type link
rartino Mar 19, 2024
86ef1c9
Fix typo in kind field for constants
rartino Mar 19, 2024
dca1cd0
Rename GNU_units to GNU_Units
rartino Mar 19, 2024
70cafeb
Fix GNU_Units directory name in .pre-commit-config.yaml
rartino Mar 19, 2024
905512b
Minor typo correction from review
rartino Mar 19, 2024
7f85bb0
Minor corrections from review
rartino Mar 21, 2024
d573f40
Language improvements from review
rartino Mar 21, 2024
29e751b
Text fixes in unit and property definitions from review
rartino Mar 21, 2024
0e39cff
Text improvement in files property
rartino Mar 21, 2024
588c9d2
Fix kelvin symbol in defining relation for degcelsius
rartino Mar 21, 2024
3e17f78
Text fixes in property definitions
rartino Mar 21, 2024
33a4895
Text fix in schemas/README.md
rartino Mar 21, 2024
3d7b910
Improve consistency for ordinal indicators
rartino Mar 21, 2024
453b6df
Text fixes in unit definitions
rartino Mar 21, 2024
1bb387c
Make capitalization in tile field consistent
rartino Mar 21, 2024
d53543c
Remove accidentally checked-in optimade.html
rartino Mar 21, 2024
1573d1c
Revert incorrect capitalization fix of Bohr magneton
rartino Mar 21, 2024
b396099
Spellcheck of unit definitions
rartino Mar 21, 2024
c53b542
Minor text correction in property definition
rartino Mar 21, 2024
d6f0a55
Correct name of schemas/README.md
rartino Mar 21, 2024
48ec3b8
Merge branch 'develop' into add-property-definitons-3
rartino Mar 21, 2024
c095ccc
Improve meta-schema consistency
rartino Mar 21, 2024
8d6f8f9
Fix markdown rendering issues
rartino Mar 21, 2024
db23569
Minor spelling fixes in readme and optimade.rst from review
rartino Mar 21, 2024
4693108
Fix title capitalization for Hall space group symbol
rartino Mar 21, 2024
d81f932
Fix title capitalizations
rartino Mar 21, 2024
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
Prev Previous commit
Next Next commit
Apply suggestions from review
Co-authored-by: Matthew Evans <7916000+ml-evs@users.noreply.github.com>
  • Loading branch information
rartino and ml-evs authored Mar 19, 2023
commit 737cfc25ef700d33b90bbb74ae817f067a412d7b
22 changes: 11 additions & 11 deletions optimade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1875,7 +1875,7 @@ A Property Definition MUST be composed according to the combination of the requi
A human-readable description of the relationship between the property and the remote resource, e.g., a "natural language description".

- :field:`resource-id`: String.
A IRI of the external resource, which MAY be a resolvable URL.
An IRI of the external resource, which MAY be a resolvable URL.

**REQUIRED keys for all levels of the Property Definition:**

Expand All @@ -1889,7 +1889,7 @@ A Property Definition MUST be composed according to the combination of the requi
A (compound) symbol for the physical unit in which the value of the defined property is given or one of the strings :val:`dimensionless` or :val:`inapplicable`.
See subsection `Physical Units in Property Definitions`_ for the details on how compound units are represented in OPTIMADE Property Definitions and the precise format of this string.

**OPTIONAL keys at all nested levels of the Property Definition which are regarded as annotations to the Property Definition**
**OPTIONAL keys at all nested levels of the Property Definition which are regarded as annotations to the Property Definition:**

The following fields should be seen as annotations to a Property Definition rather than an integral part of it.
Property Defintions that only differ by fields that are considered annotations are to be considered the same, and as explained in the `definition of the $id field`_ SHOULD share the same :field:`$id`.
Expand Down Expand Up @@ -1922,7 +1922,7 @@ Property Defintions that only differ by fields that are considered annotations a
Defines the filter language features supported on this property.
MUST be present and not :val:`null` if and only if :field:`query-support` is :val:`partial`.

Each string in the list MUST be one of :val:`<`, :val:`<=`, :val:`>`, :val:`>=`, :val:`=`, :val:`!=`, :val:`CONTAINS`, :val:`STARTS WITH`, :val:`ENDS WITH`:, :val:`HAS`, :val:`HAS ALL`, :val:`HAS ANY`, :val:`HAS ONLY`, :val:`IS KNOWN`, :val:`IS UNKNOWN` with the following meanings:
Each string in the list MUST be one of :val:`<`, :val:`<=`, :val:`>`, :val:`>=`, :val:`=`, :val:`!=`, :val:`CONTAINS`, :val:`STARTS WITH`, :val:`ENDS WITH`, :val:`HAS`, :val:`HAS ALL`, :val:`HAS ANY`, :val:`HAS ONLY`, :val:`IS KNOWN`, :val:`IS UNKNOWN` with the following meanings:

- :val:`<`, :val:`<=`, :val:`>`, :val:`>=`, :val:`=`, :val:`!=`: indicating support for filtering this property using the respective operator.
If the property is of Boolean type, support for :val:`=` also designates support for boolean comparisons with the property being true that omit ":filter-fragment:`= TRUE`", e.g., specifying that filtering for ":filter:`is_yellow = TRUE`" is supported also implies support for ":filter:`is_yellow`" (which means the same thing).
Expand All @@ -1936,7 +1936,7 @@ Property Defintions that only differ by fields that are considered annotations a

- :val:`IS KNOWN`, :val:`IS UNKNOWN`: indicating support for filtering this property on unknown values using the respective operator.

- :field:`response-default`: Boolean
- :field:`response-default`: Boolean.
The value :val:`TRUE` means the implementation includes the property in responses by default, i.e., when not specifically requested.
The value :val:`FALSE` means that the property is only included when requested.
Omitting the field or :val:`null` means the implementation does not declare if the property will be included in responses by default or not.
Expand Down Expand Up @@ -1994,11 +1994,11 @@ The format described in this subsection forms a subset of the `JSON Schema Valid

It MUST be a list of one or two elements where the first element is a string correlated with :field:`x-optimade-type` as follows; if :field:`x-optimade-type` is:

* :val:`"boolean"`, `"string"`, or `"integer"` then :field:`type` is the same string.
* :val:`"dictionary"` then :field:`type` is `"object"`.
* :val:`"list"` then :field:`type` is `"array"`.
* :val:`"float"` then :field:`type` is `"number"`.
* :val:`"timestamp"` then :field:`type` is `"string"`.
* :val:`"boolean"`, `"string"`, or `"integer"` then :field:`type` is the same string.
* :val:`"dictionary"` then :field:`type` is `"object"`.
* :val:`"list"` then :field:`type` is `"array"`.
* :val:`"float"` then :field:`type` is `"number"`.
* :val:`"timestamp"` then :field:`type` is `"string"`.

If the second element is included, it MUST be the string :val:`"null"`.
This two element form specifies that the defined property can be :val:`null`.
Expand Down Expand Up @@ -2044,7 +2044,7 @@ The format described in this subsection forms a subset of the `JSON Schema Valid
- :field:`description`: String.
A human-readable multi-line description that explains the purpose, requirements, and conventions of the defined property.
The format SHOULD be a one-line description, followed by a new paragraph (two newlines), followed by a more detailed description of all the requirements and conventions of the defined property.
Formatting in the text SHOULD use Markdown in the `CommonMark v0.3 format <https://spec.commonmark.org/0.30/>`__ format, with mathematical expressions written to render correctly with the LaTeX mode of `Mathjax 3.2 <https://docs.mathjax.org/en/v3.2-latest/>`.
Formatting in the text SHOULD use Markdown in the `CommonMark v0.3 format <https://spec.commonmark.org/0.30/>`__ format, with mathematical expressions written to render correctly with the LaTeX mode of `Mathjax 3.2 <https://docs.mathjax.org/en/v3.2-latest/>`__.
When possible, it is preferable for mathematical expressions to use as straightforward notation as possible to make them readable also when not rendered.

Additions appended to the end of the :field:`description` field that are clearly marked as notes that clarify the definition without changing it are viewed as annotations to the Property Definition rather than an integral part of it.
Expand Down Expand Up @@ -2326,7 +2326,7 @@ An OPTIMADE Physical Unit Definition is a dictionary adhering to the following f
A human-readable description of the relationship between the unit and the remote resource, e.g., a "natural language description".

- :field:`resource-id`: String.
A IRI of the external resource (which MAY be a resolvable URL).
An IRI of the external resource (which MAY be a resolvable URL).

.. _definition of defining-relation:

Expand Down