diff options
| author | Benedikt Peetz <benedikt.peetz@b-peetz.de> | 2026-02-15 22:25:39 +0100 |
|---|---|---|
| committer | Benedikt Peetz <benedikt.peetz@b-peetz.de> | 2026-02-15 22:25:39 +0100 |
| commit | b467f7202f5c0c3970e39ea396a0cec0fd6a36ee (patch) | |
| tree | aa567f84f0c2891d03de5b6414507c2d9a5f4754 /crates/rocie-client/docs/ApiSetNoAuthUserApi.md | |
| parent | feat(treewide): Add recipes and user handling (diff) | |
| download | server-b467f7202f5c0c3970e39ea396a0cec0fd6a36ee.zip | |
chore(rocie-client): Re-generate the client api
Diffstat (limited to 'crates/rocie-client/docs/ApiSetNoAuthUserApi.md')
| -rw-r--r-- | crates/rocie-client/docs/ApiSetNoAuthUserApi.md | 61 |
1 files changed, 31 insertions, 30 deletions
diff --git a/crates/rocie-client/docs/ApiSetNoAuthUserApi.md b/crates/rocie-client/docs/ApiSetNoAuthUserApi.md index 4cfc846..f532533 100644 --- a/crates/rocie-client/docs/ApiSetNoAuthUserApi.md +++ b/crates/rocie-client/docs/ApiSetNoAuthUserApi.md @@ -1,26 +1,30 @@ -# \\ApiSetNoAuthUserApi +# \ApiSetNoAuthUserApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**login**](ApiSetNoAuthUserApi.md#login) | **POST** /login | Log in as a specific user +[**logout**](ApiSetNoAuthUserApi.md#logout) | **POST** /logout | Log the current user out +[**provision**](ApiSetNoAuthUserApi.md#provision) | **POST** /provision | Provision this instance. -All URIs are relative to _http://localhost_ -| Method | HTTP request | Description | -| ------------------------------------------------- | ------------------- | ------------------------- | -| [**login**](ApiSetNoAuthUserApi.md#login) | **POST** /login | Log in as a specific user | -| [**logout**](ApiSetNoAuthUserApi.md#logout) | **POST** /logout | Log the current user out | -| [**provision**](ApiSetNoAuthUserApi.md#provision) | **POST** /provision | Provision this instance. | ## login -> login(login_info) Log in as a specific user +> login(login_info) +Log in as a specific user ### Parameters -| Name | Type | Description | Required | Notes | -| -------------- | ----------------------------- | ----------- | ---------- | ----- | -| **login_info** | [**LoginInfo**](LoginInfo.md) | | [required] | + +Name | Type | Description | Required | Notes +------------- | ------------- | ------------- | ------------- | ------------- +**login_info** | [**LoginInfo**](LoginInfo.md) | | [required] | ### Return type -(empty response body) + (empty response body) ### Authorization @@ -31,14 +35,13 @@ No authorization required - **Content-Type**: application/json - **Accept**: 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) +[[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) + ## logout -> logout() Log the current user out +> logout() +Log the current user out ### Parameters @@ -46,7 +49,7 @@ This endpoint does not need any parameter. ### Return type -(empty response body) + (empty response body) ### Authorization @@ -57,22 +60,22 @@ No authorization required - **Content-Type**: Not defined - **Accept**: 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) +[[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) + ## provision -> models::UserId provision(user_stub) Provision this instance. +> models::UserId provision(user_stub) +Provision this instance. This only works, if no users exist yet. ### Parameters -| Name | Type | Description | Required | Notes | -| ------------- | --------------------------- | ----------- | ---------- | ----- | -| **user_stub** | [**UserStub**](UserStub.md) | | [required] | + +Name | Type | Description | Required | Notes +------------- | ------------- | ------------- | ------------- | ------------- +**user_stub** | [**UserStub**](UserStub.md) | | [required] | ### Return type @@ -87,7 +90,5 @@ No authorization required - **Content-Type**: application/json - **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) +[[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) + |