diff options
Diffstat (limited to 'crates/rocie-client/docs/ApiGetRecipeApi.md')
| -rw-r--r-- | crates/rocie-client/docs/ApiGetRecipeApi.md | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/crates/rocie-client/docs/ApiGetRecipeApi.md b/crates/rocie-client/docs/ApiGetRecipeApi.md new file mode 100644 index 0000000..cce6112 --- /dev/null +++ b/crates/rocie-client/docs/ApiGetRecipeApi.md @@ -0,0 +1,63 @@ +# \ApiGetRecipeApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**recipe_by_id**](ApiGetRecipeApi.md#recipe_by_id) | **GET** /recipe/by-id/{id} | Get an recipe by it's id. +[**recipes**](ApiGetRecipeApi.md#recipes) | **GET** /recipe/all | Get all added recipes + + + +## recipe_by_id + +> models::Recipe recipe_by_id(id) +Get an recipe by it's id. + +### Parameters + + +Name | Type | Description | Required | Notes +------------- | ------------- | ------------- | ------------- | ------------- +**id** | [**RecipeId**](.md) | Recipe id | [required] | + +### Return type + +[**models::Recipe**](Recipe.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json, text/plain + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +## recipes + +> models::Recipe recipes() +Get all added recipes + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**models::Recipe**](Recipe.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json, text/plain + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + |
