about summary refs log tree commit diff stats
path: root/crates/rocie-client/docs
diff options
context:
space:
mode:
Diffstat (limited to 'crates/rocie-client/docs')
-rw-r--r--crates/rocie-client/docs/ApiGetApi.md63
-rw-r--r--crates/rocie-client/docs/ApiSetApi.md67
-rw-r--r--crates/rocie-client/docs/BarCode.md11
-rw-r--r--crates/rocie-client/docs/Barcode.md12
-rw-r--r--crates/rocie-client/docs/Product.md14
-rw-r--r--crates/rocie-client/docs/ProductOneOf.md11
-rw-r--r--crates/rocie-client/docs/ProductOneOf1.md11
-rw-r--r--crates/rocie-client/docs/ProductStub.md13
-rw-r--r--crates/rocie-client/docs/UnitAmount.md12
9 files changed, 214 insertions, 0 deletions
diff --git a/crates/rocie-client/docs/ApiGetApi.md b/crates/rocie-client/docs/ApiGetApi.md
new file mode 100644
index 0000000..f2df94c
--- /dev/null
+++ b/crates/rocie-client/docs/ApiGetApi.md
@@ -0,0 +1,63 @@
+# \ApiGetApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**product_by_id**](ApiGetApi.md#product_by_id) | **GET** /product/{id} | Get Product by id
+[**products**](ApiGetApi.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
+
+[[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
+
+[[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
new file mode 100644
index 0000000..87f88b8
--- /dev/null
+++ b/crates/rocie-client/docs/ApiSetApi.md
@@ -0,0 +1,67 @@
+# \ApiSetApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**associate_barcode**](ApiSetApi.md#associate_barcode) | **POST** /product/{id}/associate | Associate a barcode with a product
+[**register_product**](ApiSetApi.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**: Not defined
+
+[[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
+
+[[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
new file mode 100644
index 0000000..8c58cb3
--- /dev/null
+++ b/crates/rocie-client/docs/BarCode.md
@@ -0,0 +1,11 @@
+# BarCode
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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/Barcode.md b/crates/rocie-client/docs/Barcode.md
new file mode 100644
index 0000000..7e6f4fb
--- /dev/null
+++ b/crates/rocie-client/docs/Barcode.md
@@ -0,0 +1,12 @@
+# Barcode
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | [**models::UnitAmount**](UnitAmount.md) |  | 
+**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/Product.md b/crates/rocie-client/docs/Product.md
new file mode 100644
index 0000000..3995429
--- /dev/null
+++ b/crates/rocie-client/docs/Product.md
@@ -0,0 +1,14 @@
+# Product
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**associated_bar_codes** | [**Vec<models::Barcode>**](Barcode.md) |  | 
+**description** | Option<**String**> |  | [optional]
+**id** | [**uuid::Uuid**](uuid::Uuid.md) |  | 
+**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/ProductOneOf.md b/crates/rocie-client/docs/ProductOneOf.md
new file mode 100644
index 0000000..1ab44aa
--- /dev/null
+++ b/crates/rocie-client/docs/ProductOneOf.md
@@ -0,0 +1,11 @@
+# ProductOneOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mass** | **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/ProductOneOf1.md b/crates/rocie-client/docs/ProductOneOf1.md
new file mode 100644
index 0000000..f395a25
--- /dev/null
+++ b/crates/rocie-client/docs/ProductOneOf1.md
@@ -0,0 +1,11 @@
+# ProductOneOf1
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**volume** | **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/ProductStub.md b/crates/rocie-client/docs/ProductStub.md
new file mode 100644
index 0000000..d0b0db8
--- /dev/null
+++ b/crates/rocie-client/docs/ProductStub.md
@@ -0,0 +1,13 @@
+# ProductStub
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | Option<**String**> |  | [optional]
+**name** | **String** |  | 
+**parent** | Option<[**uuid::Uuid**](uuid::Uuid.md)> |  | [optional]
+
+[[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
new file mode 100644
index 0000000..39b2264
--- /dev/null
+++ b/crates/rocie-client/docs/UnitAmount.md
@@ -0,0 +1,12 @@
+# UnitAmount
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**unit** | **String** |  | 
+**value** | **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)
+
+