Skip to content

Commit

Permalink
Merge branch 'develop' into collections_endpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
rartino authored Jun 29, 2022
2 parents e817790 + f1e656e commit 614bc76
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions optimade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1022,13 +1022,22 @@ The single resource object's response dictionary MUST include the following fiel
- **formats**: List of available output formats.
- **entry\_types\_by\_format**: Available entry endpoints as a function of output formats.
- **available\_endpoints**: List of available endpoints (i.e., the string to be appended to the versioned or unversioned base URL serving the API).
- **license**: A `JSON API links object <http://jsonapi.org/format/1.0/#document-links>`__ giving a URL to a web page containing a human-readable text describing the license (or licensing options if there are multiple) covering all the data and metadata provided by this database.
Clients are advised not to try automated parsing of this link or its content, but rather rely on the field :field:`available_licenses` instead.
Example: :field-val:`https://example.com/licenses/example_license.html`.

:field:`attributes` MAY also include the following OPTIONAL fields:

- **is\_index**: if :field-val:`true`, this is an index meta-database base URL (see section `Index Meta-Database`_).

If this member is *not* provided, the client MUST assume this is **not** an index meta-database base URL (i.e., the default is for :field:`is_index` to be :field-val:`false`).

- **available\_licenses**: List of `SPDX license identifiers <https://spdx.org/licenses/>` specifying a set of alternative licenses under which the client is granted access to all the data and metadata in this database.
If the data and metadata is available under multiple alternative licenses, identifiers of these multiple licenses SHOULD be provided to let clients know under which conditions the data and metadata can be used.
Inclusion of a license identifier in the list is a commitment of the database that the rights are in place to grant clients access to all the data and metadata according to the terms of either of these licenses (at the choice of the client).
If the licensing information provided via the field :field:`license` omits licensing options specified in :field:`available_licenses`, or if it otherwise contradicts them, a client MUST still be allowed to interpret the inclusion of a license in :field:`available_licenses` as a full commitment from the database that the data and metadata is available, without exceptions, under the respective licenses.
If the database cannot make that commitment, e.g., if only part of the data is available under a license, the corresponding license identifier MUST NOT appear in :field:`available_licenses` (but, rather, the field :field:`license` is to be used to clarify the licensing situation.)
An empty list indicates that none of the SPDX licenses apply for the entirety of the database and that the licensing situation is clarified in human readable form in the field :field:`license`.
If this is an index meta-database base URL (see section `Index Meta-Database`_), then the response dictionary MUST also include the field:

- **relationships**: Dictionary that MAY contain a single `JSON API relationships object <https://jsonapi.org/format/1.0/#document-resource-object-relationships>`__:
Expand Down

0 comments on commit 614bc76

Please sign in to comment.