Update CHANGELOG and add implementation notes

Materials-Consortia · Mar 25, 2024 · f00aa83 · f00aa83
1 parent f661612
commit f00aa83
Showing 1 changed file with 30 additions and 43 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,60 +3,47 @@
 ## v1.2.0 (March 2024)
 
 
-This minor release adds significant but optional new functionality to the specification, as well as providing several clarifications to existing behaviour.
+This release adds significant but optional new functionality to the specification, as well as providing several clarifications to existing behaviour.
 
-### Changes relative to rc.1
+Minor OPTIMADE releases are always intended to be backwards-compatible for clients, meaning that any client code written for v1.1 should continue to work.
+Although the majority of features added in thius release are optional for servers, there are a couple of mandatory format additions that are discussed below in the notes for implementations.
+We have clarified our approach to versioning explicitly in the specification
+under [Versioning of this standard](https://github.com/Materials-Consortia/OPTIMADE/blob/v1.2.0/optimade.rst#versioning-of-this-standard).
 
-- **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
+For a more academic summary of the changes, please see our preprint: [arXiv:2402.00572](https://doi.org/10.48550/arXiv.2402.00572).
 
-### New features (duplicated from rc.1)
+### New features
+
+- **Property definitions** ([#376](https://github.com/Materials-Consortia/OPTIMADE/pull/376)): A new section titled [Property Definitions](https://github.com/Materials-Consortia/OPTIMADE/blob/v1.2.0/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.
+- **Namespace prefixes for definitions** ([#473](https://github.com/Materials-Consortia/OPTIMADE/pull/473)): The mechanism for providers to define custom properties under their own namespace/prefix has been extended to allow implementations to share common definitions. These so-called definition namespaces can be registered as providers in their own right and can serve property definitions in the new format.
+- **Partial data** ([#467](https://github.com/Materials-Consortia/OPTIMADE/pull/467)): Adds a mechanism and 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.
+- **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/v1.2.0/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.
+- **Symmetry operation specification and space group fields** ([#480](https://github.com/Materials-Consortia/OPTIMADE/pull/480), [#405](https://github.com/Materials-Consortia/OPTIMADE/pull/405), [#464](https://github.com/Materials-Consortia/OPTIMADE/pull/464)): Several fields have been added to the `structures` entry type to fully describe symmetry. Symmetry operations can be provided explicitly in `space_group_symmetry_operations_xyz`, as well as space group specifications in various forms: `space_group_symbol_hall`, `space_group_symbol_hermann_mauguin`, `space_group_symbol_hermann_mauguin_extended`, `space_group_it_number`.
+- **Database licenses** ([#414](https://github.com/Materials-Consortia/OPTIMADE/pull/414)): Several fields have been added to programmatically describe the licensing status of data served by OPTIMADE APIs. A database-wide license can be provided as a set of [SPDX identifiers](https://spdx.org/licenses/) in `available_licenses`, with a related field `available_licenses_for_entries` specifying specifically which licenses are available for data contained within the database. The global field `license` can be used point to a human-readable license page (external or otherwise) that explains any caveats to the licensing arrangement.
+- **Database metadata field** ([#424](https://github.com/Materials-Consortia/OPTIMADE/pull/424)): Added an additional metadata field `database` for providing a human-readable description of a given database.
+- **Backoff time** ([#411](https://github.com/Materials-Consortia/OPTIMADE/pull/411)): Databases can now request ahead of time that clients apply a particular rate limit or back-off time via the `request_delay` metadata field.
 
-- **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.
+### Patches
+
+- **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.
 - **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.
+[Boolean values](https://github.com/Materials-Consortia/OPTIMADE/blob/v1.2.0/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)):
-
+- **Compatibility with JSON:API v1.1** ([#461](https://github.com/Materials-Consortia/OPTIMADE/pull/461)): references to JSON:API v1.0 have been updated to v1.1.
+- Typo, formatting and code snippet fixes
 
-## v1.2.0-rc.1 (December 2022)
+### Notes for implementations
 
-This is the first release candidate of v1.2.0 of the OPTIMADE API specification.
-It should contain all of the new features in the specification, but their implementation may be modified in the final release.
+As discussed above, the majority of this release involves the addition of more expressive metadata fields for property definitions, definition namespaces shared across providers, and licensing information, as well as mechanisms for serving files and partial data responses (for large entries, e.g., giant structures).
+We hope that the machine-readable schemas and property definitions now available at [schemas.optimade.org](https://schemas.optimade.org) will make implementing the specification much easier.
 
-Note: The OpenAPI schemas distributed in `./schemas` have not yet been modified with the new features 1.2.0.
+The mandatory format changes required to support v1.2 are limited to the following:
 
-This minor release adds significant but optional new functionality to the specification, as well as providing several clarifications to existing behaviour.
-
-### New features
-
-- **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)):
+- `/info/<entry_type>` endpoints MUST now have a top-level `id` and `type` field. This is for compliance with JSON:API and their previous omission should be treated as a specification bug.
+- In cases where a server implementation treats filters on non-prefixed but unknown OPTIMADE fields as errors, implementations MUST update their known property list to handle new fields added to OPTIMADE in this version, such that they can continue to follow the expected behaviour for [Handling unknown property names](https://github.com/Materials-Consortia/OPTIMADE/blob/v1.2.0/optimade.rst#handling-unknown-property-names).
 
 
 ## v1.1.0 (July 8, 2021)