diff options
Diffstat (limited to 'crates/rocie-client/docs/ApiGetAuthRecipeApi.md')
| -rw-r--r-- | crates/rocie-client/docs/ApiGetAuthRecipeApi.md | 160 |
1 files changed, 140 insertions, 20 deletions
diff --git a/crates/rocie-client/docs/ApiGetAuthRecipeApi.md b/crates/rocie-client/docs/ApiGetAuthRecipeApi.md index 29e2e36..b3fd96c 100644 --- a/crates/rocie-client/docs/ApiGetAuthRecipeApi.md +++ b/crates/rocie-client/docs/ApiGetAuthRecipeApi.md @@ -1,21 +1,29 @@ -# \\ApiGetAuthRecipeApi +# \ApiGetAuthRecipeApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**recipe_by_id**](ApiGetAuthRecipeApi.md#recipe_by_id) | **GET** /recipe/by-id/{id} | Get an recipe by it's id. +[**recipe_by_name**](ApiGetAuthRecipeApi.md#recipe_by_name) | **GET** /recipe/by-name/{name} | Get an recipe by it's name. +[**recipes**](ApiGetAuthRecipeApi.md#recipes) | **GET** /recipe/all | Get all added recipes +[**recipes_by_recipe_parent_id_direct**](ApiGetAuthRecipeApi.md#recipes_by_recipe_parent_id_direct) | **GET** /recipe/by-recipe-parent-id-direct/{id} | Get Recipes by it's recipe parent id +[**recipes_by_recipe_parent_id_indirect**](ApiGetAuthRecipeApi.md#recipes_by_recipe_parent_id_indirect) | **GET** /recipe/by-recipe-parent-id-indirect/{id} | Get Recipes by it's recipe parent id +[**recipes_without_recipe_parent**](ApiGetAuthRecipeApi.md#recipes_without_recipe_parent) | **GET** /recipe/without-recipe-parent | Get Recipes by it's absents of a recipe parent -All URIs are relative to _http://localhost_ -| Method | HTTP request | Description | -| ------------------------------------------------------- | -------------------------- | ------------------------- | -| [**recipe_by_id**](ApiGetAuthRecipeApi.md#recipe_by_id) | **GET** /recipe/by-id/{id} | Get an recipe by it's id. | -| [**recipes**](ApiGetAuthRecipeApi.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. +> 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] | + +Name | Type | Description | Required | Notes +------------- | ------------- | ------------- | ------------- | ------------- +**id** | [**RecipeId**](.md) | Recipe id | [required] | ### Return type @@ -30,14 +38,41 @@ No authorization required - **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) +[[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) + + +## recipe_by_name + +> models::Recipe recipe_by_name(name) +Get an recipe by it's name. + +### Parameters + + +Name | Type | Description | Required | Notes +------------- | ------------- | ------------- | ------------- | ------------- +**name** | **String** | Recipe name | [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 +> Vec<models::Recipe> recipes() +Get all added recipes ### Parameters @@ -45,7 +80,67 @@ This endpoint does not need any parameter. ### Return type -[**models::Recipe**](Recipe.md) +[**Vec<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_by_recipe_parent_id_direct + +> Vec<models::Recipe> recipes_by_recipe_parent_id_direct(id) +Get Recipes by it's recipe parent id + +This will only return recipes directly associated with this recipe parent id + +### Parameters + + +Name | Type | Description | Required | Notes +------------- | ------------- | ------------- | ------------- | ------------- +**id** | [**RecipeParentId**](.md) | Recipe parent id | [required] | + +### Return type + +[**Vec<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_by_recipe_parent_id_indirect + +> Vec<models::Recipe> recipes_by_recipe_parent_id_indirect(id) +Get Recipes by it's recipe parent id + +This will also return all recipes below this recipe parent id + +### Parameters + + +Name | Type | Description | Required | Notes +------------- | ------------- | ------------- | ------------- | ------------- +**id** | [**RecipeParentId**](.md) | Recipe parent id | [required] | + +### Return type + +[**Vec<models::Recipe>**](Recipe.md) ### Authorization @@ -56,7 +151,32 @@ No authorization required - **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) +[[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_without_recipe_parent + +> Vec<models::Recipe> recipes_without_recipe_parent() +Get Recipes by it's absents of a recipe parent + +This will only return recipes without a recipe parent associated with it + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**Vec<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) + |