GHNGPWtk

1{"swagger":"2.0","info":{"description":"This API provides information about dishes and associated programs. Users can request a translation for a given dish and a list of available preparations (i.e. cooking modes). By providing a dish and a preparation the user receives a program recommendation. This recommendation instructs the user how to configure his oven in order to prepare the requested dish. By providing an optional Homeappliance Id and authentication token, the Dish Service will be able to check the available programs and take them into account when creating a recommendation.  ","version":"3.0","title":"Dish Service","contact":{"name":"CULS Project","url":"https://wiki.bsh-sdd.com/display/CULS","email":"Matthias.Roeckl@bshg.com"},"license":{}},"host":"dish-service.hcf-bshg.com","basePath":"/","tags":[{"name":"Dishes","description":"Endpoints dealing with dishes and program recommendations"}],"paths":{"/api/v3/dishes":{"get":{"tags":["Dishes"],"summary":"Find all available dishes","operationId":"findAllDishesUsingGET_1","produces":["application/json"],"parameters":[{"name":"Accept-Language","in":"header","description":"Language for localized assets, Available values : de-DE, en-GB, en-US","required":false,"type":"string","default":"en-US"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Dishes"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}],"deprecated":false}},"/api/v3/dishes/{dishId}":{"get":{"tags":["Dishes"],"summary":"Find a dish for a given dishId","operationId":"findDishUsingGET_1","produces":["application/json"],"parameters":[{"name":"Accept-Language","in":"header","description":"Language for localized assets, Available values : de-DE, en-GB, en-US","required":false,"type":"string","default":"en-US"},{"name":"dishId","in":"path","description":"A dishId is a String identifying a certain dish, e.g. \"Cooking.Dish.Bread\"","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Dish"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}],"deprecated":false}},"/api/v3/dishes/{dishId}/preparations":{"get":{"tags":["Dishes"],"summary":"Find all available preparations for a given dish","operationId":"findDishPreparationsUsingGET_1","produces":["application/json"],"parameters":[{"name":"Accept-Language","in":"header","description":"Language for localized assets, Available values : de-DE, en-GB, en-US","required":false,"type":"string","default":"en-US"},{"name":"dishId","in":"path","description":"A dishId is a String identifying a certain dish, e.g. \"Cooking.Dish.Bread\"","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Preparations"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}],"deprecated":false}},"/api/v3/dishes/{dishId}/preparations/{preparation}":{"get":{"tags":["Dishes"],"summary":"Find a recommended oven program for a given dish and preparation","operationId":"findProgramRecommendationUsingGET_1","produces":["application/json"],"parameters":[{"name":"Accept-Language","in":"header","description":"Language for localized assets, Available values : de-DE, en-GB, en-US","required":false,"type":"string","default":"en-US"},{"name":"X-Homeconnect-Haid","in":"header","description":"Optional Homeappliance Id, becomes required if the recommendation shall be matched with the available programs of a paired HomeConnect account","required":false,"type":"string"},{"name":"X-Homeconnect-Token","in":"header","description":"Optional Oauth Token, becomes required if the recommendation shall be matched with the available programs of a paired HomeConnect account","required":false,"type":"string"},{"name":"dishId","in":"path","description":"A dishId is a String identifying a certain dish, e.g. \"Cooking.Dish.Bread\"","required":false,"type":"string"},{"name":"preparation","in":"path","description":"Determines how the dish should be prepared, e.g. \"COOK\"","required":false,"type":"string","enum":["COOK","REHEAT","DEFROST","FINISH","DEFAULT"]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ProgramRecommendation"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}],"deprecated":false}}},"securityDefinitions":{"basicAuth":{"type":"basic"}},"definitions":{"Dish":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"name":{"type":"string","description":"The translated name"}},"title":"Dish"},"Dishes":{"type":"object","required":["dishes"],"properties":{"dishes":{"type":"array","items":{"$ref":"#/definitions/Dish"}}},"title":"Dishes","description":"Collection of dishes"},"Microwave program recommendation":{"type":"object","required":["durationSeconds","powerWatt","type"],"properties":{"durationSeconds":{"type":"integer","format":"int32"},"powerWatt":{"type":"integer","format":"int32"},"programKey":{"type":"string","description":"Internal Id, HCAPI key if this a HC program"},"programName":{"type":"string","description":"Translated name"},"type":{"type":"string","enum":["FALLBACK","HOMECONNECT","HOMECONNECT_COMBI"]},"weightGrams":{"type":"integer","format":"int32"}},"title":"Microwave program recommendation","description":"A recommendation containing a microwave program"},"Oven program recommendation":{"type":"object","required":["type"],"properties":{"durationSeconds":{"type":"integer","format":"int32"},"meatProbeCoreTempCelsius":{"type":"integer","format":"int32"},"microwavePowerLevelWatt":{"type":"integer","format":"int32"},"programKey":{"type":"string","description":"Internal Id, HCAPI key if this a HC program"},"programName":{"type":"string","description":"Translated name"},"setpointTemperatureCelsius":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["FALLBACK","HOMECONNECT","HOMECONNECT_COMBI"]}},"title":"Oven program recommendation","description":"A recommendation containing an oven program"},"Preparations":{"type":"object","required":["dishId","name","preparations"],"properties":{"dishId":{"type":"string"},"name":{"type":"string"},"preparations":{"type":"array","items":{"type":"string","enum":["COOK","REHEAT","DEFROST","FINISH","DEFAULT"]}}},"title":"Preparations","description":"Collection of available preparations for a dish"},"ProgramRecommendation":{"type":"object","required":["dishId"],"properties":{"dishId":{"type":"string"},"haId":{"type":"string","description":"Optional property is present if the recommendation was created for a certain homeappliance"},"microwavePrograms":{"type":"array","items":{"$ref":"#/definitions/Microwave program recommendation"}},"ovenPrograms":{"type":"array","items":{"$ref":"#/definitions/Oven program recommendation"}},"preparation":{"type":"string","description":"The way how the dish shall be prepared","enum":["COOK","REHEAT","DEFROST","FINISH","DEFAULT"]},"recommendationName":{"type":"string","description":"Translated name"}},"title":"ProgramRecommendation","description":"Result object containing one or more possible program recommendations for a dish"}}}