aboutsummaryrefslogtreecommitdiffstats
path: root/crates/rocie-client/docs/ApiGetAuthRecipeApi.md
diff options
context:
space:
mode:
authorBenedikt Peetz <benedikt.peetz@b-peetz.de>2026-03-19 05:41:14 +0100
committerBenedikt Peetz <benedikt.peetz@b-peetz.de>2026-03-19 05:41:14 +0100
commitca5c852c5091d7923cc5b1dabf1af5581c459fd1 (patch)
tree105a78beb6ca6074d49e1c0cdc066883518d7ea1 /crates/rocie-client/docs/ApiGetAuthRecipeApi.md
parentchore(LICENSES/GPL-3.0-or-later): Add (diff)
downloadserver-ca5c852c5091d7923cc5b1dabf1af5581c459fd1.zip
chore(rocie-{server,client}): Format code
Diffstat (limited to '')
-rw-r--r--crates/rocie-client/docs/ApiGetAuthRecipeApi.md107
1 files changed, 55 insertions, 52 deletions
diff --git a/crates/rocie-client/docs/ApiGetAuthRecipeApi.md b/crates/rocie-client/docs/ApiGetAuthRecipeApi.md
index fdd832e..f690fbf 100644
--- a/crates/rocie-client/docs/ApiGetAuthRecipeApi.md
+++ b/crates/rocie-client/docs/ApiGetAuthRecipeApi.md
@@ -10,32 +10,28 @@ You should have received a copy of the License along with this program.
If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>.
-->
-# \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
+# \\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 |
## 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
@@ -50,20 +46,20 @@ 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.
+> models::Recipe recipe_by_name(name) Get an recipe by it's name.
### Parameters
-
-Name | Type | Description | Required | Notes
-------------- | ------------- | ------------- | ------------- | -------------
-**name** | **String** | Recipe name | [required] |
+| Name | Type | Description | Required | Notes |
+| -------- | ---------- | ----------- | ---------- | ----- |
+| **name** | **String** | Recipe name | [required] |
### Return type
@@ -78,13 +74,14 @@ 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
-> Vec<models::Recipe> recipes()
-Get all added recipes
+> Vec<models::Recipe> recipes() Get all added recipes
### Parameters
@@ -103,22 +100,23 @@ 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_by_recipe_parent_id_direct
-> Vec<models::Recipe> recipes_by_recipe_parent_id_direct(id)
-Get Recipes by it's recipe parent id
+> 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] |
+| Name | Type | Description | Required | Notes |
+| ------ | ------------------------- | ---------------- | ---------- | ----- |
+| **id** | [**RecipeParentId**](.md) | Recipe parent id | [required] |
### Return type
@@ -133,22 +131,23 @@ 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_by_recipe_parent_id_indirect
-> Vec<models::Recipe> recipes_by_recipe_parent_id_indirect(id)
-Get Recipes by it's recipe parent id
+> 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] |
+| Name | Type | Description | Required | Notes |
+| ------ | ------------------------- | ---------------- | ---------- | ----- |
+| **id** | [**RecipeParentId**](.md) | Recipe parent id | [required] |
### Return type
@@ -163,13 +162,15 @@ 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
+> 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
@@ -190,5 +191,7 @@ 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)