kit-eco.social/consumocuidado-server
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

readme update

Browse Source
This commit is contained in:
Sam
2021-02-25 12:32:26 +00:00
parent 38ec6b343a
commit 0faaacc415
1 changed files with 23 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@@ -222,16 +222,35 @@ Response format:
```json ```json
{ {
"filters": { "filters": {
"singles": ["tag1", "tag2"], // for tags that aren't nested "tags": {
"entry_1": ["subtag_1", "subtag_2"], // for tree tags like entry_1/subtag_1 "singles": ["tag1", "tag2"], // for tags that aren't nested
"entry_2": ["subtag_1", "subtag_2"] // one per penultimate tag in tree "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 "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 ## Massive Data Load Endpoints