Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Means to specify database license #414

Merged
merged 13 commits into from
Jun 29, 2022
5 changes: 5 additions & 0 deletions optimade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1018,6 +1018,11 @@ 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 pointer to a license covering all the data provided under this database.
If the license is included in the `SPDX License List <https://spdx.org/licenses/>`__, then the URL MUST point to SPDX-hosted license fulltext, i.e., it MUST start with :field-val:`https://spdx.org/licenses/`, but MUST NOT include the terminating :field-val:`.html`.
Example: :field-val:`https://spdx.org/licenses/CC0-1.0`.
- **license_is_compatible_with_cc_by_4_0**: Boolean value indicating compatibility with `Creative Commons Attribution 4.0 International license <https://spdx.org/licenses/CC-BY-4.0>`__.
This field may be used to check whether a particular database allows aggregation of its data.

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

Expand Down