about summary refs log tree commit diff stats
path: root/crates/rocie-client/docs/ApiGetRecipeApi.md
blob: a048c340143996b35e4d60760221501a1b646289 (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
<!--
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>.
-->

# \\ApiGetRecipeApi

All URIs are relative to _http://localhost_

| Method                                              | HTTP request               | Description               |
| --------------------------------------------------- | -------------------------- | ------------------------- |
| [**recipe_by_id**](ApiGetRecipeApi.md#recipe_by_id) | **GET** /recipe/by-id/{id} | Get an recipe by it's id. |
| [**recipes**](ApiGetRecipeApi.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.

### 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)

## recipes

> models::Recipe recipes() Get all added recipes

### Parameters

This endpoint does not need any parameter.

### 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)