about summary refs log tree commit diff stats
path: root/crates/rocie-client/docs/Recipe.md
blob: 7cf33df4d8b0687875d5fada38a65f7c94492753 (plain) (blame)
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
<!--
rocie - An enterprise grocery management system

Copyright (C) 2026 Benedikt Peetz <benedikt.peetz@b-peetz.de>
SPDX-License-Identifier: GPL-3.0-or-later

This file is part of Rocie.

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>.
-->

# Recipe

## Properties

| Name        | Type                                                     | Description                                                                                                                                       | Notes      |
| ----------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| **content** | [**models::CooklangRecipe**](CooklangRecipe.md)          | The actual content of this recipe.                                                                                                                |
| **id**      | [**models::RecipeId**](RecipeId.md)                      | The unique id of this recipe.                                                                                                                     |
| **name**    | **String**                                               | The name of the recipe. This should be globally unique, to make searching easier for the user.                                                    |
| **parent**  | Option\<[**models::RecipeParentId**](RecipeParentId.md)> | The parent this recipe has. This is effectively it's anchor in the recipe DAG. None means, that it has no parents and as such is in the toplevel. | [optional] |

[[Back to Model list]](../README.md#documentation-for-models)
[[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to README]](../README.md)