Skip to content

Commit

Permalink
Update changelog and spec version for rc.2
Browse files Browse the repository at this point in the history
  • Loading branch information
ml-evs committed Mar 25, 2024
1 parent 1543017 commit 5e94eba
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 3 deletions.
36 changes: 36 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,41 @@
# Changelog

## v1.2.0-rc.2 (December 2023)

This is the second release candidate of v1.2.0 of the OPTIMADE API specification.
Implementation details may still be modified before the final release.

Note: The OpenAPI schemas distributed in `./schemas` have not yet been modified with the new features 1.2.0.

This minor release adds significant but optional new functionality to the specification, as well as providing several clarifications to existing behaviour.

### Changes relative to rc.1

- **Partial data** ([#467](https://github.com/Materials-Consortia/OPTIMADE/pull/467)): Adds the mechanism format for streaming, paginating or slicing individual properties within entries.
- **Per entry/property metadata** ([#463](https://github.com/Materials-Consortia/OPTIMADE/pull/463): Added a mechanism for providing metadata specific to a given entry or property
- **Database metadata field** ([#424](https://github.com/Materials-Consortia/OPTIMADE/pull/424): Added an additional metadata field `database` for describing a given dataset
- **Compatibility with JSON:API v1.1** ([#461](https://github.com/Materials-Consortia/OPTIMADE/pull/461)
- **Symmetry operation specification and enhanced space group fields** ([#480](https://github.com/Materials-Consortia/OPTIMADE/pull/480)
- Typo, formatting and snippet fixes

### New features (duplicated from rc.1)

- **Property definitions** ([#376](https://github.com/Materials-Consortia/OPTIMADE/pull/376)).
A new section titled [Property Definitions](https://github.com/Materials-Consortia/OPTIMADE/blob/develop/optimade.rst#property-definitions) has been added to the specification which significantly extends the way in which implementations can define and describe the custom properties they serve, including URIs, unit definitions, API support levels (for querying and sorting) as well as full support for JSON Schema constructs for describing the JSON representation of the property.
- **Files endpoint** ([#360](https://github.com/Materials-Consortia/OPTIMADE/pull/360)).
The `/files` endpoint and corresponding [`files` entry
type](https://github.com/Materials-Consortia/OPTIMADE/blob/develop/optimade.rst#files-entries) has been added to provide a robust way of linking entries to arbitrary file-based data relevant to the entry, such as alternative crystal structure representation formats, input or output files from computational procedures, or experimental data files.
- **Boolean values** ([#348](https://github.com/Materials-Consortia/OPTIMADE/pull/348)).
[Boolean values](https://github.com/Materials-Consortia/OPTIMADE/blob/develop/optimade.rst#comparisons-of-boolean-values) were overlooked in the first version of the filter grammar as no OPTIMADE fields required them.
This functionality has been introduced for boolean fields using the syntax `TRUE` and `FALSE`.
Only strict equality (`=`) and inequality (`!=`) comparisons on individual fields are supported.
- **Fuzzy comparisons on lists** ([#415](https://github.com/Materials-Consortia/OPTIMADE/pull/415))
String comparisons like `CONTAINS`, `STARTS WITH` and `ENDS WITH` are now compatible with list filter operations like `HAS`, `HAS ALL` etc.
- **Backoff time** ([#411](https://github.com/Materials-Consortia/OPTIMADE/pull/411)):
- **Database licenses** ([#414](https://github.com/Materials-Consortia/OPTIMADE/pull/414)):
- **Symmetry data** ([#405](https://github.com/Materials-Consortia/OPTIMADE/pull/405)):


## v1.2.0-rc.1 (December 2022)

This is the first release candidate of v1.2.0 of the OPTIMADE API specification.
Expand Down
6 changes: 3 additions & 3 deletions optimade.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
=========================================
OPTIMADE API specification v1.2.0~develop
=========================================
======================================
OPTIMADE API specification v1.2.0-rc.2
======================================

.. comment
Expand Down

0 comments on commit 5e94eba

Please sign in to comment.