diff options
Diffstat (limited to '')
57 files changed, 894 insertions, 914 deletions
diff --git a/crates/rocie-client/docs/ApiGetApi.md b/crates/rocie-client/docs/ApiGetApi.md index 1ecfb75..18e026b 100644 --- a/crates/rocie-client/docs/ApiGetApi.md +++ b/crates/rocie-client/docs/ApiGetApi.md @@ -1,25 +1,21 @@ -# \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 +# \\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 +> models::Product product_by_id(id) Get Product by id ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | **uuid::Uuid** | Product id | [required] | +| Name | Type | Description | Required | Notes | +| ------ | -------------- | ----------- | ---------- | ----- | +| **id** | **uuid::Uuid** | Product id | [required] | ### Return type @@ -34,13 +30,14 @@ No authorization required - **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) - +[[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 +> Vec<models::Product> products() Return all registered products ### Parameters @@ -59,5 +56,7 @@ No authorization required - **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) - +[[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/ApiGetAuthInventoryApi.md b/crates/rocie-client/docs/ApiGetAuthInventoryApi.md index ece4d4b..1551249 100644 --- a/crates/rocie-client/docs/ApiGetAuthInventoryApi.md +++ b/crates/rocie-client/docs/ApiGetAuthInventoryApi.md @@ -1,24 +1,20 @@ -# \ApiGetAuthInventoryApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**amount_by_id**](ApiGetAuthInventoryApi.md#amount_by_id) | **GET** /inventory/{id} | Get the amount of an product +# \\ApiGetAuthInventoryApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| ---------------------------------------------------------- | ----------------------- | ---------------------------- | +| [**amount_by_id**](ApiGetAuthInventoryApi.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 +> models::ProductAmount amount_by_id(id) Get the amount of an product ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**ProductId**](.md) | Product id | [required] | +| Name | Type | Description | Required | Notes | +| ------ | -------------------- | ----------- | ---------- | ----- | +| **id** | [**ProductId**](.md) | Product id | [required] | ### Return type @@ -33,5 +29,7 @@ No authorization required - **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) - +[[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/ApiGetAuthProductApi.md b/crates/rocie-client/docs/ApiGetAuthProductApi.md index 8af92f3..44471fa 100644 --- a/crates/rocie-client/docs/ApiGetAuthProductApi.md +++ b/crates/rocie-client/docs/ApiGetAuthProductApi.md @@ -1,30 +1,26 @@ -# \ApiGetAuthProductApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**product_by_id**](ApiGetAuthProductApi.md#product_by_id) | **GET** /product/by-id/{id} | Get Product by id -[**product_by_name**](ApiGetAuthProductApi.md#product_by_name) | **GET** /product/by-name/{name} | Get Product by name -[**product_suggestion_by_name**](ApiGetAuthProductApi.md#product_suggestion_by_name) | **GET** /product/by-part-name/{name} | Get Product suggestion by name -[**products_by_product_parent_id_direct**](ApiGetAuthProductApi.md#products_by_product_parent_id_direct) | **GET** /product/by-product-parent-id-direct/{id} | Get Products by it's product parent id -[**products_by_product_parent_id_indirect**](ApiGetAuthProductApi.md#products_by_product_parent_id_indirect) | **GET** /product/by-product-parent-id-indirect/{id} | Get Products by it's product parent id -[**products_in_storage**](ApiGetAuthProductApi.md#products_in_storage) | **GET** /products_in_storage/ | Return all products, which non-null amount in storage -[**products_registered**](ApiGetAuthProductApi.md#products_registered) | **GET** /products_registered/ | Return all registered products +# \\ApiGetAuthProductApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------- | ----------------------------------------------------- | +| [**product_by_id**](ApiGetAuthProductApi.md#product_by_id) | **GET** /product/by-id/{id} | Get Product by id | +| [**product_by_name**](ApiGetAuthProductApi.md#product_by_name) | **GET** /product/by-name/{name} | Get Product by name | +| [**product_suggestion_by_name**](ApiGetAuthProductApi.md#product_suggestion_by_name) | **GET** /product/by-part-name/{name} | Get Product suggestion by name | +| [**products_by_product_parent_id_direct**](ApiGetAuthProductApi.md#products_by_product_parent_id_direct) | **GET** /product/by-product-parent-id-direct/{id} | Get Products by it's product parent id | +| [**products_by_product_parent_id_indirect**](ApiGetAuthProductApi.md#products_by_product_parent_id_indirect) | **GET** /product/by-product-parent-id-indirect/{id} | Get Products by it's product parent id | +| [**products_in_storage**](ApiGetAuthProductApi.md#products_in_storage) | **GET** /products_in_storage/ | Return all products, which non-null amount in storage | +| [**products_registered**](ApiGetAuthProductApi.md#products_registered) | **GET** /products_registered/ | Return all registered products | ## product_by_id -> models::Product product_by_id(id) -Get Product by id +> models::Product product_by_id(id) Get Product by id ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**ProductId**](.md) | Product id | [required] | +| Name | Type | Description | Required | Notes | +| ------ | -------------------- | ----------- | ---------- | ----- | +| **id** | [**ProductId**](.md) | Product id | [required] | ### Return type @@ -39,20 +35,20 @@ No authorization required - **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) - +[[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) ## product_by_name -> models::Product product_by_name(name) -Get Product by name +> models::Product product_by_name(name) Get Product by name ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**name** | **String** | Name of the product | [required] | +| Name | Type | Description | Required | Notes | +| -------- | ---------- | ------------------- | ---------- | ----- | +| **name** | **String** | Name of the product | [required] | ### Return type @@ -67,20 +63,21 @@ No authorization required - **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) - +[[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) ## product_suggestion_by_name -> Vec<models::Product> product_suggestion_by_name(name) -Get Product suggestion by name +> Vec<models::Product> product_suggestion_by_name(name) Get Product suggestion +> by name ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**name** | **String** | Partial name of a product | [required] | +| Name | Type | Description | Required | Notes | +| -------- | ---------- | ------------------------- | ---------- | ----- | +| **name** | **String** | Partial name of a product | [required] | ### Return type @@ -95,22 +92,23 @@ No authorization required - **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) - +[[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_by_product_parent_id_direct -> Vec<models::Product> products_by_product_parent_id_direct(id) -Get Products by it's product parent id +> Vec<models::Product> products_by_product_parent_id_direct(id) Get Products by +> it's product parent id This will only return products directly associated with this product parent id ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**ProductParentId**](.md) | Product parent id | [required] | +| Name | Type | Description | Required | Notes | +| ------ | -------------------------- | ----------------- | ---------- | ----- | +| **id** | [**ProductParentId**](.md) | Product parent id | [required] | ### Return type @@ -125,22 +123,23 @@ No authorization required - **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) - +[[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_by_product_parent_id_indirect -> Vec<models::Product> products_by_product_parent_id_indirect(id) -Get Products by it's product parent id +> Vec<models::Product> products_by_product_parent_id_indirect(id) Get Products +> by it's product parent id This will also return all products below this product parent id ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**ProductParentId**](.md) | Product parent id | [required] | +| Name | Type | Description | Required | Notes | +| ------ | -------------------------- | ----------------- | ---------- | ----- | +| **id** | [**ProductParentId**](.md) | Product parent id | [required] | ### Return type @@ -155,13 +154,15 @@ No authorization required - **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) - +[[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_in_storage -> Vec<models::Product> products_in_storage() -Return all products, which non-null amount in storage +> Vec<models::Product> products_in_storage() Return all products, which non-null +> amount in storage ### Parameters @@ -180,13 +181,14 @@ No authorization required - **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) - +[[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_registered -> Vec<models::Product> products_registered() -Return all registered products +> Vec<models::Product> products_registered() Return all registered products ### Parameters @@ -205,5 +207,7 @@ No authorization required - **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) - +[[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/ApiGetAuthProductParentApi.md b/crates/rocie-client/docs/ApiGetAuthProductParentApi.md index fbdc3b1..f51a316 100644 --- a/crates/rocie-client/docs/ApiGetAuthProductParentApi.md +++ b/crates/rocie-client/docs/ApiGetAuthProductParentApi.md @@ -1,19 +1,17 @@ -# \ApiGetAuthProductParentApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**product_parents**](ApiGetAuthProductParentApi.md#product_parents) | **GET** /product_parents/ | Return all registered product parents -[**product_parents_toplevel**](ApiGetAuthProductParentApi.md#product_parents_toplevel) | **GET** /product_parents_toplevel/ | Return all registered product parents, that have no parents themselves -[**product_parents_under**](ApiGetAuthProductParentApi.md#product_parents_under) | **GET** /product_parents_under/{id} | Return all parents, that have this parent as parent +# \\ApiGetAuthProductParentApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| -------------------------------------------------------------------------------------- | ----------------------------------- | ---------------------------------------------------------------------- | +| [**product_parents**](ApiGetAuthProductParentApi.md#product_parents) | **GET** /product_parents/ | Return all registered product parents | +| [**product_parents_toplevel**](ApiGetAuthProductParentApi.md#product_parents_toplevel) | **GET** /product_parents_toplevel/ | Return all registered product parents, that have no parents themselves | +| [**product_parents_under**](ApiGetAuthProductParentApi.md#product_parents_under) | **GET** /product_parents_under/{id} | Return all parents, that have this parent as parent | ## product_parents -> Vec<models::ProductParent> product_parents() -Return all registered product parents +> Vec<models::ProductParent> product_parents() Return all registered product +> parents ### Parameters @@ -32,13 +30,15 @@ No authorization required - **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) - +[[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) ## product_parents_toplevel -> Vec<models::ProductParent> product_parents_toplevel() -Return all registered product parents, that have no parents themselves +> Vec<models::ProductParent> product_parents_toplevel() Return all registered +> product parents, that have no parents themselves ### Parameters @@ -57,20 +57,21 @@ No authorization required - **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) - +[[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) ## product_parents_under -> Vec<models::ProductParent> product_parents_under(id) -Return all parents, that have this parent as parent +> Vec<models::ProductParent> product_parents_under(id) Return all parents, that +> have this parent as parent ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**ProductParentId**](.md) | Product parent id | [required] | +| Name | Type | Description | Required | Notes | +| ------ | -------------------------- | ----------------- | ---------- | ----- | +| **id** | [**ProductParentId**](.md) | Product parent id | [required] | ### Return type @@ -85,5 +86,7 @@ No authorization required - **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) - +[[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/ApiGetAuthRecipeApi.md b/crates/rocie-client/docs/ApiGetAuthRecipeApi.md index 96d5a77..29e2e36 100644 --- a/crates/rocie-client/docs/ApiGetAuthRecipeApi.md +++ b/crates/rocie-client/docs/ApiGetAuthRecipeApi.md @@ -1,25 +1,21 @@ -# \ApiGetAuthRecipeApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**recipe_by_id**](ApiGetAuthRecipeApi.md#recipe_by_id) | **GET** /recipe/by-id/{id} | Get an recipe by it's id. -[**recipes**](ApiGetAuthRecipeApi.md#recipes) | **GET** /recipe/all | Get all added recipes +# \\ApiGetAuthRecipeApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| ------------------------------------------------------- | -------------------------- | ------------------------- | +| [**recipe_by_id**](ApiGetAuthRecipeApi.md#recipe_by_id) | **GET** /recipe/by-id/{id} | Get an recipe by it's id. | +| [**recipes**](ApiGetAuthRecipeApi.md#recipes) | **GET** /recipe/all | Get all added recipes | ## recipe_by_id -> models::Recipe recipe_by_id(id) -Get an recipe by it's id. +> models::Recipe recipe_by_id(id) Get an recipe by it's id. ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**RecipeId**](.md) | Recipe id | [required] | +| Name | Type | Description | Required | Notes | +| ------ | ------------------- | ----------- | ---------- | ----- | +| **id** | [**RecipeId**](.md) | Recipe id | [required] | ### Return type @@ -34,13 +30,14 @@ No authorization required - **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) - +[[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) ## recipes -> models::Recipe recipes() -Get all added recipes +> models::Recipe recipes() Get all added recipes ### Parameters @@ -59,5 +56,7 @@ No authorization required - **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) - +[[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/ApiGetAuthUnitApi.md b/crates/rocie-client/docs/ApiGetAuthUnitApi.md index 3f2b02f..d8db77d 100644 --- a/crates/rocie-client/docs/ApiGetAuthUnitApi.md +++ b/crates/rocie-client/docs/ApiGetAuthUnitApi.md @@ -1,26 +1,22 @@ -# \ApiGetAuthUnitApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**unit_by_id**](ApiGetAuthUnitApi.md#unit_by_id) | **GET** /unit/{id} | Get Unit by id -[**units**](ApiGetAuthUnitApi.md#units) | **GET** /units/ | Return all registered units -[**units_by_property_id**](ApiGetAuthUnitApi.md#units_by_property_id) | **GET** /units-by-property/{id} | Return all registered units for a specific unit property +# \\ApiGetAuthUnitApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| --------------------------------------------------------------------- | ------------------------------- | -------------------------------------------------------- | +| [**unit_by_id**](ApiGetAuthUnitApi.md#unit_by_id) | **GET** /unit/{id} | Get Unit by id | +| [**units**](ApiGetAuthUnitApi.md#units) | **GET** /units/ | Return all registered units | +| [**units_by_property_id**](ApiGetAuthUnitApi.md#units_by_property_id) | **GET** /units-by-property/{id} | Return all registered units for a specific unit property | ## unit_by_id -> models::Unit unit_by_id(id) -Get Unit by id +> models::Unit unit_by_id(id) Get Unit by id ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**UnitId**](.md) | Unit id | [required] | +| Name | Type | Description | Required | Notes | +| ------ | ----------------- | ----------- | ---------- | ----- | +| **id** | [**UnitId**](.md) | Unit id | [required] | ### Return type @@ -35,13 +31,14 @@ No authorization required - **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) - +[[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 +> Vec<models::Unit> units() Return all registered units ### Parameters @@ -60,20 +57,21 @@ No authorization required - **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) - +[[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_by_property_id -> Vec<models::Unit> units_by_property_id(id) -Return all registered units for a specific unit property +> Vec<models::Unit> units_by_property_id(id) Return all registered units for a +> specific unit property ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**UnitPropertyId**](.md) | Unit property id | [required] | +| Name | Type | Description | Required | Notes | +| ------ | ------------------------- | ---------------- | ---------- | ----- | +| **id** | [**UnitPropertyId**](.md) | Unit property id | [required] | ### Return type @@ -88,5 +86,7 @@ No authorization required - **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) - +[[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/ApiGetAuthUnitPropertyApi.md b/crates/rocie-client/docs/ApiGetAuthUnitPropertyApi.md index d88249a..09c261f 100644 --- a/crates/rocie-client/docs/ApiGetAuthUnitPropertyApi.md +++ b/crates/rocie-client/docs/ApiGetAuthUnitPropertyApi.md @@ -1,18 +1,16 @@ -# \ApiGetAuthUnitPropertyApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**unit_properties**](ApiGetAuthUnitPropertyApi.md#unit_properties) | **GET** /unit-properties/ | Return all registered unit properties -[**unit_property_by_id**](ApiGetAuthUnitPropertyApi.md#unit_property_by_id) | **GET** /unit-property/{id} | Get Unit property by id +# \\ApiGetAuthUnitPropertyApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| --------------------------------------------------------------------------- | --------------------------- | ------------------------------------- | +| [**unit_properties**](ApiGetAuthUnitPropertyApi.md#unit_properties) | **GET** /unit-properties/ | Return all registered unit properties | +| [**unit_property_by_id**](ApiGetAuthUnitPropertyApi.md#unit_property_by_id) | **GET** /unit-property/{id} | Get Unit property by id | ## unit_properties -> Vec<models::UnitProperty> unit_properties() -Return all registered unit properties +> Vec<models::UnitProperty> unit_properties() Return all registered unit +> properties ### Parameters @@ -31,20 +29,20 @@ No authorization required - **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) - +[[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) ## unit_property_by_id -> models::UnitProperty unit_property_by_id(id) -Get Unit property by id +> models::UnitProperty unit_property_by_id(id) Get Unit property by id ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**UnitPropertyId**](.md) | Unit Property id | [required] | +| Name | Type | Description | Required | Notes | +| ------ | ------------------------- | ---------------- | ---------- | ----- | +| **id** | [**UnitPropertyId**](.md) | Unit Property id | [required] | ### Return type @@ -59,5 +57,7 @@ No authorization required - **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) - +[[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/ApiGetAuthUserApi.md b/crates/rocie-client/docs/ApiGetAuthUserApi.md index 653e82a..be9fe70 100644 --- a/crates/rocie-client/docs/ApiGetAuthUserApi.md +++ b/crates/rocie-client/docs/ApiGetAuthUserApi.md @@ -1,25 +1,21 @@ -# \ApiGetAuthUserApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**user_by_id**](ApiGetAuthUserApi.md#user_by_id) | **GET** /user/{id} | Get an specific user by id. -[**users**](ApiGetAuthUserApi.md#users) | **GET** /users | Get all registered users. +# \\ApiGetAuthUserApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| ------------------------------------------------- | ------------------ | --------------------------- | +| [**user_by_id**](ApiGetAuthUserApi.md#user_by_id) | **GET** /user/{id} | Get an specific user by id. | +| [**users**](ApiGetAuthUserApi.md#users) | **GET** /users | Get all registered users. | ## user_by_id -> models::User user_by_id(id) -Get an specific user by id. +> models::User user_by_id(id) Get an specific user by id. ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**UserId**](.md) | User id | [required] | +| Name | Type | Description | Required | Notes | +| ------ | ----------------- | ----------- | ---------- | ----- | +| **id** | [**UserId**](.md) | User id | [required] | ### Return type @@ -34,13 +30,14 @@ No authorization required - **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) - +[[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) ## users -> Vec<models::User> users() -Get all registered users. +> Vec<models::User> users() Get all registered users. ### Parameters @@ -59,5 +56,7 @@ No authorization required - **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) - +[[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/ApiGetInventoryApi.md b/crates/rocie-client/docs/ApiGetInventoryApi.md index 92a53f9..46758a7 100644 --- a/crates/rocie-client/docs/ApiGetInventoryApi.md +++ b/crates/rocie-client/docs/ApiGetInventoryApi.md @@ -1,24 +1,20 @@ -# \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 +# \\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 +> models::ProductAmount amount_by_id(id) Get the amount of an product ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**ProductId**](.md) | Product id | [required] | +| Name | Type | Description | Required | Notes | +| ------ | -------------------- | ----------- | ---------- | ----- | +| **id** | [**ProductId**](.md) | Product id | [required] | ### Return type @@ -33,5 +29,7 @@ No authorization required - **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) - +[[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/ApiGetNoAuthUserApi.md b/crates/rocie-client/docs/ApiGetNoAuthUserApi.md index 7923a1a..d16d158 100644 --- a/crates/rocie-client/docs/ApiGetNoAuthUserApi.md +++ b/crates/rocie-client/docs/ApiGetNoAuthUserApi.md @@ -1,25 +1,21 @@ -# \ApiGetNoAuthUserApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**user_by_id**](ApiGetNoAuthUserApi.md#user_by_id) | **GET** /user/{id} | Get an specific user by id. -[**users**](ApiGetNoAuthUserApi.md#users) | **GET** /users | Get all registered users. +# \\ApiGetNoAuthUserApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| --------------------------------------------------- | ------------------ | --------------------------- | +| [**user_by_id**](ApiGetNoAuthUserApi.md#user_by_id) | **GET** /user/{id} | Get an specific user by id. | +| [**users**](ApiGetNoAuthUserApi.md#users) | **GET** /users | Get all registered users. | ## user_by_id -> models::User user_by_id(id) -Get an specific user by id. +> models::User user_by_id(id) Get an specific user by id. ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**UserId**](.md) | User id | [required] | +| Name | Type | Description | Required | Notes | +| ------ | ----------------- | ----------- | ---------- | ----- | +| **id** | [**UserId**](.md) | User id | [required] | ### Return type @@ -34,13 +30,14 @@ No authorization required - **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) - +[[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) ## users -> Vec<models::User> users() -Get all registered users. +> Vec<models::User> users() Get all registered users. ### Parameters @@ -59,5 +56,7 @@ This endpoint does not need any parameter. - **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) - +[[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 index 3491910..3310f86 100644 --- a/crates/rocie-client/docs/ApiGetProductApi.md +++ b/crates/rocie-client/docs/ApiGetProductApi.md @@ -1,30 +1,26 @@ -# \ApiGetProductApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**product_by_id**](ApiGetProductApi.md#product_by_id) | **GET** /product/by-id/{id} | Get Product by id -[**product_by_name**](ApiGetProductApi.md#product_by_name) | **GET** /product/by-name/{name} | Get Product by name -[**product_suggestion_by_name**](ApiGetProductApi.md#product_suggestion_by_name) | **GET** /product/by-part-name/{name} | Get Product suggestion by name -[**products_by_product_parent_id_direct**](ApiGetProductApi.md#products_by_product_parent_id_direct) | **GET** /product/by-product-parent-id-direct/{id} | Get Products by it's product parent id -[**products_by_product_parent_id_indirect**](ApiGetProductApi.md#products_by_product_parent_id_indirect) | **GET** /product/by-product-parent-id-indirect/{id} | Get Products by it's product parent id -[**products_in_storage**](ApiGetProductApi.md#products_in_storage) | **GET** /products_in_storage/ | Return all products, which non-null amount in storage -[**products_registered**](ApiGetProductApi.md#products_registered) | **GET** /products_registered/ | Return all registered products +# \\ApiGetProductApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| -------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | ----------------------------------------------------- | +| [**product_by_id**](ApiGetProductApi.md#product_by_id) | **GET** /product/by-id/{id} | Get Product by id | +| [**product_by_name**](ApiGetProductApi.md#product_by_name) | **GET** /product/by-name/{name} | Get Product by name | +| [**product_suggestion_by_name**](ApiGetProductApi.md#product_suggestion_by_name) | **GET** /product/by-part-name/{name} | Get Product suggestion by name | +| [**products_by_product_parent_id_direct**](ApiGetProductApi.md#products_by_product_parent_id_direct) | **GET** /product/by-product-parent-id-direct/{id} | Get Products by it's product parent id | +| [**products_by_product_parent_id_indirect**](ApiGetProductApi.md#products_by_product_parent_id_indirect) | **GET** /product/by-product-parent-id-indirect/{id} | Get Products by it's product parent id | +| [**products_in_storage**](ApiGetProductApi.md#products_in_storage) | **GET** /products_in_storage/ | Return all products, which non-null amount in storage | +| [**products_registered**](ApiGetProductApi.md#products_registered) | **GET** /products_registered/ | Return all registered products | ## product_by_id -> models::Product product_by_id(id) -Get Product by id +> models::Product product_by_id(id) Get Product by id ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**ProductId**](.md) | Product id | [required] | +| Name | Type | Description | Required | Notes | +| ------ | -------------------- | ----------- | ---------- | ----- | +| **id** | [**ProductId**](.md) | Product id | [required] | ### Return type @@ -39,20 +35,20 @@ No authorization required - **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) - +[[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) ## product_by_name -> models::Product product_by_name(name) -Get Product by name +> models::Product product_by_name(name) Get Product by name ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**name** | **String** | Name of the product | [required] | +| Name | Type | Description | Required | Notes | +| -------- | ---------- | ------------------- | ---------- | ----- | +| **name** | **String** | Name of the product | [required] | ### Return type @@ -67,20 +63,21 @@ No authorization required - **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) - +[[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) ## product_suggestion_by_name -> Vec<models::Product> product_suggestion_by_name(name) -Get Product suggestion by name +> Vec<models::Product> product_suggestion_by_name(name) Get Product suggestion +> by name ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**name** | **String** | Partial name of a product | [required] | +| Name | Type | Description | Required | Notes | +| -------- | ---------- | ------------------------- | ---------- | ----- | +| **name** | **String** | Partial name of a product | [required] | ### Return type @@ -95,22 +92,23 @@ No authorization required - **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) - +[[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_by_product_parent_id_direct -> Vec<models::Product> products_by_product_parent_id_direct(id) -Get Products by it's product parent id +> Vec<models::Product> products_by_product_parent_id_direct(id) Get Products by +> it's product parent id This will only return products directly associated with this product parent id ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**ProductParentId**](.md) | Product parent id | [required] | +| Name | Type | Description | Required | Notes | +| ------ | -------------------------- | ----------------- | ---------- | ----- | +| **id** | [**ProductParentId**](.md) | Product parent id | [required] | ### Return type @@ -125,22 +123,23 @@ No authorization required - **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) - +[[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_by_product_parent_id_indirect -> Vec<models::Product> products_by_product_parent_id_indirect(id) -Get Products by it's product parent id +> Vec<models::Product> products_by_product_parent_id_indirect(id) Get Products +> by it's product parent id This will also return all products below this product parent id ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**ProductParentId**](.md) | Product parent id | [required] | +| Name | Type | Description | Required | Notes | +| ------ | -------------------------- | ----------------- | ---------- | ----- | +| **id** | [**ProductParentId**](.md) | Product parent id | [required] | ### Return type @@ -155,13 +154,15 @@ No authorization required - **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) - +[[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_in_storage -> Vec<models::Product> products_in_storage() -Return all products, which non-null amount in storage +> Vec<models::Product> products_in_storage() Return all products, which non-null +> amount in storage ### Parameters @@ -180,13 +181,14 @@ No authorization required - **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) - +[[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_registered -> Vec<models::Product> products_registered() -Return all registered products +> Vec<models::Product> products_registered() Return all registered products ### Parameters @@ -205,5 +207,7 @@ No authorization required - **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) - +[[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/ApiGetProductParentApi.md b/crates/rocie-client/docs/ApiGetProductParentApi.md index 3c61982..60aafd1 100644 --- a/crates/rocie-client/docs/ApiGetProductParentApi.md +++ b/crates/rocie-client/docs/ApiGetProductParentApi.md @@ -1,19 +1,17 @@ -# \ApiGetProductParentApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**product_parents**](ApiGetProductParentApi.md#product_parents) | **GET** /product_parents/ | Return all registered product parents -[**product_parents_toplevel**](ApiGetProductParentApi.md#product_parents_toplevel) | **GET** /product_parents_toplevel/ | Return all registered product parents, that have no parents themselves -[**product_parents_under**](ApiGetProductParentApi.md#product_parents_under) | **GET** /product_parents_under/{id} | Return all parents, that have this parent as parent +# \\ApiGetProductParentApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| ---------------------------------------------------------------------------------- | ----------------------------------- | ---------------------------------------------------------------------- | +| [**product_parents**](ApiGetProductParentApi.md#product_parents) | **GET** /product_parents/ | Return all registered product parents | +| [**product_parents_toplevel**](ApiGetProductParentApi.md#product_parents_toplevel) | **GET** /product_parents_toplevel/ | Return all registered product parents, that have no parents themselves | +| [**product_parents_under**](ApiGetProductParentApi.md#product_parents_under) | **GET** /product_parents_under/{id} | Return all parents, that have this parent as parent | ## product_parents -> Vec<models::ProductParent> product_parents() -Return all registered product parents +> Vec<models::ProductParent> product_parents() Return all registered product +> parents ### Parameters @@ -32,13 +30,15 @@ No authorization required - **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) - +[[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) ## product_parents_toplevel -> Vec<models::ProductParent> product_parents_toplevel() -Return all registered product parents, that have no parents themselves +> Vec<models::ProductParent> product_parents_toplevel() Return all registered +> product parents, that have no parents themselves ### Parameters @@ -57,20 +57,21 @@ No authorization required - **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) - +[[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) ## product_parents_under -> Vec<models::ProductParent> product_parents_under(id) -Return all parents, that have this parent as parent +> Vec<models::ProductParent> product_parents_under(id) Return all parents, that +> have this parent as parent ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**ProductParentId**](.md) | Product parent id | [required] | +| Name | Type | Description | Required | Notes | +| ------ | -------------------------- | ----------------- | ---------- | ----- | +| **id** | [**ProductParentId**](.md) | Product parent id | [required] | ### Return type @@ -85,5 +86,7 @@ No authorization required - **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) - +[[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/ApiGetRecipeApi.md b/crates/rocie-client/docs/ApiGetRecipeApi.md index cce6112..677dff5 100644 --- a/crates/rocie-client/docs/ApiGetRecipeApi.md +++ b/crates/rocie-client/docs/ApiGetRecipeApi.md @@ -1,25 +1,21 @@ -# \ApiGetRecipeApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**recipe_by_id**](ApiGetRecipeApi.md#recipe_by_id) | **GET** /recipe/by-id/{id} | Get an recipe by it's id. -[**recipes**](ApiGetRecipeApi.md#recipes) | **GET** /recipe/all | Get all added recipes +# \\ApiGetRecipeApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| --------------------------------------------------- | -------------------------- | ------------------------- | +| [**recipe_by_id**](ApiGetRecipeApi.md#recipe_by_id) | **GET** /recipe/by-id/{id} | Get an recipe by it's id. | +| [**recipes**](ApiGetRecipeApi.md#recipes) | **GET** /recipe/all | Get all added recipes | ## recipe_by_id -> models::Recipe recipe_by_id(id) -Get an recipe by it's id. +> models::Recipe recipe_by_id(id) Get an recipe by it's id. ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**RecipeId**](.md) | Recipe id | [required] | +| Name | Type | Description | Required | Notes | +| ------ | ------------------- | ----------- | ---------- | ----- | +| **id** | [**RecipeId**](.md) | Recipe id | [required] | ### Return type @@ -34,13 +30,14 @@ No authorization required - **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) - +[[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) ## recipes -> models::Recipe recipes() -Get all added recipes +> models::Recipe recipes() Get all added recipes ### Parameters @@ -59,5 +56,7 @@ No authorization required - **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) - +[[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 index f2fc6e6..b2e7311 100644 --- a/crates/rocie-client/docs/ApiGetUnitApi.md +++ b/crates/rocie-client/docs/ApiGetUnitApi.md @@ -1,26 +1,22 @@ -# \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 -[**units_by_property_id**](ApiGetUnitApi.md#units_by_property_id) | **GET** /units-by-property/{id} | Return all registered units for a specific unit property +# \\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 | +| [**units_by_property_id**](ApiGetUnitApi.md#units_by_property_id) | **GET** /units-by-property/{id} | Return all registered units for a specific unit property | ## unit_by_id -> models::Unit unit_by_id(id) -Get Unit by id +> models::Unit unit_by_id(id) Get Unit by id ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**UnitId**](.md) | Unit id | [required] | +| Name | Type | Description | Required | Notes | +| ------ | ----------------- | ----------- | ---------- | ----- | +| **id** | [**UnitId**](.md) | Unit id | [required] | ### Return type @@ -35,13 +31,14 @@ No authorization required - **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) - +[[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 +> Vec<models::Unit> units() Return all registered units ### Parameters @@ -60,20 +57,21 @@ No authorization required - **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) - +[[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_by_property_id -> Vec<models::Unit> units_by_property_id(id) -Return all registered units for a specific unit property +> Vec<models::Unit> units_by_property_id(id) Return all registered units for a +> specific unit property ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**UnitPropertyId**](.md) | Unit property id | [required] | +| Name | Type | Description | Required | Notes | +| ------ | ------------------------- | ---------------- | ---------- | ----- | +| **id** | [**UnitPropertyId**](.md) | Unit property id | [required] | ### Return type @@ -88,5 +86,7 @@ No authorization required - **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) - +[[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/ApiGetUnitPropertyApi.md b/crates/rocie-client/docs/ApiGetUnitPropertyApi.md index e59d876..da8f68e 100644 --- a/crates/rocie-client/docs/ApiGetUnitPropertyApi.md +++ b/crates/rocie-client/docs/ApiGetUnitPropertyApi.md @@ -1,18 +1,16 @@ -# \ApiGetUnitPropertyApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**unit_properties**](ApiGetUnitPropertyApi.md#unit_properties) | **GET** /unit-properties/ | Return all registered unit properties -[**unit_property_by_id**](ApiGetUnitPropertyApi.md#unit_property_by_id) | **GET** /unit-property/{id} | Get Unit property by id +# \\ApiGetUnitPropertyApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| ----------------------------------------------------------------------- | --------------------------- | ------------------------------------- | +| [**unit_properties**](ApiGetUnitPropertyApi.md#unit_properties) | **GET** /unit-properties/ | Return all registered unit properties | +| [**unit_property_by_id**](ApiGetUnitPropertyApi.md#unit_property_by_id) | **GET** /unit-property/{id} | Get Unit property by id | ## unit_properties -> Vec<models::UnitProperty> unit_properties() -Return all registered unit properties +> Vec<models::UnitProperty> unit_properties() Return all registered unit +> properties ### Parameters @@ -31,20 +29,20 @@ No authorization required - **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) - +[[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) ## unit_property_by_id -> models::UnitProperty unit_property_by_id(id) -Get Unit property by id +> models::UnitProperty unit_property_by_id(id) Get Unit property by id ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**UnitPropertyId**](.md) | Unit Property id | [required] | +| Name | Type | Description | Required | Notes | +| ------ | ------------------------- | ---------------- | ---------- | ----- | +| **id** | [**UnitPropertyId**](.md) | Unit Property id | [required] | ### Return type @@ -59,5 +57,7 @@ No authorization required - **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) - +[[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 6129e50..21f6c35 100644 --- a/crates/rocie-client/docs/ApiSetApi.md +++ b/crates/rocie-client/docs/ApiSetApi.md @@ -1,30 +1,26 @@ -# \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 +# \\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 +> 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] | +| 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) +(empty response body) ### Authorization @@ -35,20 +31,20 @@ 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) ## register_product -> uuid::Uuid register_product(product_stub) -Register a product +> uuid::Uuid register_product(product_stub) Register a product ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**product_stub** | [**ProductStub**](ProductStub.md) | | [required] | +| Name | Type | Description | Required | Notes | +| ---------------- | --------------------------------- | ----------- | ---------- | ----- | +| **product_stub** | [**ProductStub**](ProductStub.md) | | [required] | ### Return type @@ -63,5 +59,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) diff --git a/crates/rocie-client/docs/ApiSetAuthBarcodeApi.md b/crates/rocie-client/docs/ApiSetAuthBarcodeApi.md index 535643b..357c26b 100644 --- a/crates/rocie-client/docs/ApiSetAuthBarcodeApi.md +++ b/crates/rocie-client/docs/ApiSetAuthBarcodeApi.md @@ -1,30 +1,26 @@ -# \ApiSetAuthBarcodeApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**buy_barcode**](ApiSetAuthBarcodeApi.md#buy_barcode) | **POST** /barcode/{barcode_id}/buy/{times} | Buy an barcode -[**consume_barcode**](ApiSetAuthBarcodeApi.md#consume_barcode) | **POST** /barcode/{id}/consume | Consume an barcode +# \\ApiSetAuthBarcodeApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| -------------------------------------------------------------- | ------------------------------------------ | ------------------ | +| [**buy_barcode**](ApiSetAuthBarcodeApi.md#buy_barcode) | **POST** /barcode/{barcode_id}/buy/{times} | Buy an barcode | +| [**consume_barcode**](ApiSetAuthBarcodeApi.md#consume_barcode) | **POST** /barcode/{id}/consume | Consume an barcode | ## buy_barcode -> buy_barcode(barcode_id, times) -Buy an barcode +> buy_barcode(barcode_id, times) Buy an barcode ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**barcode_id** | [**BarcodeId**](.md) | The numeric value of the barcode | [required] | -**times** | **u32** | How often to buy the barcode | [required] | +| Name | Type | Description | Required | Notes | +| -------------- | -------------------- | -------------------------------- | ---------- | ----- | +| **barcode_id** | [**BarcodeId**](.md) | The numeric value of the barcode | [required] | +| **times** | **u32** | How often to buy the barcode | [required] | ### Return type - (empty response body) +(empty response body) ### Authorization @@ -35,25 +31,25 @@ 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) ## consume_barcode -> consume_barcode(id, unit_amount) -Consume an barcode +> consume_barcode(id, unit_amount) Consume an barcode ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**BarcodeId**](.md) | The numeric value of the barcode | [required] | -**unit_amount** | [**UnitAmount**](UnitAmount.md) | | [required] | +| Name | Type | Description | Required | Notes | +| --------------- | ------------------------------- | -------------------------------- | ---------- | ----- | +| **id** | [**BarcodeId**](.md) | The numeric value of the barcode | [required] | +| **unit_amount** | [**UnitAmount**](UnitAmount.md) | | [required] | ### Return type - (empty response body) +(empty response body) ### Authorization @@ -64,5 +60,7 @@ 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) diff --git a/crates/rocie-client/docs/ApiSetAuthProductApi.md b/crates/rocie-client/docs/ApiSetAuthProductApi.md index eb52b59..df659ef 100644 --- a/crates/rocie-client/docs/ApiSetAuthProductApi.md +++ b/crates/rocie-client/docs/ApiSetAuthProductApi.md @@ -1,30 +1,26 @@ -# \ApiSetAuthProductApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**associate_barcode**](ApiSetAuthProductApi.md#associate_barcode) | **POST** /product/{id}/associate | Associate a barcode with a product -[**register_product**](ApiSetAuthProductApi.md#register_product) | **POST** /product/new | Register a product +# \\ApiSetAuthProductApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| ------------------------------------------------------------------ | -------------------------------- | ---------------------------------- | +| [**associate_barcode**](ApiSetAuthProductApi.md#associate_barcode) | **POST** /product/{id}/associate | Associate a barcode with a product | +| [**register_product**](ApiSetAuthProductApi.md#register_product) | **POST** /product/new | Register a product | ## associate_barcode -> associate_barcode(id, barcode) -Associate a barcode with a product +> associate_barcode(id, barcode) Associate a barcode with a product ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**ProductId**](.md) | The id of the product to associated the barcode with | [required] | -**barcode** | [**Barcode**](Barcode.md) | | [required] | +| Name | Type | Description | Required | Notes | +| ----------- | ------------------------- | ---------------------------------------------------- | ---------- | ----- | +| **id** | [**ProductId**](.md) | The id of the product to associated the barcode with | [required] | +| **barcode** | [**Barcode**](Barcode.md) | | [required] | ### Return type - (empty response body) +(empty response body) ### Authorization @@ -35,20 +31,20 @@ 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) ## register_product -> models::ProductId register_product(product_stub) -Register a product +> models::ProductId register_product(product_stub) Register a product ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**product_stub** | [**ProductStub**](ProductStub.md) | | [required] | +| Name | Type | Description | Required | Notes | +| ---------------- | --------------------------------- | ----------- | ---------- | ----- | +| **product_stub** | [**ProductStub**](ProductStub.md) | | [required] | ### Return type @@ -63,5 +59,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) diff --git a/crates/rocie-client/docs/ApiSetAuthProductParentApi.md b/crates/rocie-client/docs/ApiSetAuthProductParentApi.md index e48c269..54fbef1 100644 --- a/crates/rocie-client/docs/ApiSetAuthProductParentApi.md +++ b/crates/rocie-client/docs/ApiSetAuthProductParentApi.md @@ -1,24 +1,21 @@ -# \ApiSetAuthProductParentApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**register_product_parent**](ApiSetAuthProductParentApi.md#register_product_parent) | **POST** /product_parent/new | Register a product parent +# \\ApiSetAuthProductParentApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| ------------------------------------------------------------------------------------ | ---------------------------- | ------------------------- | +| [**register_product_parent**](ApiSetAuthProductParentApi.md#register_product_parent) | **POST** /product_parent/new | Register a product parent | ## register_product_parent -> models::ProductParentId register_product_parent(product_parent_stub) -Register a product parent +> models::ProductParentId register_product_parent(product_parent_stub) Register +> a product parent ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**product_parent_stub** | [**ProductParentStub**](ProductParentStub.md) | | [required] | +| Name | Type | Description | Required | Notes | +| ----------------------- | --------------------------------------------- | ----------- | ---------- | ----- | +| **product_parent_stub** | [**ProductParentStub**](ProductParentStub.md) | | [required] | ### Return type @@ -33,5 +30,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) diff --git a/crates/rocie-client/docs/ApiSetAuthRecipeApi.md b/crates/rocie-client/docs/ApiSetAuthRecipeApi.md index 0ec118b..a897210 100644 --- a/crates/rocie-client/docs/ApiSetAuthRecipeApi.md +++ b/crates/rocie-client/docs/ApiSetAuthRecipeApi.md @@ -1,24 +1,20 @@ -# \ApiSetAuthRecipeApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**add_recipe**](ApiSetAuthRecipeApi.md#add_recipe) | **POST** /recipe/new | Register a product parent +# \\ApiSetAuthRecipeApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| --------------------------------------------------- | -------------------- | ------------------------- | +| [**add_recipe**](ApiSetAuthRecipeApi.md#add_recipe) | **POST** /recipe/new | Register a product parent | ## add_recipe -> models::RecipeId add_recipe(recipe_stub) -Register a product parent +> models::RecipeId add_recipe(recipe_stub) Register a product parent ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**recipe_stub** | [**RecipeStub**](RecipeStub.md) | | [required] | +| Name | Type | Description | Required | Notes | +| --------------- | ------------------------------- | ----------- | ---------- | ----- | +| **recipe_stub** | [**RecipeStub**](RecipeStub.md) | | [required] | ### Return type @@ -33,5 +29,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) diff --git a/crates/rocie-client/docs/ApiSetAuthUnitApi.md b/crates/rocie-client/docs/ApiSetAuthUnitApi.md index d5927f8..ddb7581 100644 --- a/crates/rocie-client/docs/ApiSetAuthUnitApi.md +++ b/crates/rocie-client/docs/ApiSetAuthUnitApi.md @@ -1,24 +1,20 @@ -# \ApiSetAuthUnitApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**register_unit**](ApiSetAuthUnitApi.md#register_unit) | **POST** /unit/new | Register an Unit +# \\ApiSetAuthUnitApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| ------------------------------------------------------- | ------------------ | ---------------- | +| [**register_unit**](ApiSetAuthUnitApi.md#register_unit) | **POST** /unit/new | Register an Unit | ## register_unit -> models::UnitId register_unit(unit_stub) -Register an Unit +> models::UnitId register_unit(unit_stub) Register an Unit ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**unit_stub** | [**UnitStub**](UnitStub.md) | | [required] | +| Name | Type | Description | Required | Notes | +| ------------- | --------------------------- | ----------- | ---------- | ----- | +| **unit_stub** | [**UnitStub**](UnitStub.md) | | [required] | ### Return type @@ -33,5 +29,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) diff --git a/crates/rocie-client/docs/ApiSetAuthUnitPropertyApi.md b/crates/rocie-client/docs/ApiSetAuthUnitPropertyApi.md index 855065c..df662c8 100644 --- a/crates/rocie-client/docs/ApiSetAuthUnitPropertyApi.md +++ b/crates/rocie-client/docs/ApiSetAuthUnitPropertyApi.md @@ -1,24 +1,21 @@ -# \ApiSetAuthUnitPropertyApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**register_unit_property**](ApiSetAuthUnitPropertyApi.md#register_unit_property) | **POST** /unit-property/new | Register an Unit Property +# \\ApiSetAuthUnitPropertyApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| --------------------------------------------------------------------------------- | --------------------------- | ------------------------- | +| [**register_unit_property**](ApiSetAuthUnitPropertyApi.md#register_unit_property) | **POST** /unit-property/new | Register an Unit Property | ## register_unit_property -> models::UnitPropertyId register_unit_property(unit_property_stub) -Register an Unit Property +> models::UnitPropertyId register_unit_property(unit_property_stub) Register an +> Unit Property ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**unit_property_stub** | [**UnitPropertyStub**](UnitPropertyStub.md) | | [required] | +| Name | Type | Description | Required | Notes | +| ---------------------- | ------------------------------------------- | ----------- | ---------- | ----- | +| **unit_property_stub** | [**UnitPropertyStub**](UnitPropertyStub.md) | | [required] | ### Return type @@ -33,5 +30,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) diff --git a/crates/rocie-client/docs/ApiSetAuthUserApi.md b/crates/rocie-client/docs/ApiSetAuthUserApi.md index 7409a8a..77bdd60 100644 --- a/crates/rocie-client/docs/ApiSetAuthUserApi.md +++ b/crates/rocie-client/docs/ApiSetAuthUserApi.md @@ -1,24 +1,20 @@ -# \ApiSetAuthUserApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**register_user**](ApiSetAuthUserApi.md#register_user) | **POST** /user/new | Register an new User +# \\ApiSetAuthUserApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| ------------------------------------------------------- | ------------------ | -------------------- | +| [**register_user**](ApiSetAuthUserApi.md#register_user) | **POST** /user/new | Register an new User | ## register_user -> models::UserId register_user(user_stub) -Register an new User +> models::UserId register_user(user_stub) Register an new User ### 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 @@ -33,5 +29,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) diff --git a/crates/rocie-client/docs/ApiSetBarcodeApi.md b/crates/rocie-client/docs/ApiSetBarcodeApi.md index 905a299..f3e8e3f 100644 --- a/crates/rocie-client/docs/ApiSetBarcodeApi.md +++ b/crates/rocie-client/docs/ApiSetBarcodeApi.md @@ -1,30 +1,26 @@ -# \ApiSetBarcodeApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**buy_barcode**](ApiSetBarcodeApi.md#buy_barcode) | **POST** /barcode/{barcode_id}/buy/{times} | Buy an barcode -[**consume_barcode**](ApiSetBarcodeApi.md#consume_barcode) | **POST** /barcode/{id}/consume | Consume an barcode +# \\ApiSetBarcodeApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| ---------------------------------------------------------- | ------------------------------------------ | ------------------ | +| [**buy_barcode**](ApiSetBarcodeApi.md#buy_barcode) | **POST** /barcode/{barcode_id}/buy/{times} | Buy an barcode | +| [**consume_barcode**](ApiSetBarcodeApi.md#consume_barcode) | **POST** /barcode/{id}/consume | Consume an barcode | ## buy_barcode -> buy_barcode(barcode_id, times) -Buy an barcode +> buy_barcode(barcode_id, times) Buy an barcode ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**barcode_id** | [**BarcodeId**](.md) | The numeric value of the barcode | [required] | -**times** | **u32** | How often to buy the barcode | [required] | +| Name | Type | Description | Required | Notes | +| -------------- | -------------------- | -------------------------------- | ---------- | ----- | +| **barcode_id** | [**BarcodeId**](.md) | The numeric value of the barcode | [required] | +| **times** | **u32** | How often to buy the barcode | [required] | ### Return type - (empty response body) +(empty response body) ### Authorization @@ -35,25 +31,25 @@ 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) ## consume_barcode -> consume_barcode(id, unit_amount) -Consume an barcode +> consume_barcode(id, unit_amount) Consume an barcode ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**BarcodeId**](.md) | The numeric value of the barcode | [required] | -**unit_amount** | [**UnitAmount**](UnitAmount.md) | | [required] | +| Name | Type | Description | Required | Notes | +| --------------- | ------------------------------- | -------------------------------- | ---------- | ----- | +| **id** | [**BarcodeId**](.md) | The numeric value of the barcode | [required] | +| **unit_amount** | [**UnitAmount**](UnitAmount.md) | | [required] | ### Return type - (empty response body) +(empty response body) ### Authorization @@ -64,5 +60,7 @@ 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) 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) diff --git a/crates/rocie-client/docs/ApiSetProductApi.md b/crates/rocie-client/docs/ApiSetProductApi.md index bb4ca4e..7b4ee8a 100644 --- a/crates/rocie-client/docs/ApiSetProductApi.md +++ b/crates/rocie-client/docs/ApiSetProductApi.md @@ -1,30 +1,26 @@ -# \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 +# \\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 +> associate_barcode(id, barcode) Associate a barcode with a product ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**ProductId**](.md) | The id of the product to associated the barcode with | [required] | -**barcode** | [**Barcode**](Barcode.md) | | [required] | +| Name | Type | Description | Required | Notes | +| ----------- | ------------------------- | ---------------------------------------------------- | ---------- | ----- | +| **id** | [**ProductId**](.md) | The id of the product to associated the barcode with | [required] | +| **barcode** | [**Barcode**](Barcode.md) | | [required] | ### Return type - (empty response body) +(empty response body) ### Authorization @@ -35,20 +31,20 @@ 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) ## register_product -> models::ProductId register_product(product_stub) -Register a product +> models::ProductId register_product(product_stub) Register a product ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**product_stub** | [**ProductStub**](ProductStub.md) | | [required] | +| Name | Type | Description | Required | Notes | +| ---------------- | --------------------------------- | ----------- | ---------- | ----- | +| **product_stub** | [**ProductStub**](ProductStub.md) | | [required] | ### Return type @@ -63,5 +59,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) diff --git a/crates/rocie-client/docs/ApiSetProductParentApi.md b/crates/rocie-client/docs/ApiSetProductParentApi.md index 116175c..56caecb 100644 --- a/crates/rocie-client/docs/ApiSetProductParentApi.md +++ b/crates/rocie-client/docs/ApiSetProductParentApi.md @@ -1,24 +1,21 @@ -# \ApiSetProductParentApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**register_product_parent**](ApiSetProductParentApi.md#register_product_parent) | **POST** /product_parent/new | Register a product parent +# \\ApiSetProductParentApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| -------------------------------------------------------------------------------- | ---------------------------- | ------------------------- | +| [**register_product_parent**](ApiSetProductParentApi.md#register_product_parent) | **POST** /product_parent/new | Register a product parent | ## register_product_parent -> models::ProductParentId register_product_parent(product_parent_stub) -Register a product parent +> models::ProductParentId register_product_parent(product_parent_stub) Register +> a product parent ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**product_parent_stub** | [**ProductParentStub**](ProductParentStub.md) | | [required] | +| Name | Type | Description | Required | Notes | +| ----------------------- | --------------------------------------------- | ----------- | ---------- | ----- | +| **product_parent_stub** | [**ProductParentStub**](ProductParentStub.md) | | [required] | ### Return type @@ -33,5 +30,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) diff --git a/crates/rocie-client/docs/ApiSetRecipeApi.md b/crates/rocie-client/docs/ApiSetRecipeApi.md index 00f2670..96f77fa 100644 --- a/crates/rocie-client/docs/ApiSetRecipeApi.md +++ b/crates/rocie-client/docs/ApiSetRecipeApi.md @@ -1,24 +1,20 @@ -# \ApiSetRecipeApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**add_recipe**](ApiSetRecipeApi.md#add_recipe) | **POST** /recipe/new | Register a product parent +# \\ApiSetRecipeApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| ----------------------------------------------- | -------------------- | ------------------------- | +| [**add_recipe**](ApiSetRecipeApi.md#add_recipe) | **POST** /recipe/new | Register a product parent | ## add_recipe -> models::RecipeId add_recipe(recipe_stub) -Register a product parent +> models::RecipeId add_recipe(recipe_stub) Register a product parent ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**recipe_stub** | [**RecipeStub**](RecipeStub.md) | | [required] | +| Name | Type | Description | Required | Notes | +| --------------- | ------------------------------- | ----------- | ---------- | ----- | +| **recipe_stub** | [**RecipeStub**](RecipeStub.md) | | [required] | ### Return type @@ -33,5 +29,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) diff --git a/crates/rocie-client/docs/ApiSetUnitApi.md b/crates/rocie-client/docs/ApiSetUnitApi.md index ebe8e5c..e657e3a 100644 --- a/crates/rocie-client/docs/ApiSetUnitApi.md +++ b/crates/rocie-client/docs/ApiSetUnitApi.md @@ -1,24 +1,20 @@ -# \ApiSetUnitApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**register_unit**](ApiSetUnitApi.md#register_unit) | **POST** /unit/new | Register an Unit +# \\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 -> models::UnitId register_unit(unit_stub) -Register an Unit +> models::UnitId register_unit(unit_stub) Register an Unit ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**unit_stub** | [**UnitStub**](UnitStub.md) | | [required] | +| Name | Type | Description | Required | Notes | +| ------------- | --------------------------- | ----------- | ---------- | ----- | +| **unit_stub** | [**UnitStub**](UnitStub.md) | | [required] | ### Return type @@ -33,5 +29,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) diff --git a/crates/rocie-client/docs/ApiSetUnitPropertyApi.md b/crates/rocie-client/docs/ApiSetUnitPropertyApi.md index b54aec1..af7cf41 100644 --- a/crates/rocie-client/docs/ApiSetUnitPropertyApi.md +++ b/crates/rocie-client/docs/ApiSetUnitPropertyApi.md @@ -1,24 +1,21 @@ -# \ApiSetUnitPropertyApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**register_unit_property**](ApiSetUnitPropertyApi.md#register_unit_property) | **POST** /unit-property/new | Register an Unit Property +# \\ApiSetUnitPropertyApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| ----------------------------------------------------------------------------- | --------------------------- | ------------------------- | +| [**register_unit_property**](ApiSetUnitPropertyApi.md#register_unit_property) | **POST** /unit-property/new | Register an Unit Property | ## register_unit_property -> models::UnitPropertyId register_unit_property(unit_property_stub) -Register an Unit Property +> models::UnitPropertyId register_unit_property(unit_property_stub) Register an +> Unit Property ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**unit_property_stub** | [**UnitPropertyStub**](UnitPropertyStub.md) | | [required] | +| Name | Type | Description | Required | Notes | +| ---------------------- | ------------------------------------------- | ----------- | ---------- | ----- | +| **unit_property_stub** | [**UnitPropertyStub**](UnitPropertyStub.md) | | [required] | ### Return type @@ -33,5 +30,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) diff --git a/crates/rocie-client/docs/BarCode.md b/crates/rocie-client/docs/BarCode.md index 8c58cb3..7d3afd5 100644 --- a/crates/rocie-client/docs/BarCode.md +++ b/crates/rocie-client/docs/BarCode.md @@ -2,10 +2,10 @@ ## 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) - +| 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 index 622b82d..7d84458 100644 --- a/crates/rocie-client/docs/Barcode.md +++ b/crates/rocie-client/docs/Barcode.md @@ -2,11 +2,11 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**amount** | [**models::UnitAmount**](UnitAmount.md) | | -**id** | [**models::BarcodeId**](BarcodeId.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) - - +| Name | Type | Description | Notes | +| ---------- | --------------------------------------- | ----------- | ----- | +| **amount** | [**models::UnitAmount**](UnitAmount.md) | | +| **id** | [**models::BarcodeId**](BarcodeId.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) diff --git a/crates/rocie-client/docs/BarcodeId.md b/crates/rocie-client/docs/BarcodeId.md index 630e07f..b180bd9 100644 --- a/crates/rocie-client/docs/BarcodeId.md +++ b/crates/rocie-client/docs/BarcodeId.md @@ -2,10 +2,10 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | **u32** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - +| Name | Type | Description | Notes | +| --------- | ------- | ----------- | ----- | +| **value** | **u32** | | +[[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/LoginInfo.md b/crates/rocie-client/docs/LoginInfo.md index 699a685..97c02c4 100644 --- a/crates/rocie-client/docs/LoginInfo.md +++ b/crates/rocie-client/docs/LoginInfo.md @@ -2,11 +2,11 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | [**models::UserId**](UserId.md) | The id of the user. | -**password** | **String** | The password of the user. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - +| Name | Type | Description | Notes | +| ------------ | ------------------------------- | ------------------------- | ----- | +| **id** | [**models::UserId**](UserId.md) | The id of the user. | +| **password** | **String** | The password of the user. | + +[[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/PasswordHash.md b/crates/rocie-client/docs/PasswordHash.md index ac022d2..208e234 100644 --- a/crates/rocie-client/docs/PasswordHash.md +++ b/crates/rocie-client/docs/PasswordHash.md @@ -2,10 +2,10 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | **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) - +| Name | Type | Description | Notes | +| --------- | ---------- | ----------- | ----- | +| **value** | **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/Product.md b/crates/rocie-client/docs/Product.md index 83536ff..7e4bdf6 100644 --- a/crates/rocie-client/docs/Product.md +++ b/crates/rocie-client/docs/Product.md @@ -2,15 +2,15 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**associated_bar_codes** | [**Vec<models::Barcode>**](Barcode.md) | Which barcodes are associated with this product. | -**description** | Option<**String**> | An optional description of this product. | [optional] -**id** | [**models::ProductId**](ProductId.md) | The id of the product. | -**name** | **String** | The name of the product. This should be globally unique, to make searching easier for the user. | -**parent** | Option<[**models::ProductParentId**](ProductParentId.md)> | The parent this product has. This is effectively it's anchor in the product DAG. | [optional] -**unit_property** | [**models::UnitPropertyId**](UnitPropertyId.md) | The property this product is measured in. (This is probably always either Mass, Volume or Quantity). | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - +| Name | Type | Description | Notes | +| ------------------------ | ---------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------- | +| **associated_bar_codes** | [**Vec<models::Barcode>**](Barcode.md) | Which barcodes are associated with this product. | +| **description** | Option\<**String**> | An optional description of this product. | [optional] | +| **id** | [**models::ProductId**](ProductId.md) | The id of the product. | +| **name** | **String** | The name of the product. This should be globally unique, to make searching easier for the user. | +| **parent** | Option\<[**models::ProductParentId**](ProductParentId.md)> | The parent this product has. This is effectively it's anchor in the product DAG. | [optional] | +| **unit_property** | [**models::UnitPropertyId**](UnitPropertyId.md) | The property this product is measured in. (This is probably always either Mass, Volume or Quantity). | +[[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 index ac5d9cc..7a841bf 100644 --- a/crates/rocie-client/docs/ProductAmount.md +++ b/crates/rocie-client/docs/ProductAmount.md @@ -2,11 +2,11 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**amount** | [**models::UnitAmount**](UnitAmount.md) | | -**product_id** | [**models::ProductId**](ProductId.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) - - +| Name | Type | Description | Notes | +| -------------- | --------------------------------------- | ----------- | ----- | +| **amount** | [**models::UnitAmount**](UnitAmount.md) | | +| **product_id** | [**models::ProductId**](ProductId.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) diff --git a/crates/rocie-client/docs/ProductId.md b/crates/rocie-client/docs/ProductId.md index 90dc866..af4e0a9 100644 --- a/crates/rocie-client/docs/ProductId.md +++ b/crates/rocie-client/docs/ProductId.md @@ -2,10 +2,10 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | [**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) - +| Name | Type | Description | Notes | +| --------- | ------------------------------- | ----------- | ----- | +| **value** | [**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) diff --git a/crates/rocie-client/docs/ProductOneOf.md b/crates/rocie-client/docs/ProductOneOf.md index 1ab44aa..cd45cc7 100644 --- a/crates/rocie-client/docs/ProductOneOf.md +++ b/crates/rocie-client/docs/ProductOneOf.md @@ -2,10 +2,10 @@ ## 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) - +| 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 index f395a25..10b5205 100644 --- a/crates/rocie-client/docs/ProductOneOf1.md +++ b/crates/rocie-client/docs/ProductOneOf1.md @@ -2,10 +2,10 @@ ## 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) - +| 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/ProductParent.md b/crates/rocie-client/docs/ProductParent.md index a63384b..8cb0028 100644 --- a/crates/rocie-client/docs/ProductParent.md +++ b/crates/rocie-client/docs/ProductParent.md @@ -2,13 +2,13 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | Option<**String**> | An optional description of this product parent. | [optional] -**id** | [**models::ProductParentId**](ProductParentId.md) | The id of the product parent. | -**name** | **String** | The name of the product parent. This should be globally unique, to make searching easier for the user. | -**parent** | Option<[**models::ProductParentId**](ProductParentId.md)> | The optional id of the parent of this product parent. This must not form a cycle. | [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) - - +| Name | Type | Description | Notes | +| --------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | ---------- | +| **description** | Option\<**String**> | An optional description of this product parent. | [optional] | +| **id** | [**models::ProductParentId**](ProductParentId.md) | The id of the product parent. | +| **name** | **String** | The name of the product parent. This should be globally unique, to make searching easier for the user. | +| **parent** | Option\<[**models::ProductParentId**](ProductParentId.md)> | The optional id of the parent of this product parent. This must not form a cycle. | [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/ProductParentId.md b/crates/rocie-client/docs/ProductParentId.md index c9163f4..49f4e17 100644 --- a/crates/rocie-client/docs/ProductParentId.md +++ b/crates/rocie-client/docs/ProductParentId.md @@ -2,10 +2,10 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | [**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) - +| Name | Type | Description | Notes | +| --------- | ------------------------------- | ----------- | ----- | +| **value** | [**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) diff --git a/crates/rocie-client/docs/ProductParentStub.md b/crates/rocie-client/docs/ProductParentStub.md index c15118e..a8a3544 100644 --- a/crates/rocie-client/docs/ProductParentStub.md +++ b/crates/rocie-client/docs/ProductParentStub.md @@ -2,12 +2,12 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | Option<**String**> | A description. | [optional] -**name** | **String** | The name of the product parent | -**parent** | Option<[**models::ProductParentId**](ProductParentId.md)> | A parent of this product parent, otherwise the parent will be the root of the parent tree. | [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) - - +| Name | Type | Description | Notes | +| --------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ---------- | +| **description** | Option\<**String**> | A description. | [optional] | +| **name** | **String** | The name of the product parent | +| **parent** | Option\<[**models::ProductParentId**](ProductParentId.md)> | A parent of this product parent, otherwise the parent will be the root of the parent tree. | [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/ProductStub.md b/crates/rocie-client/docs/ProductStub.md index 10d783b..3c25dd4 100644 --- a/crates/rocie-client/docs/ProductStub.md +++ b/crates/rocie-client/docs/ProductStub.md @@ -2,13 +2,13 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | Option<**String**> | A description. | [optional] -**name** | **String** | The name of the product | -**parent** | Option<[**models::ProductParentId**](ProductParentId.md)> | A parent of this product, otherwise the parent will be the root of the parent tree. | [optional] -**unit_property** | [**models::UnitPropertyId**](UnitPropertyId.md) | The Unit Property to use for this product. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - +| Name | Type | Description | Notes | +| ----------------- | ---------------------------------------------------------- | ----------------------------------------------------------------------------------- | ---------- | +| **description** | Option\<**String**> | A description. | [optional] | +| **name** | **String** | The name of the product | +| **parent** | Option\<[**models::ProductParentId**](ProductParentId.md)> | A parent of this product, otherwise the parent will be the root of the parent tree. | [optional] | +| **unit_property** | [**models::UnitPropertyId**](UnitPropertyId.md) | The Unit Property to use for this product. | + +[[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/Recipe.md b/crates/rocie-client/docs/Recipe.md index d179f97..d2aa0f9 100644 --- a/crates/rocie-client/docs/Recipe.md +++ b/crates/rocie-client/docs/Recipe.md @@ -2,12 +2,12 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**content** | **String** | | -**id** | [**models::RecipeId**](RecipeId.md) | | -**path** | **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) - - +| Name | Type | Description | Notes | +| ----------- | ----------------------------------- | ----------- | ----- | +| **content** | **String** | | +| **id** | [**models::RecipeId**](RecipeId.md) | | +| **path** | **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/RecipeId.md b/crates/rocie-client/docs/RecipeId.md index 5211596..812de9a 100644 --- a/crates/rocie-client/docs/RecipeId.md +++ b/crates/rocie-client/docs/RecipeId.md @@ -2,10 +2,10 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | [**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) - +| Name | Type | Description | Notes | +| --------- | ------------------------------- | ----------- | ----- | +| **value** | [**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) diff --git a/crates/rocie-client/docs/RecipeStub.md b/crates/rocie-client/docs/RecipeStub.md index 4545fff..b123337 100644 --- a/crates/rocie-client/docs/RecipeStub.md +++ b/crates/rocie-client/docs/RecipeStub.md @@ -2,11 +2,11 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**content** | **String** | The content of this recipe, in cooklang format | -**path** | **String** | The path the recipe should have | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - +| Name | Type | Description | Notes | +| ----------- | ---------- | ---------------------------------------------- | ----- | +| **content** | **String** | The content of this recipe, in cooklang format | +| **path** | **String** | The path the recipe should have | + +[[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 index 5349b7a..2db7b1a 100644 --- a/crates/rocie-client/docs/Unit.md +++ b/crates/rocie-client/docs/Unit.md @@ -2,15 +2,15 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | Option<**String**> | Description of this unit. | [optional] -**full_name_plural** | **String** | The plural version of this unit's name. Is used by a value of two and more. (We do not support Slovenian dual numerus versions) E.g.: Kilogram -> Kilograms gram -> meters | -**full_name_singular** | **String** | The singular version of this unit's name. E.g.: Kilogram Gram | -**id** | [**models::UnitId**](UnitId.md) | Unique id for this unit. | -**short_name** | **String** | Short name or abbreviation of this unit. E.g.: kg for Kilogram g for gram m for meter | -**unit_property** | [**models::UnitPropertyId**](UnitPropertyId.md) | Which property is described by this unit. E.g.: kg -> Mass L -> Volume m/s -> Speed and so forth | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - +| Name | Type | Description | Notes | +| ---------------------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **description** | Option\<**String**> | Description of this unit. | [optional] | +| **full_name_plural** | **String** | The plural version of this unit's name. Is used by a value of two and more. (We do not support Slovenian dual numerus versions) E.g.: Kilogram -> Kilograms gram -> meters | +| **full_name_singular** | **String** | The singular version of this unit's name. E.g.: Kilogram Gram | +| **id** | [**models::UnitId**](UnitId.md) | Unique id for this unit. | +| **short_name** | **String** | Short name or abbreviation of this unit. E.g.: kg for Kilogram g for gram m for meter | +| **unit_property** | [**models::UnitPropertyId**](UnitPropertyId.md) | Which property is described by this unit. E.g.: kg -> Mass L -> Volume m/s -> Speed and so forth | +[[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 1546f57..1bb855d 100644 --- a/crates/rocie-client/docs/UnitAmount.md +++ b/crates/rocie-client/docs/UnitAmount.md @@ -2,11 +2,11 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**unit** | [**models::UnitId**](UnitId.md) | | -**value** | **u32** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - +| Name | Type | Description | Notes | +| --------- | ------------------------------- | ----------- | ----- | +| **unit** | [**models::UnitId**](UnitId.md) | | +| **value** | **u32** | | + +[[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/UnitId.md b/crates/rocie-client/docs/UnitId.md index 7d0979c..551eda2 100644 --- a/crates/rocie-client/docs/UnitId.md +++ b/crates/rocie-client/docs/UnitId.md @@ -2,10 +2,10 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | [**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) - +| Name | Type | Description | Notes | +| --------- | ------------------------------- | ----------- | ----- | +| **value** | [**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) diff --git a/crates/rocie-client/docs/UnitProperty.md b/crates/rocie-client/docs/UnitProperty.md index b560f0c..fc6bfc9 100644 --- a/crates/rocie-client/docs/UnitProperty.md +++ b/crates/rocie-client/docs/UnitProperty.md @@ -2,13 +2,13 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | Option<**String**> | An description of this property. | [optional] -**id** | [**models::UnitPropertyId**](UnitPropertyId.md) | The unique ID for this unit property. | -**name** | **String** | The user-displayed name of this property. | -**units** | [**Vec<models::UnitId>**](UnitId.md) | The units with are measuring this property. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - +| Name | Type | Description | Notes | +| --------------- | ----------------------------------------------- | ------------------------------------------- | ---------- | +| **description** | Option\<**String**> | An description of this property. | [optional] | +| **id** | [**models::UnitPropertyId**](UnitPropertyId.md) | The unique ID for this unit property. | +| **name** | **String** | The user-displayed name of this property. | +| **units** | [**Vec<models::UnitId>**](UnitId.md) | The units with are measuring this property. | + +[[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/UnitPropertyId.md b/crates/rocie-client/docs/UnitPropertyId.md index 34d572f..7a228c1 100644 --- a/crates/rocie-client/docs/UnitPropertyId.md +++ b/crates/rocie-client/docs/UnitPropertyId.md @@ -2,10 +2,10 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | [**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) - +| Name | Type | Description | Notes | +| --------- | ------------------------------- | ----------- | ----- | +| **value** | [**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) diff --git a/crates/rocie-client/docs/UnitPropertyStub.md b/crates/rocie-client/docs/UnitPropertyStub.md index 0fae3f7..e537d6f 100644 --- a/crates/rocie-client/docs/UnitPropertyStub.md +++ b/crates/rocie-client/docs/UnitPropertyStub.md @@ -2,11 +2,11 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | Option<**String**> | An optional description of the unit property. | [optional] -**name** | **String** | The name of the unit property. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - +| Name | Type | Description | Notes | +| --------------- | ------------------- | --------------------------------------------- | ---------- | +| **description** | Option\<**String**> | An optional description of the unit property. | [optional] | +| **name** | **String** | The name of the unit property. | + +[[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 index 92398c5..5b89817 100644 --- a/crates/rocie-client/docs/UnitStub.md +++ b/crates/rocie-client/docs/UnitStub.md @@ -2,14 +2,14 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | Option<**String**> | | [optional] -**full_name_plural** | **String** | | -**full_name_singular** | **String** | | -**short_name** | **String** | | -**unit_property** | [**models::UnitPropertyId**](UnitPropertyId.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) - - +| Name | Type | Description | Notes | +| ---------------------- | ----------------------------------------------- | ----------- | ---------- | +| **description** | Option\<**String**> | | [optional] | +| **full_name_plural** | **String** | | +| **full_name_singular** | **String** | | +| **short_name** | **String** | | +| **unit_property** | [**models::UnitPropertyId**](UnitPropertyId.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) diff --git a/crates/rocie-client/docs/User.md b/crates/rocie-client/docs/User.md index d0f2a81..016740a 100644 --- a/crates/rocie-client/docs/User.md +++ b/crates/rocie-client/docs/User.md @@ -2,13 +2,13 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | Option<**String**> | An description of this user. | [optional] -**id** | [**models::UserId**](UserId.md) | The unique ID for this user. | -**name** | **String** | The user-displayed name of this user. | -**password_hash** | [**models::PasswordHash**](PasswordHash.md) | The hash of the user's password. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - +| Name | Type | Description | Notes | +| ----------------- | ------------------------------------------- | ------------------------------------- | ---------- | +| **description** | Option\<**String**> | An description of this user. | [optional] | +| **id** | [**models::UserId**](UserId.md) | The unique ID for this user. | +| **name** | **String** | The user-displayed name of this user. | +| **password_hash** | [**models::PasswordHash**](PasswordHash.md) | The hash of the user's password. | + +[[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/UserId.md b/crates/rocie-client/docs/UserId.md index f183106..b58b3dc 100644 --- a/crates/rocie-client/docs/UserId.md +++ b/crates/rocie-client/docs/UserId.md @@ -2,10 +2,10 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | [**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) - +| Name | Type | Description | Notes | +| --------- | ------------------------------- | ----------- | ----- | +| **value** | [**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) diff --git a/crates/rocie-client/docs/UserStub.md b/crates/rocie-client/docs/UserStub.md index 60bd072..ef83846 100644 --- a/crates/rocie-client/docs/UserStub.md +++ b/crates/rocie-client/docs/UserStub.md @@ -2,12 +2,12 @@ ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | Option<**String**> | An optional description of the new user. | [optional] -**name** | **String** | The name of the new user. | -**password** | **String** | The password of the new user. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - +| Name | Type | Description | Notes | +| --------------- | ------------------- | ---------------------------------------- | ---------- | +| **description** | Option\<**String**> | An optional description of the new user. | [optional] | +| **name** | **String** | The name of the new user. | +| **password** | **String** | The password of the new user. | + +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to README]](../README.md) |