From e171370b70f66dd849211689b5f4aad3a766d6fb Mon Sep 17 00:00:00 2001 From: OPTIMADE Developers Date: Tue, 25 Feb 2025 16:10:57 +0000 Subject: [PATCH] Release v1.2.0 - Changelog --- CHANGELOG.md | 21 +++++++++++++++++++-- docs/static/default_config.json | 2 +- openapi/index_openapi.json | 2 +- openapi/openapi.json | 2 +- optimade/__init__.py | 2 +- 5 files changed, 23 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 07e9beed6..39074d7f2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,11 +2,27 @@ ## [Unreleased](https://github.com/Materials-Consortia/optimade-python-tools/tree/HEAD) -[Full Changelog](https://github.com/Materials-Consortia/optimade-python-tools/compare/v1.1.11...HEAD) +[Full Changelog](https://github.com/Materials-Consortia/optimade-python-tools/compare/v1.2.0...HEAD) + +This v1.2.0 release is coincidentally the first to support some features from OPTIMADE v1.2.0, namely the specification of licenses. Support for other 1.2 fields (e.g., symmetry, partial data etc.) will come in future releases based on demand. As the `optimade.__api_version__` has been bumped, servers running optimade-python-tools will now have versioned endpoints for `/v1` and `/v1.2`, but not `/v1.1`. For now, only one OPTIMADE API version is targeted by each optimade-python-tools version, as listed in the README. If you need any changes backported to the v1.1.x branch, please raise an issue. + +## [v1.2.0](https://github.com/Materials-Consortia/optimade-python-tools/tree/v1.2.0) (2025-02-25) + +[Full Changelog](https://github.com/Materials-Consortia/optimade-python-tools/compare/v1.1.11...v1.2.0) + +**Fixed bugs:** + +- Retain `next_url` value in responses from `OptimadeClient` [\#2233](https://github.com/Materials-Consortia/optimade-python-tools/pull/2233) ([mehmetgiritli](https://github.com/mehmetgiritli)) **Closed issues:** -- Support for specifying database licenses [\#1254](https://github.com/Materials-Consortia/optimade-python-tools/issues/1254) +- I [\#2225](https://github.com/Materials-Consortia/optimade-python-tools/issues/2225) +- Ability to dynamically skip erroneous entries [\#2166](https://github.com/Materials-Consortia/optimade-python-tools/issues/2166) + +**Merged pull requests:** + +- Allow overriding request URL in `OptimadeClient` [\#2234](https://github.com/Materials-Consortia/optimade-python-tools/pull/2234) ([mehmetgiritli](https://github.com/mehmetgiritli)) +- Add configurable `license` and `available_licenses` info fields [\#2224](https://github.com/Materials-Consortia/optimade-python-tools/pull/2224) ([ml-evs](https://github.com/ml-evs)) ## [v1.1.11](https://github.com/Materials-Consortia/optimade-python-tools/tree/v1.1.11) (2025-02-07) @@ -15,6 +31,7 @@ **Closed issues:** - Overzealous validation of disordered structures [\#2221](https://github.com/Materials-Consortia/optimade-python-tools/issues/2221) +- Support for specifying database licenses [\#1254](https://github.com/Materials-Consortia/optimade-python-tools/issues/1254) **Merged pull requests:** diff --git a/docs/static/default_config.json b/docs/static/default_config.json index c1f844b9f..ed5bea27b 100644 --- a/docs/static/default_config.json +++ b/docs/static/default_config.json @@ -12,7 +12,7 @@ "base_url": null, "implementation": { "name": "OPTIMADE Python Tools", - "version": "1.1.11", + "version": "1.2.0", "source_url": "https://github.com/Materials-Consortia/optimade-python-tools", "maintainer": {"email": "dev@optimade.org"} }, diff --git a/openapi/index_openapi.json b/openapi/index_openapi.json index 858d14158..449be4a5c 100644 --- a/openapi/index_openapi.json +++ b/openapi/index_openapi.json @@ -2,7 +2,7 @@ "openapi": "3.1.0", "info": { "title": "OPTIMADE API - Index meta-database", - "description": "The [Open Databases Integration for Materials Design (OPTIMADE) consortium](https://www.optimade.org/) aims to make materials databases interoperational by developing a common REST API.\nThis is the \"special\" index meta-database.\n\nThis specification is generated using [`optimade-python-tools`](https://github.com/Materials-Consortia/optimade-python-tools/tree/v1.1.11) v1.1.11.", + "description": "The [Open Databases Integration for Materials Design (OPTIMADE) consortium](https://www.optimade.org/) aims to make materials databases interoperational by developing a common REST API.\nThis is the \"special\" index meta-database.\n\nThis specification is generated using [`optimade-python-tools`](https://github.com/Materials-Consortia/optimade-python-tools/tree/v1.2.0) v1.2.0.", "version": "1.2.0" }, "paths": { diff --git a/openapi/openapi.json b/openapi/openapi.json index 6ba719198..e2c67e8ea 100644 --- a/openapi/openapi.json +++ b/openapi/openapi.json @@ -2,7 +2,7 @@ "openapi": "3.1.0", "info": { "title": "OPTIMADE API", - "description": "The [Open Databases Integration for Materials Design (OPTIMADE) consortium](https://www.optimade.org/) aims to make materials databases interoperational by developing a common REST API.\n\nThis specification is generated using [`optimade-python-tools`](https://github.com/Materials-Consortia/optimade-python-tools/tree/v1.1.11) v1.1.11.", + "description": "The [Open Databases Integration for Materials Design (OPTIMADE) consortium](https://www.optimade.org/) aims to make materials databases interoperational by developing a common REST API.\n\nThis specification is generated using [`optimade-python-tools`](https://github.com/Materials-Consortia/optimade-python-tools/tree/v1.2.0) v1.2.0.", "version": "1.2.0" }, "paths": { diff --git a/optimade/__init__.py b/optimade/__init__.py index c1df3d23a..48aac98a0 100644 --- a/optimade/__init__.py +++ b/optimade/__init__.py @@ -1,2 +1,2 @@ -__version__ = "1.1.11" +__version__ = "1.2.0" __api_version__ = "1.2.0"