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.

Sign up for GitHub

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

Clarify encoding of OPTIMADE timestamp in property definitions. #444

Merged
merged 4 commits into from
Dec 22, 2022
Merged

Clarify encoding of OPTIMADE timestamp in property definitions. #444

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7e38402
Clarify encoding of OPTIMADE timestamp in property definitions.
rartino Dec 22, 2022
16baa94
Improve language
rartino Dec 22, 2022
deec0c5
Fix spelling errors found in review
rartino Dec 22, 2022
bb2aa1c
Merge branch 'develop' into add-property-definitions
rartino Dec 22, 2022
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
7 changes: 7 additions & 0 deletions optimade.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1947,6 +1947,13 @@ The format described in this subsection forms a subset of the `JSON Schema Valid
- One of the strings :val:`"boolean"`, :val:`"object"` (refers to an OPTIMADE dictionary), :val:`"array"` (refers to an OPTIMADE list), :val:`"number"` (refers to an OPTIMADE float), :val:`"string"`, or :val:`"integer"`.
- A list where the first item MUST be one of the strings above, and the second item MUST be the string :val:`"null"`.

For OPTIMADE data types not covered above:

- timestamps are represented by setting the :field:`type` field to :val:`"string"` and the :field:`format` field to :val:`"date-time"`.
In this case it is MANDATORY to include the field :field:`format`.

Output formats that represent these OPTIMADE data types in other ways have to recognize them and reinterpret the definition accordingly.

..

Implementation notes:
Expand Down