ClaytonWWilson/Listify
1
0
Fork 0
mirror of https://github.com/ClaytonWWilson/Listify.git synced 2025-12-13 09:48:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add ItemSearch readme

Browse Source
This commit is contained in:
Nathan Merz 2020-12-03 21:01:42 -05:00 committed by GitHub
parent f4d823f096
commit 042679d4a9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Lambdas/Lists/ItemSearch/README.md Normal file
View File

@ -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)