From 0faaacc415b10ef395a9c194c06e82f05abeb715 Mon Sep 17 00:00:00 2001 From: Sam Date: Thu, 25 Feb 2021 12:32:26 +0000 Subject: [PATCH] readme update --- README.md | 27 +++++++++++++++++++++++---- 1 file changed, 23 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a44efe4..c2e73b6 100644 --- a/README.md +++ b/README.md @@ -222,16 +222,35 @@ Response format: ```json { "filters": { - "singles": ["tag1", "tag2"], // for tags that aren't nested - "entry_1": ["subtag_1", "subtag_2"], // for tree tags like entry_1/subtag_1 - "entry_2": ["subtag_1", "subtag_2"] // one per penultimate tag in tree + "tags": { + "singles": ["tag1", "tag2"], // for tags that aren't nested + "entry_1": ["subtag_1", "subtag_2"], // for tree tags like entry_1/subtag_1 + "entry_2": ["subtag_1", "subtag_2"] // one per penultimate tag in tree + }, + "attributes": { + "singles": ["tag1", "tag2"], // for tags that aren't nested + "entry_1": ["subtag_1", "subtag_2"], // for tree tags like entry_1/subtag_1 + "entry_2": ["subtag_1", "subtag_2"] // one per penultimate tag in tree + }, }, "products" : [], // list of serialized instances, in order of relevancy } ``` -Check out `products.tests..ProductSearchTest` for a practical case. +Available query parameters: + +- q: used for search [MANDATORY] +- limit: max number of returned instances [OPTIONAL] +- offset: where to start counting results [OPTIONAL] +- shipping_cost: true/false +- discount: true/false +- category: string +- tags: string +- order: string (newest/oldest) + + +Check out `products.tests.ProductSearchTest` for a practical case. ## Massive Data Load Endpoints