about summary refs log tree commit diff stats
path: root/crates/rocie-client/docs
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--crates/rocie-client/docs/ApiGetApi.md4
-rw-r--r--crates/rocie-client/docs/ApiGetProductApi.md63
-rw-r--r--crates/rocie-client/docs/ApiGetUnitApi.md63
-rw-r--r--crates/rocie-client/docs/ApiSetApi.md4
-rw-r--r--crates/rocie-client/docs/ApiSetProductApi.md67
-rw-r--r--crates/rocie-client/docs/ApiSetUnitApi.md37
-rw-r--r--crates/rocie-client/docs/Barcode.md2
-rw-r--r--crates/rocie-client/docs/Unit.md15
-rw-r--r--crates/rocie-client/docs/UnitAmount.md4
-rw-r--r--crates/rocie-client/docs/UnitStub.md14
10 files changed, 266 insertions, 7 deletions
diff --git a/crates/rocie-client/docs/ApiGetApi.md b/crates/rocie-client/docs/ApiGetApi.md
index f2df94c..1ecfb75 100644
--- a/crates/rocie-client/docs/ApiGetApi.md
+++ b/crates/rocie-client/docs/ApiGetApi.md
@@ -32,7 +32,7 @@ No authorization required
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: 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)
 
@@ -57,7 +57,7 @@ No authorization required
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: 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)
 
diff --git a/crates/rocie-client/docs/ApiGetProductApi.md b/crates/rocie-client/docs/ApiGetProductApi.md
new file mode 100644
index 0000000..58955c6
--- /dev/null
+++ b/crates/rocie-client/docs/ApiGetProductApi.md
@@ -0,0 +1,63 @@
+# \ApiGetProductApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**product_by_id**](ApiGetProductApi.md#product_by_id) | **GET** /product/{id} | Get Product by id
+[**products**](ApiGetProductApi.md#products) | **GET** /products/ | Return all registered products
+
+
+
+## product_by_id
+
+> models::Product product_by_id(id)
+Get Product by id
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **uuid::Uuid** | Product id | [required] |
+
+### Return type
+
+[**models::Product**](Product.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)
+
+
+## products
+
+> Vec<models::Product> products()
+Return all registered products
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Vec<models::Product>**](Product.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/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)
+
diff --git a/crates/rocie-client/docs/ApiSetApi.md b/crates/rocie-client/docs/ApiSetApi.md
index 87f88b8..6129e50 100644
--- a/crates/rocie-client/docs/ApiSetApi.md
+++ b/crates/rocie-client/docs/ApiSetApi.md
@@ -33,7 +33,7 @@ No authorization required
 ### HTTP request headers
 
 - **Content-Type**: application/json
-- **Accept**: 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)
 
@@ -61,7 +61,7 @@ No authorization required
 ### HTTP request headers
 
 - **Content-Type**: application/json
-- **Accept**: 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)
 
diff --git a/crates/rocie-client/docs/ApiSetProductApi.md b/crates/rocie-client/docs/ApiSetProductApi.md
new file mode 100644
index 0000000..6166887
--- /dev/null
+++ b/crates/rocie-client/docs/ApiSetProductApi.md
@@ -0,0 +1,67 @@
+# \ApiSetProductApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**associate_barcode**](ApiSetProductApi.md#associate_barcode) | **POST** /product/{id}/associate | Associate a barcode with a product
+[**register_product**](ApiSetProductApi.md#register_product) | **POST** /product/new | Register a product
+
+
+
+## associate_barcode
+
+> associate_barcode(id, barcode)
+Associate a barcode with a product
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | **uuid::Uuid** | The id of the product to associated the barcode with | [required] |
+**barcode** | [**Barcode**](Barcode.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)
+
+
+## register_product
+
+> uuid::Uuid register_product(product_stub)
+Register a product
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**product_stub** | [**ProductStub**](ProductStub.md) |  | [required] |
+
+### Return type
+
+[**uuid::Uuid**](uuid::Uuid.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **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)
+
diff --git a/crates/rocie-client/docs/ApiSetUnitApi.md b/crates/rocie-client/docs/ApiSetUnitApi.md
new file mode 100644
index 0000000..6d6d397
--- /dev/null
+++ b/crates/rocie-client/docs/ApiSetUnitApi.md
@@ -0,0 +1,37 @@
+# \ApiSetUnitApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**register_unit**](ApiSetUnitApi.md#register_unit) | **POST** /unit/new | Register an Unit
+
+
+
+## register_unit
+
+> uuid::Uuid register_unit(unit_stub)
+Register an Unit
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**unit_stub** | [**UnitStub**](UnitStub.md) |  | [required] |
+
+### Return type
+
+[**uuid::Uuid**](uuid::Uuid.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **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)
+
diff --git a/crates/rocie-client/docs/Barcode.md b/crates/rocie-client/docs/Barcode.md
index 7e6f4fb..d9734fa 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** | **i32** |  | 
+**id** | **i64** |  | 
 
 [[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/Unit.md b/crates/rocie-client/docs/Unit.md
new file mode 100644
index 0000000..9fb95a5
--- /dev/null
+++ b/crates/rocie-client/docs/Unit.md
@@ -0,0 +1,15 @@
+# Unit
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | Option<**String**> |  | [optional]
+**full_name_plural** | **String** |  | 
+**full_name_singular** | **String** |  | 
+**id** | [**uuid::Uuid**](uuid::Uuid.md) |  | 
+**short_name** | **String** |  | 
+
+[[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/UnitAmount.md b/crates/rocie-client/docs/UnitAmount.md
index 39b2264..f0c1b5f 100644
--- a/crates/rocie-client/docs/UnitAmount.md
+++ b/crates/rocie-client/docs/UnitAmount.md
@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**unit** | **String** |  | 
-**value** | **i32** |  | 
+**unit** | [**uuid::Uuid**](uuid::Uuid.md) |  | 
+**value** | **i64** |  | 
 
 [[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/UnitStub.md b/crates/rocie-client/docs/UnitStub.md
new file mode 100644
index 0000000..62ab220
--- /dev/null
+++ b/crates/rocie-client/docs/UnitStub.md
@@ -0,0 +1,14 @@
+# UnitStub
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | Option<**String**> |  | [optional]
+**full_name_plural** | **String** |  | 
+**full_name_singular** | **String** |  | 
+**short_name** | **String** |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
generated by cgit-pink 1.4.1 (git 2.36.1) at 2026-03-21 22:52:39 +0000