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

# \\ApiGetNoAuthUserApi

All URIs are relative to _http://localhost_

| Method                                              | HTTP request       | Description                 |
| --------------------------------------------------- | ------------------ | --------------------------- |
| [**user_by_id**](ApiGetNoAuthUserApi.md#user_by_id) | **GET** /user/{id} | Get an specific user by id. |
| [**users**](ApiGetNoAuthUserApi.md#users)           | **GET** /users     | Get all registered users.   |

## user_by_id

> models::User user_by_id(id) Get an specific user by id.

### Parameters

| Name   | Type              | Description | Required   | Notes |
| ------ | ----------------- | ----------- | ---------- | ----- |
| **id** | [**UserId**](.md) | User id     | [required] |

### Return type

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

## users

> Vec<models::User> users() Get all registered users.

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::User>**](User.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth)

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