Skip to content

Commit

Permalink
Add database field to meta for describing the current database
Browse files Browse the repository at this point in the history
  • Loading branch information
ml-evs committed Sep 29, 2022
1 parent da7e1c3 commit 5672491
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions optimade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -497,6 +497,17 @@ Every response SHOULD contain the following fields, and MUST contain at least :f

Implementation note: the functionality of this field overlaps to some degree with features provided by the HTTP error :http-error:`429 Too Many Requests` and the `Retry-After HTTP header <https://tools.ietf.org/html/rfc7231.html#section-7.1.3>`__. Implementations are suggested to provide consistent handling of request overload through both mechanisms.

- **database**: a dictionary describing the specific database accessible at this OPTIMADE API.
If provided, the dictionary fields SHOULD match those provided in the corresponding the links entry for the database in the provider's index meta-database, outlined in `Links Endpoint JSON Response Schema`_.
The dictionary should contain the OPTIONAL fields:

- **name**: a human-readable name for the database, e.g., for use in clients.
- **description**: a human-readable description of the database, e.g., for use in clients.
- **homepage**: a `JSON API links object <http://jsonapi.org/format/1.0/#document-links>`__, pointing to a homepage for the particular database.
- **maintainer**: a dictionary providing details about the maintainer of the database, which MUST contain the single field:

- **email** with the maintainer's email address.

- **implementation**: a dictionary describing the server implementation, containing the OPTIONAL fields:

- **name**: name of the implementation.
Expand Down Expand Up @@ -563,6 +574,14 @@ Every response SHOULD contain the following fields, and MUST contain at least :f
"email": "admin@example.com"
},
"issue_tracker": "http://tracker.example.com/exmpl-optimade"
},
"database": {
"name": "Example database 1 (of many)",
"description": "The first example database in a series hosted by the Example Provider.",
"homepage": "http://database_one.example.com",
"maintainer": {
"email": "science_lead@example.com"
}
}
}
// ...
Expand Down

0 comments on commit 5672491

Please sign in to comment.