-
Notifications
You must be signed in to change notification settings - Fork 0
/
model_branded_food_object_diet_flags.go
27 lines (26 loc) · 4.32 KB
/
model_branded_food_object_diet_flags.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
/*
* Chomp Food & Recipe Database API Documentation
*
* ## 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)
*
* API version: 1.0.0-oas3
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
*/
package swagger
// An object containing information on an individual ingredient that was flagged as potentially not being compatible with a certain diet
type BrandedFoodObjectDietFlags struct {
// Ingredient name
Ingredient string `json:"ingredient,omitempty"`
// Description of the ingredient
IngredientDescription string `json:"ingredient_description,omitempty"`
// Name of the diet with which this ingredient may not be compatible
DietLabel string `json:"diet_label,omitempty"`
// A description of if we believe this ingredient is compatible with the diet
IsCompatible string `json:"is_compatible,omitempty"`
// A numeric representation of if we believe this ingredient is compatible with the diet. Higher values indicate more compatibility
CompatibilityLevel int32 `json:"compatibility_level,omitempty"`
// A description of how we graded this ingredient for compatibility with the diet
CompatibilityDescription string `json:"compatibility_description,omitempty"`
// Boolean representing if the ingredient is a known allergen
IsAllergen bool `json:"is_allergen,omitempty"`
}