about summary refs log tree commit diff stats
path: root/crates/rocie-client/docs/ApiGetAuthRecipeParentApi.md
blob: fa5bb8938c5c10d8529296923f47cbc99dc3b8af (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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
<!--
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>.
-->

# \\ApiGetAuthRecipeParentApi

All URIs are relative to _http://localhost_

| Method                                                                              | HTTP request                       | Description                                                           |
| ----------------------------------------------------------------------------------- | ---------------------------------- | --------------------------------------------------------------------- |
| [**recipe_parents**](ApiGetAuthRecipeParentApi.md#recipe_parents)                   | **GET** /recipe_parents/           | Return all registered recipe parents                                  |
| [**recipe_parents_toplevel**](ApiGetAuthRecipeParentApi.md#recipe_parents_toplevel) | **GET** /recipe_parents_toplevel/  | Return all registered recipe parents, that have no parents themselves |
| [**recipe_parents_under**](ApiGetAuthRecipeParentApi.md#recipe_parents_under)       | **GET** /recipe_parents_under/{id} | Return all parents, that have this parent as parent                   |

## recipe_parents

> Vec<models::RecipeParent> recipe_parents() Return all registered recipe
> parents

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::RecipeParent>**](RecipeParent.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)

## recipe_parents_toplevel

> Vec<models::RecipeParent> recipe_parents_toplevel() Return all registered
> recipe parents, that have no parents themselves

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::RecipeParent>**](RecipeParent.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)

## recipe_parents_under

> Vec<models::RecipeParent> recipe_parents_under(id) Return all parents, that
> have this parent as parent

### Parameters

| Name   | Type                      | Description      | Required   | Notes |
| ------ | ------------------------- | ---------------- | ---------- | ----- |
| **id** | [**RecipeParentId**](.md) | Recipe parent id | [required] |

### Return type

[**Vec<models::RecipeParent>**](RecipeParent.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)