From a307229a39d17c56142cda4bea3c6b90f1212611 Mon Sep 17 00:00:00 2001 From: Rickard Armiento Date: Mon, 19 Dec 2022 10:49:40 +0100 Subject: [PATCH] Clarify how to group relationships and what key to use in JSON:API output --- optimade.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/optimade.rst b/optimade.rst index 01ef3fca0..4131c8bf2 100644 --- a/optimade.rst +++ b/optimade.rst @@ -897,6 +897,7 @@ OPTIONALLY it can also contain the following fields: - **relationships**: a dictionary containing references to other entries according to the description in section `Relationships`_ encoded as `JSON API Relationships `__. The OPTIONAL human-readable description of the relationship MAY be provided in the :field:`description` field inside the :field:`meta` dictionary of the JSON API resource identifier object. + All relationships to entries of the same entry type MUST be grouped into the same JSON API relationship object and placed in the relationships dictionary with the entry type name as key (e.g., :entry:`structures`). Example: