You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: api/default.service.ts
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -112,8 +112,8 @@ export class DefaultService {
112
112
* Get a branded food item by name
113
113
* ## Search for branded food items by name. **Example** > ```https://chompthis.com/api/v2/food/branded/name.php?api_key=API_KEY&name=NAME``` **Tips** * Get started by using our **[food lookup tool](https://chompthis.com/api/lookup.php)**. > This API endpoint is only available to Standard and Premium API subscribers. Please consider upgrading your subscription if you are subscribed to the Limited plan. **[Read this](https://desk.zoho.com/portal/chompthis/kb/articles/can-i-upgrade-downgrade-my-subscription)** if you aren't sure how to upgrade your subscription.
114
114
* @param name #### Search for branded food items using a general food name keyword. This does not have to exactly match the \"official\" name for the food. **Example** > ```&name=Starburst```
115
-
* @param limit #### Set maximum number of records you want the API to return. **Example** > ```&limit=10```
116
-
* @param page #### This is how you paginate the search result. By default, you will see the first 10 records. You must increment the page number to access the next 10 records, and so on. **Example** > ```&page=1```
115
+
* @param limit #### Set maximum number of records you want the API to return. The default value is \"**10**.\" **Example** > ```&limit=10```
116
+
* @param page #### This is how you paginate the search result. By default, you will see the first 10 records. You must increment the page number to access the next 10 records, and so on. The default value is \"**1**.\" **Example** > ```&page=1```
117
117
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
118
118
* @param reportProgress flag to report request and response progress.
119
119
*/
@@ -185,8 +185,8 @@ export class DefaultService {
185
185
* @param palmOil #### Filter the search to only include branded foods that contain a specific ingredient made using palm oil. **Example** > ```&palm_oil=E160a Beta Carotene```
186
186
* @param trace ### Filter the search to only include branded foods that contain a specific trace ingredient. **Example** > ```&trace=Tree Nuts``` **Important Note**: This parameter cannot be used alone. It must be paired with at least 1 additional parameter.
187
187
* @param vitamin #### Filter the search to only include branded foods that contain a specific vitamin. **Example** > ```&vitamin=Biotin```
188
-
* @param limit #### Set maximum number of records you want the API to return. **Example** > ```&limit=10```
189
-
* @param page #### This is how you paginate the search result. By default, you will see the first 10 records. You must increment the page number to access the next 10 records, and so on. **Example** > ```&page=1```
188
+
* @param limit #### Set maximum number of records you want the API to return. The default value is \"**10**.\" **Example** > ```&limit=10```
189
+
* @param page #### This is how you paginate the search result. By default, you will see the first 10 records. You must increment the page number to access the next 10 records, and so on. The default value is \"**1**.\" **Example** > ```&page=1```
190
190
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
191
191
* @param reportProgress flag to report request and response progress.
192
192
*/
@@ -288,8 +288,8 @@ export class DefaultService {
288
288
* Get raw/generic food ingredient item(s)
289
289
* ## Get data for a specific ingredient or a specific set of ingredients. **Example #1: Single Ingredient** > ```https://chompthis.com/api/v2/ingredient/search.php?api_key=API_KEY&find=broccoli``` **Example #2: Set of Ingredients** > ```https://chompthis.com/api/v2/ingredient/search.php?api_key=API_KEY&find=broccoli,cauliflower,spinach``` **Tips** * Expose ingredient endpoints by using our **[food lookup tool](https://chompthis.com/api/lookup.php)**. > This API endpoint is only available to Standard and Premium API subscribers. Please consider upgrading your subscription if you are subscribed to the Limited plan. **[Read this](https://desk.zoho.com/portal/chompthis/kb/articles/can-i-upgrade-downgrade-my-subscription)** if you aren't sure how to upgrade your subscription.
290
290
* @param find Search our database for a single ingredient or a specific set of ingredients. **Example #1: Single Ingredient** > ```&find=broccoli``` **Example #2: Set of Ingredients** > ```&find=broccoli,cauliflower,spinach``` **Important Notes** * Comma-separated lists cannot contain more than **15 ingredients**. You must perform additional API calls if you are looking up more than 15 ingredients.
291
-
* @param raw #### Optionally filter the search result to only include raw ingredients. **Example** > ```&raw=true```
292
-
* @param limit #### Set maximum number of records you want the API to return, per search term. **Example** > ```&limit=3```
291
+
* @param raw #### Optionally filter the search result to only include raw ingredients. The default value is \"**false**.\" **Example** > ```&raw=true```
292
+
* @param limit #### Set maximum number of records you want the API to return, per search term. The default value is \"**1**.\" **Example** > ```&limit=3```
293
293
* @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
294
294
* @param reportProgress flag to report request and response progress.
0 commit comments