From aad61bbd008bbd9e3d37d8374fece1c7e2778941 Mon Sep 17 00:00:00 2001 From: garfield69 Date: Thu, 21 Oct 2021 15:44:03 +1300 Subject: [PATCH] Updated Definition format (markdown) --- Definition-format.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/Definition-format.md b/Definition-format.md index b9f0785..70b10be 100644 --- a/Definition-format.md +++ b/Definition-format.md @@ -604,11 +604,13 @@ search: rows: # [REQUIRED] This is the where you define how to find the row sets that contain the torrent fields selector: data.movies - # [OPTIONAL] You can explicitly provide the number of rows if the response contains this field - # So if the response had a count of 0 this would indicate a results not found condition. - # If the response is simply an empty set [] then that also signifies no results found. + # [OPTIONAL] If the response contains a field that indicates the number of hits returned, + # then you define that field in the count block selector, so that if the response had a + # count of 0 if would indicate a results not found condition. + # If the response uses an empty set [] to signify a no results found state, then don't use the count block. count: # [REQUIRED] IF you have defined the Count block then you need to provide the field that has the count. + # You can use the $ symbol to refer to the root object, for example: $[0].found_total selector: data.movie_count # [REQUIRED] list of attributes which are extracted for each row