From 05dc9f3ced7b3cc57055509e92fc31861918237d Mon Sep 17 00:00:00 2001 From: Andrius Merkys Date: Tue, 17 Nov 2020 09:48:06 +0200 Subject: [PATCH 1/2] Add field for implementation issue tracker (fixes #337). --- optimade.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/optimade.rst b/optimade.rst index 705fa50d7..f635bf681 100644 --- a/optimade.rst +++ b/optimade.rst @@ -501,6 +501,8 @@ Every response SHOULD contain the following fields, and MUST contain at least :f - **email** with the maintainer's email address. + - **issue\_tracker**: a `JSON API links object `__ pointing to the implementation issue tracker. + - **warnings**: a list of warning resource objects representing non-critical errors or warnings. A warning resource object is defined similarly to a `JSON API error object `__, but MUST also include the field :field:`type`, which MUST have the value :field-val:`"warning"`. The field :field:`detail` MUST be present and SHOULD contain a non-critical message, e.g., reporting unrecognized search attributes or deprecated features. @@ -553,7 +555,8 @@ Every response SHOULD contain the following fields, and MUST contain at least :f "source_url": "http://git.example.com/exmpl-optimade", "maintainer": { "email": "admin@example.com" - } + }, + "issue_tracker": "http://tracker.example.com/exmpl-optimade" } } // ... From 558a71b7e4085343ef5e65f0d26522f68bedb6b5 Mon Sep 17 00:00:00 2001 From: Andrius Merkys Date: Tue, 17 Nov 2020 12:35:06 +0200 Subject: [PATCH 2/2] Update optimade.rst Co-authored-by: Casper Welzel Andersen <43357585+CasperWA@users.noreply.github.com> --- optimade.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/optimade.rst b/optimade.rst index f635bf681..0ac84f5af 100644 --- a/optimade.rst +++ b/optimade.rst @@ -501,7 +501,7 @@ Every response SHOULD contain the following fields, and MUST contain at least :f - **email** with the maintainer's email address. - - **issue\_tracker**: a `JSON API links object `__ pointing to the implementation issue tracker. + - **issue\_tracker**: a `JSON API links object `__ pointing to the implementation's issue tracker. - **warnings**: a list of warning resource objects representing non-critical errors or warnings. A warning resource object is defined similarly to a `JSON API error object `__, but MUST also include the field :field:`type`, which MUST have the value :field-val:`"warning"`.