diff options
| author | Benedikt Peetz <benedikt.peetz@b-peetz.de> | 2025-12-09 13:12:31 +0100 |
|---|---|---|
| committer | Benedikt Peetz <benedikt.peetz@b-peetz.de> | 2025-12-09 13:12:31 +0100 |
| commit | 7565c34d69ee259fef3ac9813d689d97689a6d58 (patch) | |
| tree | ee4f00e3d090ec288d481cc92781e55637619824 /crates/rocie-client/docs/ApiSetNoAuthUserApi.md | |
| parent | feat(rocie-server): Implement basic user handling and authentication (diff) | |
| download | server-7565c34d69ee259fef3ac9813d689d97689a6d58.zip | |
style(rocie-client): Format
Diffstat (limited to 'crates/rocie-client/docs/ApiSetNoAuthUserApi.md')
| -rw-r--r-- | crates/rocie-client/docs/ApiSetNoAuthUserApi.md | 61 |
1 files changed, 30 insertions, 31 deletions
diff --git a/crates/rocie-client/docs/ApiSetNoAuthUserApi.md b/crates/rocie-client/docs/ApiSetNoAuthUserApi.md index f532533..4cfc846 100644 --- a/crates/rocie-client/docs/ApiSetNoAuthUserApi.md +++ b/crates/rocie-client/docs/ApiSetNoAuthUserApi.md @@ -1,30 +1,26 @@ -# \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. +# \\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. | ## 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 @@ -35,13 +31,14 @@ 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 @@ -49,7 +46,7 @@ This endpoint does not need any parameter. ### Return type - (empty response body) +(empty response body) ### Authorization @@ -60,22 +57,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 @@ -90,5 +87,7 @@ 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) |