blob: b3fd96ccd1b88c7d37ee580061e75a5e06bd3973 (
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
# \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.
### 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)
## 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
> Vec<models::Recipe> recipes()
Get all added recipes
### 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)
## 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
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_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)
|
