about summary refs log tree commit diff stats
path: root/crates/rocie-client/docs
diff options
context:
space:
mode:
authorBenedikt Peetz <benedikt.peetz@b-peetz.de>2025-09-23 08:36:26 +0200
committerBenedikt Peetz <benedikt.peetz@b-peetz.de>2025-09-23 08:36:26 +0200
commit5543c1d2ba00f8379685ab22154caf1ad9f4659d (patch)
tree46518bac5fae927b624c5c533949b1dfcf58921f /crates/rocie-client/docs
parentbuild(scripts/mk_sqlite_schema.sh): Init (diff)
downloadserver-5543c1d2ba00f8379685ab22154caf1ad9f4659d.zip
chore(crates/rocies-client): Regenerate
Diffstat (limited to 'crates/rocie-client/docs')
-rw-r--r--crates/rocie-client/docs/ApiGetInventoryApi.md37
-rw-r--r--crates/rocie-client/docs/ApiSetBarcodeApi.md67
-rw-r--r--crates/rocie-client/docs/Barcode.md2
-rw-r--r--crates/rocie-client/docs/ProductAmount.md12
4 files changed, 117 insertions, 1 deletions
diff --git a/crates/rocie-client/docs/ApiGetInventoryApi.md b/crates/rocie-client/docs/ApiGetInventoryApi.md
new file mode 100644
index 0000000..0310b96
--- /dev/null
+++ b/crates/rocie-client/docs/ApiGetInventoryApi.md
@@ -0,0 +1,37 @@
+# \ApiGetInventoryApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**amount_by_id**](ApiGetInventoryApi.md#amount_by_id) | **GET** /inventory/{id} | Get the amount of an product
+
+
+
+## amount_by_id
+
+> models::ProductAmount amount_by_id(id)
+Get the amount of an product
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **uuid::Uuid** | Product id | [required] |
+
+### Return type
+
+[**models::ProductAmount**](ProductAmount.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)
+
diff --git a/crates/rocie-client/docs/ApiSetBarcodeApi.md b/crates/rocie-client/docs/ApiSetBarcodeApi.md
new file mode 100644
index 0000000..2075bb9
--- /dev/null
+++ b/crates/rocie-client/docs/ApiSetBarcodeApi.md
@@ -0,0 +1,67 @@
+# \ApiSetBarcodeApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**buy_barcode**](ApiSetBarcodeApi.md#buy_barcode) | **POST** /barcode/{id}/buy | Buy an barcode
+[**consume_barcode**](ApiSetBarcodeApi.md#consume_barcode) | **POST** /barcode/{id}/consume | Consume an barcode
+
+
+
+## buy_barcode
+
+> buy_barcode(id)
+Buy an barcode
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **i32** | The numeric value of the barcode | [required] |
+
+### Return type
+
+ (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **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)
+
+
+## consume_barcode
+
+> consume_barcode(id, unit_amount)
+Consume an barcode
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **i32** | The numeric value of the barcode | [required] |
+**unit_amount** | [**UnitAmount**](UnitAmount.md) |  | [required] |
+
+### Return type
+
+ (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **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)
+
diff --git a/crates/rocie-client/docs/Barcode.md b/crates/rocie-client/docs/Barcode.md
index d9734fa..7e6f4fb 100644
--- a/crates/rocie-client/docs/Barcode.md
+++ b/crates/rocie-client/docs/Barcode.md
@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **amount** | [**models::UnitAmount**](UnitAmount.md) |  | 
-**id** | **i64** |  | 
+**id** | **i32** |  | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/crates/rocie-client/docs/ProductAmount.md b/crates/rocie-client/docs/ProductAmount.md
new file mode 100644
index 0000000..d6e869c
--- /dev/null
+++ b/crates/rocie-client/docs/ProductAmount.md
@@ -0,0 +1,12 @@
+# ProductAmount
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | [**models::UnitAmount**](UnitAmount.md) |  | 
+**product_id** | [**uuid::Uuid**](uuid::Uuid.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+