From 042679d4a995c1f811e6321fab2f615164daa15e Mon Sep 17 00:00:00 2001 From: Nathan Merz Date: Thu, 3 Dec 2020 21:01:42 -0500 Subject: [PATCH] Add ItemSearch readme --- Lambdas/Lists/ItemSearch/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 Lambdas/Lists/ItemSearch/README.md diff --git a/Lambdas/Lists/ItemSearch/README.md b/Lambdas/Lists/ItemSearch/README.md new file mode 100644 index 0000000..b87c856 --- /dev/null +++ b/Lambdas/Lists/ItemSearch/README.md @@ -0,0 +1,17 @@ +# ItemSearch Module +Deals with retrieving aggregate product information meeting certain naming criterion from among that populated by the scripts at https://github.com/ClaytonWWilson/Listify/blob/master/Lambdas/APIs and https://github.com/ClaytonWWilson/Listify/tree/master/Lambdas/Scraping. + +### ItemGET +#### Expected request body: +N/A + +#### Expected query parameters: + - id + - Used for specifying a substing of the product name that returned items should mathc + - Valid values: {any_string} + +#### Inputs and outputs: + - id = {any string}: Returns an [ItemSearch object](https://github.com/ClaytonWWilson/Listify/blob/master/Lambdas/Lists/ItemSearch/src/ItemSearch.java), which is basically an array of productIDs, for products whose name fits the regex criterion `name = ".*" + id + ".*"` + - Results are limited to the first 100 entries from the database (by earliest add time) + +