Skip to content

Commit

Permalink
Mention description in "Nested property names".
Browse files Browse the repository at this point in the history
  • Loading branch information
merkys committed Nov 18, 2024
1 parent a40c0e0 commit 6504db7
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion optimade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2001,7 +2001,7 @@ A filter on a nested property name consisting of two identifiers :filter-fragmen
E.g., if :filter-fragment:`identifier1` is the list :filter-fragment:`[{"identifier2":42, "identifier3":36}, {"identifier2":96, "identifier3":66}]`, then :filter-fragment:`identifier1.identifier2` is understood in the filter as the list :filter-fragment:`[42, 96]`.

- :filter-fragment:`identifier1` references an entry type of a group of related entries each containing a property named after an identifier :filter-fragment:`identifier2` and the filter matches for a flat list containing only the values of :filter-fragment:`identifier2` properties for every related entry.
In this case, :filter-fragment:`identifier2` is restricted to either :property:`id`, when matching directly on the ID of the related entry, or :property:`target`, which can be further nested to enable queries on the related entry's property.
In this case, :filter-fragment:`identifier2` is restricted to either :property:`id`, when matching directly on the ID of the related entry, or :property:`description`, when matching on human-readable description of the relationship, or :property:`target`, which can be further nested to enable queries on the related entry's property.
Support for such queries is OPTIONAL.
E.g., :filter-fragment:`references.target.doi` is understood in the filter as the list containing values of :property:`doi` for all related entries of type :entry:`references`.
This is explained in more detail in section `Filtering on relationships`_.
Expand Down

0 comments on commit 6504db7

Please sign in to comment.