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

Create README.md

Browse Source
This commit is contained in:
Nathan Merz 2020-12-03 20:52:33 -05:00 committed by GitHub
parent d56fed35a0
commit 3ea118ace2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Lambdas/Lists/Item/README.md Normal file
View File

@ -0,0 +1,18 @@
# Item Module
Deals with retrieving product information 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 which product to retrieve. This is not the upc, but is our own internal id.
- Valid values: 1<n<{num_products}*
#### Inputs and outputs:
- id = 1<n<{num_products}*: Returns an [Item object](https://github.com/ClaytonWWilson/Listify/blob/master/Lambdas/Lists/Item/src/Item.java) for the products with productID=id \
\*Not all number in this range are valid because a seemingly random subset were removed by deduplication scripts and during new product addition testing.