Skip to content

Commit 05744a6

Browse files
chompfoodschompfoods
authored
Add files via upload
1 parent 706c951 commit 05744a6

File tree

76 files changed

+3612
-203
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+3612
-203
lines changed

‎docs/DefaultApi.md‎

Lines changed: 310 additions & 12 deletions
Large diffs are not rendered by default.

‎docs/RecipeObject.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# IO.Swagger.Model.RecipeObject
2+
## Properties
3+
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**Items** | [**List<RecipeObjectItems>**](RecipeObjectItems.md) | An array containing an object for each individual item returned by your API call. | [optional]
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+

‎docs/RecipeObjectAttributes.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# IO.Swagger.Model.RecipeObjectAttributes
2+
## Properties
3+
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**PrepTime** | **string** | The time it takes to prep this recipe | [optional]
7+
**TotalTime** | **string** | The total time it takes to make this recipe | [optional]
8+
**Servings** | **string** | The number of servings this recipe makes | [optional]
9+
**ServingSize** | **string** | The size of each serving | [optional]
10+
11+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12+

‎docs/RecipeObjectIngredients.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# IO.Swagger.Model.RecipeObjectIngredients
2+
## Properties
3+
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**Quantity** | **string** | The quantity of this ingredient | [optional]
7+
**Description** | **string** | A description of this ingredient | [optional]
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+

‎docs/RecipeObjectItems.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# IO.Swagger.Model.RecipeObjectItems
2+
## Properties
3+
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**Id** | **string** | Unique recipe ID | [optional]
7+
**Title** | **string** | Recipe title | [optional]
8+
**Meta** | [**RecipeObjectMeta**](RecipeObjectMeta.md) | | [optional]
9+
**Categories** | **List<string>** | | [optional]
10+
**Author** | **string** | The author of this recipe. You must attribute this author when displaying this recipe. | [optional]
11+
**Keywords** | **List<string>** | | [optional]
12+
**Topics** | **List<string>** | | [optional]
13+
**Attributes** | [**RecipeObjectAttributes**](RecipeObjectAttributes.md) | | [optional]
14+
**Ingredients** | [**List<RecipeObjectIngredients>**](RecipeObjectIngredients.md) | An array containing this recipe's ingredients | [optional]
15+
**BaseIngredients** | **List<string>** | | [optional]
16+
**Nutrients** | [**RecipeObjectNutrients**](RecipeObjectNutrients.md) | | [optional]
17+
**DiabeticExchanges** | **List<string>** | | [optional]
18+
19+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
20+

‎docs/RecipeObjectMeta.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# IO.Swagger.Model.RecipeObjectMeta
2+
## Properties
3+
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**Url** | **string** | URL to the recipe. You must link back to the recipe when displaying it. | [optional]
7+
**Images** | [**RecipeObjectMetaImages**](RecipeObjectMetaImages.md) | | [optional]
8+
**Source** | **string** | The source of the recipe. You must attribute this source when displaying this recipe. | [optional]
9+
**Cuisine** | **string** | This recipe's cuisine | [optional]
10+
**Created** | **string** | The date when this recipe was created | [optional]
11+
**Modified** | **string** | The date when this recipe was most recently modified | [optional]
12+
**NutrientsNotice** | **string** | Additional information about this recipe's nutrients | [optional]
13+
14+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15+

‎docs/RecipeObjectMetaImages.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# IO.Swagger.Model.RecipeObjectMetaImages
2+
## Properties
3+
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**ExtraLarge** | **string** | Extra large recipe image | [optional]
7+
**Large** | **string** | Large recipe image | [optional]
8+
**Standard** | **string** | Standard recipe image | [optional]
9+
**GridView** | **string** | Grid view recipe image | [optional]
10+
**Small** | **string** | Small recipe image | [optional]
11+
**Thumbnail** | **string** | Thumbnail recipe image | [optional]
12+
**ExtraSmall** | **string** | Extra small recipe image | [optional]
13+
14+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15+

‎docs/RecipeObjectNutrients.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# IO.Swagger.Model.RecipeObjectNutrients
2+
## Properties
3+
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**Calories** | [**List<RecipeObjectNutrientsCalories>**](RecipeObjectNutrientsCalories.md) | An array containing information for calories found in this recipe | [optional]
7+
**DailyValues** | [**List<RecipeObjectNutrientsCalories>**](RecipeObjectNutrientsCalories.md) | An array containing information for this recipe's daily recommended value of certain nutrients | [optional]
8+
**Fat** | [**List<RecipeObjectNutrientsCalories>**](RecipeObjectNutrientsCalories.md) | An array containing information for fat found in this recipe | [optional]
9+
**Carbs** | [**List<RecipeObjectNutrientsCalories>**](RecipeObjectNutrientsCalories.md) | An array containing information for carbs found in this recipe | [optional]
10+
**Vitamins** | [**List<RecipeObjectNutrientsCalories>**](RecipeObjectNutrientsCalories.md) | An array containing information for vitamins found in this recipe | [optional]
11+
12+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13+

‎docs/RecipeObjectNutrientsCalories.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# IO.Swagger.Model.RecipeObjectNutrientsCalories
2+
## Properties
3+
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**Title** | **string** | Nutrient name | [optional]
7+
**Value** | **string** | The amount of this nutrient in this recipe | [optional]
8+
**Percent** | **string** | The daily recommended percent total for this nutrient | [optional]
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+

‎src/IO.Swagger.Test/Api/DefaultApiTests.cs‎

Lines changed: 67 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
2-
* Chomp Food Database API Documentation
2+
* Chomp Food & Recipe Database API Documentation
33
*
4-
* ## Important An **[API key](https://chompthis.com/api/)** is required for access to this API. Get yours at **[https://chompthis.com/api](https://chompthis.com/api/)**. ### Getting Started * **[Subscribe](https://chompthis.com/api/#pricing)** to the API. * Scroll down and click the \"**Authorize**\" button. * Enter your API key into the \"**value**\" input, click the \"**Authorize**\" button, then click the \"**Close**\" button. * Scroll down to the section titled \"**default**\" and click on the API endpoint you wish to use. * Click the \"**Try it out**\" button. * Enter the information the endpoint requires. * Click the \"**Execute**\" button. ### Example * Branded food response object: **[View example »](https://raw.githubusercontent.com/chompfoods/examples/master/branded-food-response-object.json)** * Ingredient response object: **[View example »](https://raw.githubusercontent.com/chompfoods/examples/master/ingredient-response-object.json)** * Error response object: **[View example »](https://raw.githubusercontent.com/chompfoods/examples/master/error-response-object.json)** ### How Do I Find My API Key? * Your API key was sent to the email address you used to create your subscription. * You will also find your API key in the **[Client Center](https://chompthis.com/api/manage.php)**. * Read **[this article](https://desk.zoho.com/portal/chompthis/kb/articles/how-do-i-find-my-api-key)** for more information. ### Helpful Links * **Help & Support** * [Knowledge Base »](https://desk.zoho.com/portal/chompthis/kb/chomp) * [Support »](https://chompthis.com/api/ticket-new.php) * [Client Center »](https://chompthis.com/api/manage.php) * **Pricing** * [Subscription Options »](https://chompthis.com/api/) * [Cost Calculator »](https://chompthis.com/api/cost-calculator.php) * **Guidelines** * [Terms & License »](https://chompthis.com/api/terms.php) * [Attribution »](https://chompthis.com/api/docs/attribution.php)
4+
* ## Important An **[API key](https://chompthis.com/api/)** is required for access to this API. * Get a **Food Data API** key at **[https://chompthis.com/api](https://chompthis.com/api/)**. * Get a **Recipe Data API** key at **[https://chompthis.com/api/recipes](https://chompthis.com/api/recipes/)**. ### Getting Started * Subscribe to the **[Food Data API](https://chompthis.com/api/#pricing)** or the **[Recipe Data API](https://chompthis.com/api/recipes/#pricing)**. * Scroll down and click the \"**Authorize**\" button. * Enter your API key into the \"**value**\" input, click the \"**Authorize**\" button, then click the \"**Close**\" button. * Scroll down to the section titled \"**default**\" and click on the API endpoint you wish to use. * Click the \"**Try it out**\" button. * Enter the information the endpoint requires. * Click the \"**Execute**\" button. ### Example * Branded food response object: **[View example »](https://raw.githubusercontent.com/chompfoods/examples/master/branded-food-response-object.json)** * Ingredient response object: **[View example »](https://raw.githubusercontent.com/chompfoods/examples/master/ingredient-response-object.json)** * Recipe response object: **[View example »](https://raw.githubusercontent.com/chompfoods/examples/master/example-recipe-response.json)** * Error response object: **[View example »](https://raw.githubusercontent.com/chompfoods/examples/master/error-response-object.json)** ### How Do I Find My API Key? * Your API key was sent to the email address you used to create your subscription. * You will also find your API key in the **[Client Center](https://chompthis.com/api/manage.php)**. * Read **[this article](https://desk.zoho.com/portal/chompthis/kb/articles/how-do-i-find-my-api-key)** for more information. ### I'm a Premium subscriber. How do I access the API? * All Premium subscribers must pass in a unique user ID for each user on their platform that is accessing data from the Chomp API. A user ID can be any string of letters and numbers that you assign to your user. Simply add \"user_id\" as a URL parameter when calling the API. *You must add a \"user_id\" URL parameter to every call you make to ANY endpoint.* * **Example** > ```ENDPOINT.php?api_key=API_KEY&code=CODE&user_id=USER_ID``` ### Helpful Links * **Help & Support** * [Knowledge Base »](https://desk.zoho.com/portal/chompthis/kb/chomp) * [Support »](https://chompthis.com/api/ticket-new.php) * [Client Center »](https://chompthis.com/api/manage.php) * **Pricing** * [Food Data API Subscription Options »](https://chompthis.com/api/) * [Recipe Data API Subscription Options »](https://chompthis.com/api/recipes/) * [Food Data API Cost Calculator »](https://chompthis.com/api/cost-calculator.php) * [Recipe Data API Cost Calculator »](https://chompthis.com/api/recipes/cost-calculator.php) * **Guidelines** * [Terms & License »](https://chompthis.com/api/terms.php) * [Attribution »](https://chompthis.com/api/docs/attribution.php)
55
*
66
* OpenAPI spec version: 1.0.0-oas3
77
*
@@ -70,7 +70,8 @@ public void FoodBrandedBarcodePhpGetTest()
7070
{
7171
// TODO uncomment below to test the method and replace null with proper value
7272
//string code = null;
73-
//var response = instance.FoodBrandedBarcodePhpGet(code);
73+
//string userId = null;
74+
//var response = instance.FoodBrandedBarcodePhpGet(code, userId);
7475
//Assert.IsInstanceOf<BrandedFoodObject> (response, "response is BrandedFoodObject");
7576
}
7677
/// <summary>
@@ -83,7 +84,8 @@ public void FoodBrandedNamePhpGetTest()
8384
//string name = null;
8485
//int? limit = null;
8586
//int? page = null;
86-
//var response = instance.FoodBrandedNamePhpGet(name, limit, page);
87+
//string userId = null;
88+
//var response = instance.FoodBrandedNamePhpGet(name, limit, page, userId);
8789
//Assert.IsInstanceOf<BrandedFoodObject> (response, "response is BrandedFoodObject");
8890
}
8991
/// <summary>
@@ -107,7 +109,8 @@ public void FoodBrandedSearchPhpGetTest()
107109
//string vitamin = null;
108110
//int? limit = null;
109111
//int? page = null;
110-
//var response = instance.FoodBrandedSearchPhpGet(allergen, brand, category, country, diet, ingredient, keyword, mineral, nutrient, palmOil, trace, vitamin, limit, page);
112+
//string userId = null;
113+
//var response = instance.FoodBrandedSearchPhpGet(allergen, brand, category, country, diet, ingredient, keyword, mineral, nutrient, palmOil, trace, vitamin, limit, page, userId);
111114
//Assert.IsInstanceOf<BrandedFoodObject> (response, "response is BrandedFoodObject");
112115
}
113116
/// <summary>
@@ -119,9 +122,67 @@ public void FoodIngredientSearchPhpGetTest()
119122
// TODO uncomment below to test the method and replace null with proper value
120123
//string find = null;
121124
//int? limit = null;
122-
//var response = instance.FoodIngredientSearchPhpGet(find, limit);
125+
//string userId = null;
126+
//var response = instance.FoodIngredientSearchPhpGet(find, limit, userId);
123127
//Assert.IsInstanceOf<IngredientObject> (response, "response is IngredientObject");
124128
}
129+
/// <summary>
130+
/// Test RecipeIdPhpGet
131+
/// </summary>
132+
[Test]
133+
public void RecipeIdPhpGetTest()
134+
{
135+
// TODO uncomment below to test the method and replace null with proper value
136+
//string id = null;
137+
//string userId = null;
138+
//var response = instance.RecipeIdPhpGet(id, userId);
139+
//Assert.IsInstanceOf<RecipeObject> (response, "response is RecipeObject");
140+
}
141+
/// <summary>
142+
/// Test RecipeIngredientPhpGet
143+
/// </summary>
144+
[Test]
145+
public void RecipeIngredientPhpGetTest()
146+
{
147+
// TODO uncomment below to test the method and replace null with proper value
148+
//string list = null;
149+
//int? limit = null;
150+
//int? page = null;
151+
//string userId = null;
152+
//var response = instance.RecipeIngredientPhpGet(list, limit, page, userId);
153+
//Assert.IsInstanceOf<RecipeObject> (response, "response is RecipeObject");
154+
}
155+
/// <summary>
156+
/// Test RecipeRandomPhpGet
157+
/// </summary>
158+
[Test]
159+
public void RecipeRandomPhpGetTest()
160+
{
161+
// TODO uncomment below to test the method and replace null with proper value
162+
//int? limit = null;
163+
//string userId = null;
164+
//var response = instance.RecipeRandomPhpGet(limit, userId);
165+
//Assert.IsInstanceOf<RecipeObject> (response, "response is RecipeObject");
166+
}
167+
/// <summary>
168+
/// Test RecipeSearchPhpGet
169+
/// </summary>
170+
[Test]
171+
public void RecipeSearchPhpGetTest()
172+
{
173+
// TODO uncomment below to test the method and replace null with proper value
174+
//string title = null;
175+
//string excludedCuisine = null;
176+
//string includedCuisine = null;
177+
//string excludedIngredient = null;
178+
//string includedIngredient = null;
179+
//int? nutrientsRequired = null;
180+
//int? limit = null;
181+
//int? page = null;
182+
//string userId = null;
183+
//var response = instance.RecipeSearchPhpGet(title, excludedCuisine, includedCuisine, excludedIngredient, includedIngredient, nutrientsRequired, limit, page, userId);
184+
//Assert.IsInstanceOf<RecipeObject> (response, "response is RecipeObject");
185+
}
125186
}
126187

127188
}

0 commit comments

Comments
 (0)