about summary refs log tree commit diff stats
path: root/crates/rocie-client/docs/ApiGetUnitApi.md
diff options
context:
space:
mode:
authorBenedikt Peetz <benedikt.peetz@b-peetz.de>2025-09-06 18:31:40 +0200
committerBenedikt Peetz <benedikt.peetz@b-peetz.de>2025-09-06 18:31:40 +0200
commit1c09b0eb5db415985bfefb52786dbe48d757665e (patch)
treedb1cdbcff8baae9a73fca34e14b52cb8cf7ff230 /crates/rocie-client/docs/ApiGetUnitApi.md
parentfeat: Provide basic API frame (diff)
downloadserver-1c09b0eb5db415985bfefb52786dbe48d757665e.zip
feat: Provide basic barcode handling support
Diffstat (limited to 'crates/rocie-client/docs/ApiGetUnitApi.md')
-rw-r--r--crates/rocie-client/docs/ApiGetUnitApi.md63
1 files changed, 63 insertions, 0 deletions
diff --git a/crates/rocie-client/docs/ApiGetUnitApi.md b/crates/rocie-client/docs/ApiGetUnitApi.md
new file mode 100644
index 0000000..3ac44c0
--- /dev/null
+++ b/crates/rocie-client/docs/ApiGetUnitApi.md
@@ -0,0 +1,63 @@
+# \ApiGetUnitApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**unit_by_id**](ApiGetUnitApi.md#unit_by_id) | **GET** /unit/{id} | Get Unit by id
+[**units**](ApiGetUnitApi.md#units) | **GET** /units/ | Return all registered units
+
+
+
+## unit_by_id
+
+> models::Unit unit_by_id(id)
+Get Unit by id
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **uuid::Uuid** | Unit id | [required] |
+
+### Return type
+
+[**models::Unit**](Unit.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)
+
+
+## units
+
+> Vec<models::Unit> units()
+Return all registered units
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Vec<models::Unit>**](Unit.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)
+