Add issue_tracker field to provider model

README.md

@@ -38,11 +38,7 @@ Each release of the `optimade` package from this repository only targets one ver
 | OPTIMADE API version | `optimade` version |
 |:--------------------:|:------------------:|
 | [v1.0.0](https://github.com/Materials-Consortia/OPTIMADE/blob/v1.0.0/optimade.rst) | [v0.12.9](https://github.com/Materials-Consortia/optimade-python-tools/tree/v0.12.9) |
-| [v1.0.1](https://github.com/Materials-Consortia/OPTIMADE/blob/v1.0.1/optimade.rst) [<sup>†</sup>](#version_footnote) | [v0.13.1](https://github.com/Materials-Consortia/optimade-python-tools/tree/v0.13.1) |
-
-<span id="#version_footnote"><sup>†</sup></span>
-Whilst both the specification and this package follow semantic versioning, a [potentially backwards incompatible change](https://github.com/Materials-Consortia/OPTIMADE/pull/344) was introduced in v1.0.1 of the specification.
-
+| [v1.1.0](https://github.com/Materials-Consortia/OPTIMADE/blob/v1.1.0/optimade.rst) [<sup>†</sup>](#version_footnote) | [v0.16.0+](https://github.com/Materials-Consortia/optimade-python-tools/tree/v0.16.0) |
 
 ## Contributing
 

openapi/index_openapi.json

@@ -3,7 +3,7 @@
  "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/v0.15.5) v0.15.5.",
- "version": "1.0.1"
+ "version": "1.1.0"
  },
  "paths": {
  "/info": {
@@ -794,6 +794,21 @@
  }
  ],
  "description": "A dictionary providing details about the maintainer of the implementation."
+ },
+ "issue_tracker": {
+ "title": "Issue Tracker",
+ "anyOf": [
+ {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 65536,
+ "format": "uri"
+ },
+ {
+ "$ref": "#/components/schemas/Link"
+ }
+ ],
+ "description": "A [JSON API links object](http://jsonapi.org/format/1.0/#document-links) pointing to the implementation's issue tracker."
  }
  },
  "description": "Information on the server implementation"

openapi/openapi.json

@@ -3,7 +3,7 @@
  "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/v0.15.5) v0.15.5.",
- "version": "1.0.1"
+ "version": "1.1.0"
  },
  "paths": {
  "/info": {
@@ -2045,6 +2045,21 @@
  }
  ],
  "description": "A dictionary providing details about the maintainer of the implementation."
+ },
+ "issue_tracker": {
+ "title": "Issue Tracker",
+ "anyOf": [
+ {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 65536,
+ "format": "uri"
+ },
+ {
+ "$ref": "#/components/schemas/Link"
+ }
+ ],
+ "description": "A [JSON API links object](http://jsonapi.org/format/1.0/#document-links) pointing to the implementation's issue tracker."
  }
  },
  "description": "Information on the server implementation"

optimade-version.json

@@ -1,7 +1,7 @@
 {
  "schemaVersion": 1,
  "label": "OPTIMADE",
- "message": "v1.0.1",
+ "message": "v1.1.0",
  "color": "yellowgreen",
  "logoSvg": "<svg version='1' xmlns='http://www.w3.org/2000/svg' viewBox='0 0 55 55'><line x1='27' y1='14.5' x2='38.0' y2='7.94744111674' stroke='#9ed700' stroke-width='1.15' /><line x1='37.8253175473' y1='33.25' x2='38.0' y2='46.0525588833' stroke='#00acd9' stroke-width='1.15' /><line x1='16.1746824527' y1='33.25' x2='5' y2='27' stroke='#7a2dd0' stroke-width='1.15' /><line x1='49' y1='27' x2='38.0' y2='46.0525588833' stroke='#00acd9' stroke-width='1.15' /><line x1='38.0' y1='46.0525588833' x2='16.0' y2='46.0525588833' stroke='#e8e8e8' stroke-width='2' /><line x1='16.0' y1='46.0525588833' x2='5' y2='27' stroke='#7a2dd0' stroke-width='1.15' /><line x1='5' y1='27' x2='16.0' y2='7.94744111674' stroke='#e8e8e8' stroke-width='2' /><line x1='16.0' y1='7.94744111674' x2='38.0' y2='7.94744111674' stroke='#9ed700' stroke-width='1.15' /><line x1='38.0' y1='7.94744111674' x2='49' y2='27' stroke='#e8e8e8' stroke-width='2' /><circle cx='49' cy='27' r='3.5' fill='#00acd9' /><circle cx='38.0' cy='46.0525588833' r='3.5' fill='#00acd9' /><circle cx='16.0' cy='46.0525588833' r='3.5' fill='#7a2dd0' /><circle cx='5' cy='27' r='3.5' fill='#7a2dd0' /><circle cx='16.0' cy='7.94744111674' r='3.5' fill='#9ed700' /><circle cx='38.0' cy='7.94744111674' r='3.5' fill='#9ed700' /><line x1='27' y1='39.5' x2='16.1746824527' y2='33.25' stroke='#ff414d' stroke-width='1' /><line x1='16.1746824527' y1='33.25' x2='16.1746824527' y2='20.75' stroke='#ff414d' stroke-width='1' /><line x1='16.1746824527' y1='20.75' x2='27' y2='14.5' stroke='#ff414d' stroke-width='1' /><line x1='27' y1='14.5' x2='37.8253175473' y2='20.75' stroke='#ff414d' stroke-width='1' /><line x1='37.8253175473' y1='20.75' x2='37.8253175473' y2='33.25' stroke='#ff414d' stroke-width='1' /><line x1='37.8253175473' y1='33.25' x2='27' y2='39.5' stroke='#ff414d' stroke-width='1' /><circle cx='27' cy='39.5' r='2.5' fill='#ff414d' /><circle cx='16.1746824527' cy='33.25' r='2.5' fill='#ff414d' /><circle cx='16.1746824527' cy='20.75' r='2.5' fill='#ff414d' /><circle cx='27' cy='14.5' r='2.5' fill='#ff414d' /><circle cx='37.8253175473' cy='20.75' r='2.5' fill='#ff414d' /><circle cx='37.8253175473' cy='33.25' r='2.5' fill='#ff414d' /></svg>"
 }

optimade/__init__.py

@@ -1,2 +1,2 @@
 __version__ = "0.15.5"
-__api_version__ = "1.0.1"
+__api_version__ = "1.1.0"

optimade/models/optimade_json.py

@@ -244,6 +244,11 @@ class Implementation(BaseModel):
  description="A dictionary providing details about the maintainer of the implementation.",
  )
 
+ issue_tracker: Optional[Union[AnyUrl, jsonapi.Link]] = StrictField(
+ None,
+ description="A [JSON API links object](http://jsonapi.org/format/1.0/#document-links) pointing to the implementation's issue tracker.",
+ )
+
 
 class ResponseMeta(jsonapi.Meta):
  """

optimade/server/config.py

@@ -206,6 +206,7 @@ class ServerConfig(BaseSettings):
  version=__version__,
  source_url="https://github.com/Materials-Consortia/optimade-python-tools",
  maintainer={"email": "dev@optimade.org"},
+ issue_tracker="https://github.com/Materials-Consortia/optimade-python-tools/issues",
  ),
  description="Introspective information about this OPTIMADE implementation",
  )