diff options
Diffstat (limited to 'crates/rocie-client/docs')
73 files changed, 878 insertions, 881 deletions
diff --git a/crates/rocie-client/docs/ApiGetAuthInventoryApi.md b/crates/rocie-client/docs/ApiGetAuthInventoryApi.md index d43db67..196b28c 100644 --- a/crates/rocie-client/docs/ApiGetAuthInventoryApi.md +++ b/crates/rocie-client/docs/ApiGetAuthInventoryApi.md @@ -10,27 +10,23 @@ You should have received a copy of the License along with this program. If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. --> -# \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 @@ -45,5 +41,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 cb7fb13..bcf2013 100644 --- a/crates/rocie-client/docs/ApiGetAuthProductApi.md +++ b/crates/rocie-client/docs/ApiGetAuthProductApi.md @@ -10,34 +10,30 @@ You should have received a copy of the License along with this program. If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. --> -# \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 -[**products_without_product_parent**](ApiGetAuthProductApi.md#products_without_product_parent) | **GET** /product/without-product-parent | Get Products by it's absents of a product parent +# \\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 | +| [**products_without_product_parent**](ApiGetAuthProductApi.md#products_without_product_parent) | **GET** /product/without-product-parent | Get Products by it's absents of a product parent | ## 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 @@ -52,20 +48,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 @@ -80,20 +76,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 @@ -108,22 +105,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 @@ -138,22 +136,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 @@ -168,13 +167,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 @@ -193,13 +194,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 @@ -218,13 +220,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_without_product_parent -> Vec<models::Product> products_without_product_parent() -Get Products by it's absents of a product parent +> Vec<models::Product> products_without_product_parent() Get Products by it's +> absents of a product parent This will only return products without a product parent associated with it @@ -245,5 +249,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 a0e7203..826add0 100644 --- a/crates/rocie-client/docs/ApiGetAuthProductParentApi.md +++ b/crates/rocie-client/docs/ApiGetAuthProductParentApi.md @@ -10,22 +10,20 @@ You should have received a copy of the License along with this program. If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. --> -# \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 @@ -44,13 +42,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 @@ -69,20 +69,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 @@ -97,5 +98,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 fdd832e..f690fbf 100644 --- a/crates/rocie-client/docs/ApiGetAuthRecipeApi.md +++ b/crates/rocie-client/docs/ApiGetAuthRecipeApi.md @@ -10,32 +10,28 @@ You should have received a copy of the License along with this program. If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. --> -# \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. -[**recipe_by_name**](ApiGetAuthRecipeApi.md#recipe_by_name) | **GET** /recipe/by-name/{name} | Get an recipe by it's name. -[**recipes**](ApiGetAuthRecipeApi.md#recipes) | **GET** /recipe/all | Get all added recipes -[**recipes_by_recipe_parent_id_direct**](ApiGetAuthRecipeApi.md#recipes_by_recipe_parent_id_direct) | **GET** /recipe/by-recipe-parent-id-direct/{id} | Get Recipes by it's recipe parent id -[**recipes_by_recipe_parent_id_indirect**](ApiGetAuthRecipeApi.md#recipes_by_recipe_parent_id_indirect) | **GET** /recipe/by-recipe-parent-id-indirect/{id} | Get Recipes by it's recipe parent id -[**recipes_without_recipe_parent**](ApiGetAuthRecipeApi.md#recipes_without_recipe_parent) | **GET** /recipe/without-recipe-parent | Get Recipes by it's absents of a recipe parent +# \\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. | +| [**recipe_by_name**](ApiGetAuthRecipeApi.md#recipe_by_name) | **GET** /recipe/by-name/{name} | Get an recipe by it's name. | +| [**recipes**](ApiGetAuthRecipeApi.md#recipes) | **GET** /recipe/all | Get all added recipes | +| [**recipes_by_recipe_parent_id_direct**](ApiGetAuthRecipeApi.md#recipes_by_recipe_parent_id_direct) | **GET** /recipe/by-recipe-parent-id-direct/{id} | Get Recipes by it's recipe parent id | +| [**recipes_by_recipe_parent_id_indirect**](ApiGetAuthRecipeApi.md#recipes_by_recipe_parent_id_indirect) | **GET** /recipe/by-recipe-parent-id-indirect/{id} | Get Recipes by it's recipe parent id | +| [**recipes_without_recipe_parent**](ApiGetAuthRecipeApi.md#recipes_without_recipe_parent) | **GET** /recipe/without-recipe-parent | Get Recipes by it's absents of a recipe parent | ## 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 @@ -50,20 +46,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) ## recipe_by_name -> models::Recipe recipe_by_name(name) -Get an recipe by it's name. +> models::Recipe recipe_by_name(name) Get an recipe by it's name. ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**name** | **String** | Recipe name | [required] | +| Name | Type | Description | Required | Notes | +| -------- | ---------- | ----------- | ---------- | ----- | +| **name** | **String** | Recipe name | [required] | ### Return type @@ -78,13 +74,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 -> Vec<models::Recipe> recipes() -Get all added recipes +> Vec<models::Recipe> recipes() Get all added recipes ### Parameters @@ -103,22 +100,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) ## recipes_by_recipe_parent_id_direct -> Vec<models::Recipe> recipes_by_recipe_parent_id_direct(id) -Get Recipes by it's recipe parent id +> Vec<models::Recipe> recipes_by_recipe_parent_id_direct(id) Get Recipes by it's +> recipe parent id This will only return recipes directly associated with this recipe parent id ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**RecipeParentId**](.md) | Recipe parent id | [required] | +| Name | Type | Description | Required | Notes | +| ------ | ------------------------- | ---------------- | ---------- | ----- | +| **id** | [**RecipeParentId**](.md) | Recipe parent id | [required] | ### Return type @@ -133,22 +131,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) ## recipes_by_recipe_parent_id_indirect -> Vec<models::Recipe> recipes_by_recipe_parent_id_indirect(id) -Get Recipes by it's recipe parent id +> Vec<models::Recipe> recipes_by_recipe_parent_id_indirect(id) Get Recipes by +> it's recipe parent id This will also return all recipes below this recipe parent id ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**RecipeParentId**](.md) | Recipe parent id | [required] | +| Name | Type | Description | Required | Notes | +| ------ | ------------------------- | ---------------- | ---------- | ----- | +| **id** | [**RecipeParentId**](.md) | Recipe parent id | [required] | ### Return type @@ -163,13 +162,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) ## recipes_without_recipe_parent -> Vec<models::Recipe> recipes_without_recipe_parent() -Get Recipes by it's absents of a recipe parent +> Vec<models::Recipe> recipes_without_recipe_parent() Get Recipes by it's +> absents of a recipe parent This will only return recipes without a recipe parent associated with it @@ -190,5 +191,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/ApiGetAuthRecipeParentApi.md b/crates/rocie-client/docs/ApiGetAuthRecipeParentApi.md index 17c1aca..fa5bb89 100644 --- a/crates/rocie-client/docs/ApiGetAuthRecipeParentApi.md +++ b/crates/rocie-client/docs/ApiGetAuthRecipeParentApi.md @@ -10,22 +10,20 @@ You should have received a copy of the License along with this program. If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. --> -# \ApiGetAuthRecipeParentApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**recipe_parents**](ApiGetAuthRecipeParentApi.md#recipe_parents) | **GET** /recipe_parents/ | Return all registered recipe parents -[**recipe_parents_toplevel**](ApiGetAuthRecipeParentApi.md#recipe_parents_toplevel) | **GET** /recipe_parents_toplevel/ | Return all registered recipe parents, that have no parents themselves -[**recipe_parents_under**](ApiGetAuthRecipeParentApi.md#recipe_parents_under) | **GET** /recipe_parents_under/{id} | Return all parents, that have this parent as parent +# \\ApiGetAuthRecipeParentApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| ----------------------------------------------------------------------------------- | ---------------------------------- | --------------------------------------------------------------------- | +| [**recipe_parents**](ApiGetAuthRecipeParentApi.md#recipe_parents) | **GET** /recipe_parents/ | Return all registered recipe parents | +| [**recipe_parents_toplevel**](ApiGetAuthRecipeParentApi.md#recipe_parents_toplevel) | **GET** /recipe_parents_toplevel/ | Return all registered recipe parents, that have no parents themselves | +| [**recipe_parents_under**](ApiGetAuthRecipeParentApi.md#recipe_parents_under) | **GET** /recipe_parents_under/{id} | Return all parents, that have this parent as parent | ## recipe_parents -> Vec<models::RecipeParent> recipe_parents() -Return all registered recipe parents +> Vec<models::RecipeParent> recipe_parents() Return all registered recipe +> parents ### Parameters @@ -44,13 +42,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) ## recipe_parents_toplevel -> Vec<models::RecipeParent> recipe_parents_toplevel() -Return all registered recipe parents, that have no parents themselves +> Vec<models::RecipeParent> recipe_parents_toplevel() Return all registered +> recipe parents, that have no parents themselves ### Parameters @@ -69,20 +69,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) ## recipe_parents_under -> Vec<models::RecipeParent> recipe_parents_under(id) -Return all parents, that have this parent as parent +> Vec<models::RecipeParent> recipe_parents_under(id) Return all parents, that +> have this parent as parent ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**RecipeParentId**](.md) | Recipe parent id | [required] | +| Name | Type | Description | Required | Notes | +| ------ | ------------------------- | ---------------- | ---------- | ----- | +| **id** | [**RecipeParentId**](.md) | Recipe parent id | [required] | ### Return type @@ -97,5 +98,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/ApiGetAuthRefinedRecipeApi.md b/crates/rocie-client/docs/ApiGetAuthRefinedRecipeApi.md index 35bf5a5..9e991ae 100644 --- a/crates/rocie-client/docs/ApiGetAuthRefinedRecipeApi.md +++ b/crates/rocie-client/docs/ApiGetAuthRefinedRecipeApi.md @@ -10,27 +10,24 @@ You should have received a copy of the License along with this program. If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. --> -# \ApiGetAuthRefinedRecipeApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**refined_recipe_by_id**](ApiGetAuthRefinedRecipeApi.md#refined_recipe_by_id) | **GET** /refined-recipe/by-id/{id} | Get an refined recipe from it's recipe's id. +# \\ApiGetAuthRefinedRecipeApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| ------------------------------------------------------------------------------ | ---------------------------------- | -------------------------------------------- | +| [**refined_recipe_by_id**](ApiGetAuthRefinedRecipeApi.md#refined_recipe_by_id) | **GET** /refined-recipe/by-id/{id} | Get an refined recipe from it's recipe's id. | ## refined_recipe_by_id -> models::RefinedRecipe refined_recipe_by_id(id) -Get an refined recipe from it's recipe's id. +> models::RefinedRecipe refined_recipe_by_id(id) Get an refined recipe from it's +> recipe'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 @@ -45,5 +42,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 e1f1141..8ad20c4 100644 --- a/crates/rocie-client/docs/ApiGetAuthUnitApi.md +++ b/crates/rocie-client/docs/ApiGetAuthUnitApi.md @@ -10,29 +10,25 @@ You should have received a copy of the License along with this program. If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. --> -# \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 @@ -47,13 +43,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 @@ -72,20 +69,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 @@ -100,5 +98,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 422f4c9..35b994b 100644 --- a/crates/rocie-client/docs/ApiGetAuthUnitPropertyApi.md +++ b/crates/rocie-client/docs/ApiGetAuthUnitPropertyApi.md @@ -10,21 +10,19 @@ You should have received a copy of the License along with this program. If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. --> -# \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 @@ -43,20 +41,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 @@ -71,5 +69,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 183db09..cd0a406 100644 --- a/crates/rocie-client/docs/ApiGetAuthUserApi.md +++ b/crates/rocie-client/docs/ApiGetAuthUserApi.md @@ -10,28 +10,24 @@ You should have received a copy of the License along with this program. If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. --> -# \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 @@ -46,13 +42,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 @@ -71,5 +68,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/ApiGetNoAuthStateApi.md b/crates/rocie-client/docs/ApiGetNoAuthStateApi.md index 0d0cbb1..ca13a7d 100644 --- a/crates/rocie-client/docs/ApiGetNoAuthStateApi.md +++ b/crates/rocie-client/docs/ApiGetNoAuthStateApi.md @@ -10,21 +10,18 @@ You should have received a copy of the License along with this program. If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. --> -# \ApiGetNoAuthStateApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**can_be_provisioned**](ApiGetNoAuthStateApi.md#can_be_provisioned) | **GET** /can-be-provisioned | Check if the server can be provisioned -[**is_logged_in**](ApiGetNoAuthStateApi.md#is_logged_in) | **GET** /is-logged-in | Check if you are logged in +# \\ApiGetNoAuthStateApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| -------------------------------------------------------------------- | --------------------------- | -------------------------------------- | +| [**can_be_provisioned**](ApiGetNoAuthStateApi.md#can_be_provisioned) | **GET** /can-be-provisioned | Check if the server can be provisioned | +| [**is_logged_in**](ApiGetNoAuthStateApi.md#is_logged_in) | **GET** /is-logged-in | Check if you are logged in | ## can_be_provisioned -> bool can_be_provisioned() -Check if the server can be provisioned +> bool can_be_provisioned() Check if the server can be provisioned ### Parameters @@ -43,13 +40,14 @@ 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) ## is_logged_in -> bool is_logged_in() -Check if you are logged in +> bool is_logged_in() Check if you are logged in ### Parameters @@ -68,5 +66,7 @@ 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) diff --git a/crates/rocie-client/docs/ApiSetAuthBarcodeApi.md b/crates/rocie-client/docs/ApiSetAuthBarcodeApi.md index d79560b..d81c854 100644 --- a/crates/rocie-client/docs/ApiSetAuthBarcodeApi.md +++ b/crates/rocie-client/docs/ApiSetAuthBarcodeApi.md @@ -10,33 +10,29 @@ You should have received a copy of the License along with this program. If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. --> -# \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 @@ -47,25 +43,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 @@ -76,5 +72,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 c047ea4..40fc7cb 100644 --- a/crates/rocie-client/docs/ApiSetAuthProductApi.md +++ b/crates/rocie-client/docs/ApiSetAuthProductApi.md @@ -10,33 +10,29 @@ You should have received a copy of the License along with this program. If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. --> -# \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 @@ -47,20 +43,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 @@ -75,5 +71,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 e6369c2..00e9234 100644 --- a/crates/rocie-client/docs/ApiSetAuthProductParentApi.md +++ b/crates/rocie-client/docs/ApiSetAuthProductParentApi.md @@ -10,27 +10,24 @@ You should have received a copy of the License along with this program. If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. --> -# \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 @@ -45,5 +42,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 22cf076..ddd425a 100644 --- a/crates/rocie-client/docs/ApiSetAuthRecipeApi.md +++ b/crates/rocie-client/docs/ApiSetAuthRecipeApi.md @@ -10,27 +10,23 @@ You should have received a copy of the License along with this program. If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. --> -# \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 @@ -45,5 +41,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/ApiSetAuthRecipeParentApi.md b/crates/rocie-client/docs/ApiSetAuthRecipeParentApi.md index 6b2b18c..4c34d90 100644 --- a/crates/rocie-client/docs/ApiSetAuthRecipeParentApi.md +++ b/crates/rocie-client/docs/ApiSetAuthRecipeParentApi.md @@ -10,27 +10,24 @@ You should have received a copy of the License along with this program. If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. --> -# \ApiSetAuthRecipeParentApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**register_recipe_parent**](ApiSetAuthRecipeParentApi.md#register_recipe_parent) | **POST** /recipe_parent/new | Register a product parent +# \\ApiSetAuthRecipeParentApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| --------------------------------------------------------------------------------- | --------------------------- | ------------------------- | +| [**register_recipe_parent**](ApiSetAuthRecipeParentApi.md#register_recipe_parent) | **POST** /recipe_parent/new | Register a product parent | ## register_recipe_parent -> models::RecipeParentId register_recipe_parent(recipe_parent_stub) -Register a product parent +> models::RecipeParentId register_recipe_parent(recipe_parent_stub) Register a +> product parent ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**recipe_parent_stub** | [**RecipeParentStub**](RecipeParentStub.md) | | [required] | +| Name | Type | Description | Required | Notes | +| ---------------------- | ------------------------------------------- | ----------- | ---------- | ----- | +| **recipe_parent_stub** | [**RecipeParentStub**](RecipeParentStub.md) | | [required] | ### Return type @@ -45,5 +42,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 ba14750..13326ef 100644 --- a/crates/rocie-client/docs/ApiSetAuthUnitApi.md +++ b/crates/rocie-client/docs/ApiSetAuthUnitApi.md @@ -10,27 +10,23 @@ You should have received a copy of the License along with this program. If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. --> -# \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 @@ -45,5 +41,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 05af1ef..4c40218 100644 --- a/crates/rocie-client/docs/ApiSetAuthUnitPropertyApi.md +++ b/crates/rocie-client/docs/ApiSetAuthUnitPropertyApi.md @@ -10,27 +10,24 @@ You should have received a copy of the License along with this program. If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. --> -# \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 @@ -45,5 +42,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 cc3d5ac..0630617 100644 --- a/crates/rocie-client/docs/ApiSetAuthUserApi.md +++ b/crates/rocie-client/docs/ApiSetAuthUserApi.md @@ -10,27 +10,23 @@ You should have received a copy of the License along with this program. If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. --> -# \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 @@ -45,5 +41,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/ApiSetNoAuthUserApi.md b/crates/rocie-client/docs/ApiSetNoAuthUserApi.md index ab4be8a..0b46ad5 100644 --- a/crates/rocie-client/docs/ApiSetNoAuthUserApi.md +++ b/crates/rocie-client/docs/ApiSetNoAuthUserApi.md @@ -10,33 +10,29 @@ You should have received a copy of the License along with this program. If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. --> -# \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 @@ -47,13 +43,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 @@ -61,7 +58,7 @@ This endpoint does not need any parameter. ### Return type - (empty response body) +(empty response body) ### Authorization @@ -72,22 +69,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(provision_info) -Provision this instance. +> models::UserId provision(provision_info) Provision this instance. This only works, if no users exist yet. ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**provision_info** | [**ProvisionInfo**](ProvisionInfo.md) | | [required] | +| Name | Type | Description | Required | Notes | +| ------------------ | ------------------------------------- | ----------- | ---------- | ----- | +| **provision_info** | [**ProvisionInfo**](ProvisionInfo.md) | | [required] | ### Return type @@ -102,5 +99,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 28dc817..ea96a0c 100644 --- a/crates/rocie-client/docs/Barcode.md +++ b/crates/rocie-client/docs/Barcode.md @@ -14,11 +14,11 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## 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 5c6446b..e0037f1 100644 --- a/crates/rocie-client/docs/BarcodeId.md +++ b/crates/rocie-client/docs/BarcodeId.md @@ -14,10 +14,10 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## 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/Content.md b/crates/rocie-client/docs/Content.md index d957e79..8cd206f 100644 --- a/crates/rocie-client/docs/Content.md +++ b/crates/rocie-client/docs/Content.md @@ -14,11 +14,11 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Enum Variants -| Name | Description | -|---- | -----| -| ContentOneOf | Each type of content inside a section | +| Name | Description | +| ------------- | ------------------------------------- | +| ContentOneOf | Each type of content inside a section | | ContentOneOf1 | Each type of content inside a section | -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.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/ContentOneOf.md b/crates/rocie-client/docs/ContentOneOf.md index 124454f..fa91ef0 100644 --- a/crates/rocie-client/docs/ContentOneOf.md +++ b/crates/rocie-client/docs/ContentOneOf.md @@ -14,10 +14,10 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**step** | [**models::Step**](Step.md) | A step | - -[[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 | +| -------- | --------------------------- | ----------- | ----- | +| **step** | [**models::Step**](Step.md) | A step | +[[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/ContentOneOf1.md b/crates/rocie-client/docs/ContentOneOf1.md index 2ed35ae..02edd63 100644 --- a/crates/rocie-client/docs/ContentOneOf1.md +++ b/crates/rocie-client/docs/ContentOneOf1.md @@ -14,10 +14,10 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**text** | **String** | A paragraph of just text, no instructions | - -[[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 | +| -------- | ---------- | ----------------------------------------- | ----- | +| **text** | **String** | A paragraph of just text, no instructions | +[[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/CooklangRecipe.md b/crates/rocie-client/docs/CooklangRecipe.md index 5ae6ba0..326afc2 100644 --- a/crates/rocie-client/docs/CooklangRecipe.md +++ b/crates/rocie-client/docs/CooklangRecipe.md @@ -14,14 +14,14 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cookware** | [**Vec<models::Cookware>**](Cookware.md) | All the cookware | -**ingredients** | [**Vec<models::Ingredient>**](Ingredient.md) | All the ingredients | -**metadata** | [**models::Metadata**](Metadata.md) | Metadata as read from preamble | -**sections** | [**Vec<models::Section>**](Section.md) | Each of the sections If no sections declared, a section without name is the default. | -**timers** | [**Vec<models::Timer>**](Timer.md) | All the timers | - -[[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 | +| --------------- | -------------------------------------------- | ------------------------------------------------------------------------------------ | ----- | +| **cookware** | [**Vec<models::Cookware>**](Cookware.md) | All the cookware | +| **ingredients** | [**Vec<models::Ingredient>**](Ingredient.md) | All the ingredients | +| **metadata** | [**models::Metadata**](Metadata.md) | Metadata as read from preamble | +| **sections** | [**Vec<models::Section>**](Section.md) | Each of the sections If no sections declared, a section without name is the default. | +| **timers** | [**Vec<models::Timer>**](Timer.md) | All the timers | + +[[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/Cookware.md b/crates/rocie-client/docs/Cookware.md index 2160161..dc8fa3e 100644 --- a/crates/rocie-client/docs/Cookware.md +++ b/crates/rocie-client/docs/Cookware.md @@ -14,13 +14,13 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**alias** | Option<**String**> | Alias | [optional] -**name** | **String** | Name | -**note** | Option<**String**> | Note | [optional] -**quantity** | Option<**u32**> | Amount needed Note that this is a value, not a quantity, so it doesn't have units. | [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 | +| ------------ | ------------------- | ---------------------------------------------------------------------------------- | ---------- | +| **alias** | Option\<**String**> | Alias | [optional] | +| **name** | **String** | Name | +| **note** | Option\<**String**> | Note | [optional] | +| **quantity** | Option\<**u32**> | Amount needed Note that this is a value, not a quantity, so it doesn't have units. | [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/Ingredient.md b/crates/rocie-client/docs/Ingredient.md index 030f2f3..067a7e9 100644 --- a/crates/rocie-client/docs/Ingredient.md +++ b/crates/rocie-client/docs/Ingredient.md @@ -14,12 +14,12 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Enum Variants -| Name | Description | -|---- | -----| -| IngredientOneOf | A recipe ingredient | +| Name | Description | +| ---------------- | ------------------- | +| IngredientOneOf | A recipe ingredient | | IngredientOneOf1 | A recipe ingredient | | IngredientOneOf2 | A recipe ingredient | -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.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/IngredientOneOf.md b/crates/rocie-client/docs/IngredientOneOf.md index 7d29a6b..a48574e 100644 --- a/crates/rocie-client/docs/IngredientOneOf.md +++ b/crates/rocie-client/docs/IngredientOneOf.md @@ -14,10 +14,10 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**registered_product** | [**models::IngredientOneOfRegisteredProduct**](Ingredient_oneOf_RegisteredProduct.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 | +| ---------------------- | ------------------------------------------------------------------------------------- | ----------- | ----- | +| **registered_product** | [**models::IngredientOneOfRegisteredProduct**](Ingredient_oneOf_RegisteredProduct.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/IngredientOneOf1.md b/crates/rocie-client/docs/IngredientOneOf1.md index 87bf90a..edddc6f 100644 --- a/crates/rocie-client/docs/IngredientOneOf1.md +++ b/crates/rocie-client/docs/IngredientOneOf1.md @@ -14,10 +14,10 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**not_registered_product** | [**models::IngredientOneOf1NotRegisteredProduct**](Ingredient_oneOf_1_NotRegisteredProduct.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 | +| -------------------------- | ---------------------------------------------------------------------------------------------- | ----------- | ----- | +| **not_registered_product** | [**models::IngredientOneOf1NotRegisteredProduct**](Ingredient_oneOf_1_NotRegisteredProduct.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/IngredientOneOf1NotRegisteredProduct.md b/crates/rocie-client/docs/IngredientOneOf1NotRegisteredProduct.md index 8ff362f..5256fb5 100644 --- a/crates/rocie-client/docs/IngredientOneOf1NotRegisteredProduct.md +++ b/crates/rocie-client/docs/IngredientOneOf1NotRegisteredProduct.md @@ -14,11 +14,11 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **String** | | -**quantity** | Option<[**models::UnitAmount**](UnitAmount.md)> | Quantity | [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 | +| ------------ | ------------------------------------------------ | ----------- | ---------- | +| **name** | **String** | | +| **quantity** | Option\<[**models::UnitAmount**](UnitAmount.md)> | Quantity | [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/IngredientOneOf2.md b/crates/rocie-client/docs/IngredientOneOf2.md index dc2fc08..2b58aa4 100644 --- a/crates/rocie-client/docs/IngredientOneOf2.md +++ b/crates/rocie-client/docs/IngredientOneOf2.md @@ -14,10 +14,10 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**recipe_reference** | [**models::IngredientOneOf2RecipeReference**](Ingredient_oneOf_2_RecipeReference.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 | +| -------------------- | ------------------------------------------------------------------------------------ | ----------- | ----- | +| **recipe_reference** | [**models::IngredientOneOf2RecipeReference**](Ingredient_oneOf_2_RecipeReference.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/IngredientOneOf2RecipeReference.md b/crates/rocie-client/docs/IngredientOneOf2RecipeReference.md index dc841b0..984d650 100644 --- a/crates/rocie-client/docs/IngredientOneOf2RecipeReference.md +++ b/crates/rocie-client/docs/IngredientOneOf2RecipeReference.md @@ -14,10 +14,10 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | [**models::RecipeId**](RecipeId.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 | +| ------ | ----------------------------------- | ----------- | ----- | +| **id** | [**models::RecipeId**](RecipeId.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/IngredientOneOfRegisteredProduct.md b/crates/rocie-client/docs/IngredientOneOfRegisteredProduct.md index c1e3723..0eae13e 100644 --- a/crates/rocie-client/docs/IngredientOneOfRegisteredProduct.md +++ b/crates/rocie-client/docs/IngredientOneOfRegisteredProduct.md @@ -14,12 +14,12 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**alias** | Option<**String**> | Alias | [optional] -**id** | [**models::ProductId**](ProductId.md) | | -**quantity** | Option<[**models::ProductAmount**](ProductAmount.md)> | Quantity | [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 | +| ------------ | ------------------------------------------------------ | ----------- | ---------- | +| **alias** | Option\<**String**> | Alias | [optional] | +| **id** | [**models::ProductId**](ProductId.md) | | +| **quantity** | Option\<[**models::ProductAmount**](ProductAmount.md)> | Quantity | [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/Item.md b/crates/rocie-client/docs/Item.md index 3e40bd9..a67a776 100644 --- a/crates/rocie-client/docs/Item.md +++ b/crates/rocie-client/docs/Item.md @@ -14,14 +14,14 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Enum Variants -| Name | Description | -|---- | -----| -| ItemOneOf | A step item Except for [`Item::Text`], the value is the index where the item is located in it's corresponding [`Vec`] in the [`Recipe`]. | -| ItemOneOf1 | A step item Except for [`Item::Text`], the value is the index where the item is located in it's corresponding [`Vec`] in the [`Recipe`]. | -| ItemOneOf2 | A step item Except for [`Item::Text`], the value is the index where the item is located in it's corresponding [`Vec`] in the [`Recipe`]. | -| ItemOneOf3 | A step item Except for [`Item::Text`], the value is the index where the item is located in it's corresponding [`Vec`] in the [`Recipe`]. | -| ItemOneOf4 | A step item Except for [`Item::Text`], the value is the index where the item is located in it's corresponding [`Vec`] in the [`Recipe`]. | - -[[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 | Description | +| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| ItemOneOf | A step item Except for [\`Item::Text\`], the value is the index where the item is located in it's corresponding [\`Vec\`] in the [\`Recipe\`]. | +| ItemOneOf1 | A step item Except for [\`Item::Text\`], the value is the index where the item is located in it's corresponding [\`Vec\`] in the [\`Recipe\`]. | +| ItemOneOf2 | A step item Except for [\`Item::Text\`], the value is the index where the item is located in it's corresponding [\`Vec\`] in the [\`Recipe\`]. | +| ItemOneOf3 | A step item Except for [\`Item::Text\`], the value is the index where the item is located in it's corresponding [\`Vec\`] in the [\`Recipe\`]. | +| ItemOneOf4 | A step item Except for [\`Item::Text\`], the value is the index where the item is located in it's corresponding [\`Vec\`] in the [\`Recipe\`]. | + +[[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/ItemOneOf.md b/crates/rocie-client/docs/ItemOneOf.md index 96eaec0..4f5c548 100644 --- a/crates/rocie-client/docs/ItemOneOf.md +++ b/crates/rocie-client/docs/ItemOneOf.md @@ -14,10 +14,10 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**text** | [**models::ItemOneOfText**](Item_oneOf_Text.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 | +| -------- | ----------------------------------------------- | ----------- | ----- | +| **text** | [**models::ItemOneOfText**](Item_oneOf_Text.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/ItemOneOf1.md b/crates/rocie-client/docs/ItemOneOf1.md index 1d1e19a..a0fcb6f 100644 --- a/crates/rocie-client/docs/ItemOneOf1.md +++ b/crates/rocie-client/docs/ItemOneOf1.md @@ -14,10 +14,10 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ingredient** | [**models::ItemOneOf1Ingredient**](Item_oneOf_1_Ingredient.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 | +| -------------- | -------------------------------------------------------------- | ----------- | ----- | +| **ingredient** | [**models::ItemOneOf1Ingredient**](Item_oneOf_1_Ingredient.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/ItemOneOf1Ingredient.md b/crates/rocie-client/docs/ItemOneOf1Ingredient.md index 9495db8..4466d6e 100644 --- a/crates/rocie-client/docs/ItemOneOf1Ingredient.md +++ b/crates/rocie-client/docs/ItemOneOf1Ingredient.md @@ -14,10 +14,10 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**index** | **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 | +| --------- | ------- | ----------- | ----- | +| **index** | **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/ItemOneOf2.md b/crates/rocie-client/docs/ItemOneOf2.md index bd274dc..1ae2606 100644 --- a/crates/rocie-client/docs/ItemOneOf2.md +++ b/crates/rocie-client/docs/ItemOneOf2.md @@ -14,10 +14,10 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cookware** | [**models::ItemOneOf1Ingredient**](Item_oneOf_1_Ingredient.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 | +| ------------ | -------------------------------------------------------------- | ----------- | ----- | +| **cookware** | [**models::ItemOneOf1Ingredient**](Item_oneOf_1_Ingredient.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/ItemOneOf3.md b/crates/rocie-client/docs/ItemOneOf3.md index f88f1d3..42067fc 100644 --- a/crates/rocie-client/docs/ItemOneOf3.md +++ b/crates/rocie-client/docs/ItemOneOf3.md @@ -14,10 +14,10 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**timer** | [**models::ItemOneOf1Ingredient**](Item_oneOf_1_Ingredient.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 | +| --------- | -------------------------------------------------------------- | ----------- | ----- | +| **timer** | [**models::ItemOneOf1Ingredient**](Item_oneOf_1_Ingredient.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/ItemOneOf4.md b/crates/rocie-client/docs/ItemOneOf4.md index 56d26b8..f2fedce 100644 --- a/crates/rocie-client/docs/ItemOneOf4.md +++ b/crates/rocie-client/docs/ItemOneOf4.md @@ -14,10 +14,10 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**inline_quantity** | [**models::ItemOneOf1Ingredient**](Item_oneOf_1_Ingredient.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 | +| ------------------- | -------------------------------------------------------------- | ----------- | ----- | +| **inline_quantity** | [**models::ItemOneOf1Ingredient**](Item_oneOf_1_Ingredient.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/ItemOneOfText.md b/crates/rocie-client/docs/ItemOneOfText.md index c30ef27..2d3c510 100644 --- a/crates/rocie-client/docs/ItemOneOfText.md +++ b/crates/rocie-client/docs/ItemOneOfText.md @@ -14,10 +14,10 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## 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/LoginInfo.md b/crates/rocie-client/docs/LoginInfo.md index 3f35b30..c08018e 100644 --- a/crates/rocie-client/docs/LoginInfo.md +++ b/crates/rocie-client/docs/LoginInfo.md @@ -14,11 +14,11 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**password** | **String** | The password of the user. | -**user_name** | **String** | The user name 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 | +| ------------- | ---------- | -------------------------- | ----- | +| **password** | **String** | The password of the user. | +| **user_name** | **String** | The user name 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/Metadata.md b/crates/rocie-client/docs/Metadata.md index 40d8152..09f9d6d 100644 --- a/crates/rocie-client/docs/Metadata.md +++ b/crates/rocie-client/docs/Metadata.md @@ -14,14 +14,14 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**author** | Option<[**models::NameAndUrl**](NameAndUrl.md)> | | [optional] -**description** | Option<**String**> | | [optional] -**source** | Option<[**models::NameAndUrl**](NameAndUrl.md)> | | [optional] -**tags** | Option<**Vec<String>**> | | [optional] -**title** | Option<**String**> | | [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 | +| --------------- | ------------------------------------------------ | ----------- | ---------- | +| **author** | Option\<[**models::NameAndUrl**](NameAndUrl.md)> | | [optional] | +| **description** | Option\<**String**> | | [optional] | +| **source** | Option\<[**models::NameAndUrl**](NameAndUrl.md)> | | [optional] | +| **tags** | Option\<**Vec<String>**> | | [optional] | +| **title** | Option\<**String**> | | [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/NameAndUrl.md b/crates/rocie-client/docs/NameAndUrl.md index 1c67111..4db3a64 100644 --- a/crates/rocie-client/docs/NameAndUrl.md +++ b/crates/rocie-client/docs/NameAndUrl.md @@ -14,11 +14,11 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | Option<**String**> | | [optional] -**url** | Option<**String**> | | [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 | +| -------- | ------------------- | ----------- | ---------- | +| **name** | Option\<**String**> | | [optional] | +| **url** | Option\<**String**> | | [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/PasswordHash.md b/crates/rocie-client/docs/PasswordHash.md index f2d763a..7d6edab 100644 --- a/crates/rocie-client/docs/PasswordHash.md +++ b/crates/rocie-client/docs/PasswordHash.md @@ -14,10 +14,10 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## 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 f31c33e..b177d94 100644 --- a/crates/rocie-client/docs/Product.md +++ b/crates/rocie-client/docs/Product.md @@ -14,15 +14,15 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## 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. None means, that it has no parents and as such is in the toplevel. | [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. None means, that it has no parents and as such is in the toplevel. | [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 de0897a..f860435 100644 --- a/crates/rocie-client/docs/ProductAmount.md +++ b/crates/rocie-client/docs/ProductAmount.md @@ -14,11 +14,11 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## 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 26a0199..ec7ec11 100644 --- a/crates/rocie-client/docs/ProductId.md +++ b/crates/rocie-client/docs/ProductId.md @@ -14,10 +14,10 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## 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/ProductParent.md b/crates/rocie-client/docs/ProductParent.md index dc3ce04..8d86349 100644 --- a/crates/rocie-client/docs/ProductParent.md +++ b/crates/rocie-client/docs/ProductParent.md @@ -14,13 +14,13 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## 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 8f4d7b1..2afb8d7 100644 --- a/crates/rocie-client/docs/ProductParentId.md +++ b/crates/rocie-client/docs/ProductParentId.md @@ -14,10 +14,10 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## 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 1017540..680e2bd 100644 --- a/crates/rocie-client/docs/ProductParentStub.md +++ b/crates/rocie-client/docs/ProductParentStub.md @@ -14,12 +14,12 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## 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 c04838b..c707d02 100644 --- a/crates/rocie-client/docs/ProductStub.md +++ b/crates/rocie-client/docs/ProductStub.md @@ -14,13 +14,13 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## 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/ProvisionInfo.md b/crates/rocie-client/docs/ProvisionInfo.md index 8a03687..2d8d7ef 100644 --- a/crates/rocie-client/docs/ProvisionInfo.md +++ b/crates/rocie-client/docs/ProvisionInfo.md @@ -14,11 +14,11 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**use_defaults** | **bool** | Whether we should apply the default configuration. | -**user** | [**models::UserStub**](UserStub.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 | +| ---------------- | ----------------------------------- | -------------------------------------------------- | ----- | +| **use_defaults** | **bool** | Whether we should apply the default configuration. | +| **user** | [**models::UserStub**](UserStub.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/Recipe.md b/crates/rocie-client/docs/Recipe.md index 8024856..7cf33df 100644 --- a/crates/rocie-client/docs/Recipe.md +++ b/crates/rocie-client/docs/Recipe.md @@ -14,13 +14,13 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**content** | [**models::CooklangRecipe**](CooklangRecipe.md) | The actual content of this recipe. | -**id** | [**models::RecipeId**](RecipeId.md) | The unique id of this recipe. | -**name** | **String** | The name of the recipe. This should be globally unique, to make searching easier for the user. | -**parent** | Option<[**models::RecipeParentId**](RecipeParentId.md)> | The parent this recipe has. This is effectively it's anchor in the recipe DAG. None means, that it has no parents and as such is in the toplevel. | [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 | +| ----------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **content** | [**models::CooklangRecipe**](CooklangRecipe.md) | The actual content of this recipe. | +| **id** | [**models::RecipeId**](RecipeId.md) | The unique id of this recipe. | +| **name** | **String** | The name of the recipe. This should be globally unique, to make searching easier for the user. | +| **parent** | Option\<[**models::RecipeParentId**](RecipeParentId.md)> | The parent this recipe has. This is effectively it's anchor in the recipe DAG. None means, that it has no parents and as such is in the toplevel. | [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/RecipeId.md b/crates/rocie-client/docs/RecipeId.md index 151fe5d..f8d29ac 100644 --- a/crates/rocie-client/docs/RecipeId.md +++ b/crates/rocie-client/docs/RecipeId.md @@ -14,10 +14,10 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## 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/RecipeParent.md b/crates/rocie-client/docs/RecipeParent.md index f713201..52a50ee 100644 --- a/crates/rocie-client/docs/RecipeParent.md +++ b/crates/rocie-client/docs/RecipeParent.md @@ -14,13 +14,13 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | Option<**String**> | An optional description of this recipe parent. | [optional] -**id** | [**models::RecipeParentId**](RecipeParentId.md) | The id of the recipe parent. | -**name** | **String** | The name of the recipe parent. This should be globally unique, to make searching easier for the user. | -**parent** | Option<[**models::RecipeParentId**](RecipeParentId.md)> | The optional id of the parent of this recipe 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 recipe parent. | [optional] | +| **id** | [**models::RecipeParentId**](RecipeParentId.md) | The id of the recipe parent. | +| **name** | **String** | The name of the recipe parent. This should be globally unique, to make searching easier for the user. | +| **parent** | Option\<[**models::RecipeParentId**](RecipeParentId.md)> | The optional id of the parent of this recipe 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/RecipeParentId.md b/crates/rocie-client/docs/RecipeParentId.md index cfa5755..1a31887 100644 --- a/crates/rocie-client/docs/RecipeParentId.md +++ b/crates/rocie-client/docs/RecipeParentId.md @@ -14,10 +14,10 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## 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/RecipeParentStub.md b/crates/rocie-client/docs/RecipeParentStub.md index 1d8b253..0823ded 100644 --- a/crates/rocie-client/docs/RecipeParentStub.md +++ b/crates/rocie-client/docs/RecipeParentStub.md @@ -14,12 +14,12 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | Option<**String**> | A description. | [optional] -**name** | **String** | The name of the recipe parent | -**parent** | Option<[**models::RecipeParentId**](RecipeParentId.md)> | A parent of this recipe 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 recipe parent | +| **parent** | Option\<[**models::RecipeParentId**](RecipeParentId.md)> | A parent of this recipe 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/RecipeStub.md b/crates/rocie-client/docs/RecipeStub.md index fd96237..e55d25f 100644 --- a/crates/rocie-client/docs/RecipeStub.md +++ b/crates/rocie-client/docs/RecipeStub.md @@ -14,12 +14,12 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**content** | **String** | The content of this recipe, in cooklang format | -**name** | **String** | The globally unique name of this recipe | -**parent** | Option<[**models::RecipeParentId**](RecipeParentId.md)> | The optional parent of this recipe. | [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 | +| ----------- | -------------------------------------------------------- | ---------------------------------------------- | ---------- | +| **content** | **String** | The content of this recipe, in cooklang format | +| **name** | **String** | The globally unique name of this recipe | +| **parent** | Option\<[**models::RecipeParentId**](RecipeParentId.md)> | The optional parent of this recipe. | [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/RefinedRecipe.md b/crates/rocie-client/docs/RefinedRecipe.md index 43da81f..e4a71bc 100644 --- a/crates/rocie-client/docs/RefinedRecipe.md +++ b/crates/rocie-client/docs/RefinedRecipe.md @@ -14,11 +14,11 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | [**models::RecipeId**](RecipeId.md) | The unique id of this refined recipe's original recipe. | -**ingridients** | [**Vec<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 | +| --------------- | ------------------------------------------ | ------------------------------------------------------- | ----- | +| **id** | [**models::RecipeId**](RecipeId.md) | The unique id of this refined recipe's original recipe. | +| **ingridients** | [**Vec<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/Section.md b/crates/rocie-client/docs/Section.md index 5526aa5..aaeddda 100644 --- a/crates/rocie-client/docs/Section.md +++ b/crates/rocie-client/docs/Section.md @@ -14,11 +14,11 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**content** | [**Vec<models::Content>**](Content.md) | Content inside | -**name** | Option<**String**> | Name of the section | [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 | +| ----------- | -------------------------------------- | ------------------- | ---------- | +| **content** | [**Vec<models::Content>**](Content.md) | Content inside | +| **name** | Option\<**String**> | Name of the section | [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/Step.md b/crates/rocie-client/docs/Step.md index a4150b8..1563841 100644 --- a/crates/rocie-client/docs/Step.md +++ b/crates/rocie-client/docs/Step.md @@ -14,11 +14,11 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**items** | [**Vec<models::Item>**](Item.md) | [`Item`]s inside | -**number** | **u32** | Step number The step numbers start at 1 in each section and increase with non text step. | - -[[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 | +| ---------- | -------------------------------- | ---------------------------------------------------------------------------------------- | ----- | +| **items** | [**Vec<models::Item>**](Item.md) | \[`Item`\]s inside | +| **number** | **u32** | Step number The step numbers start at 1 in each section and increase with non text step. | + +[[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/Timer.md b/crates/rocie-client/docs/Timer.md index ffabee8..f8c9e7f 100644 --- a/crates/rocie-client/docs/Timer.md +++ b/crates/rocie-client/docs/Timer.md @@ -14,11 +14,11 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | Option<**String**> | Name | [optional] -**quantity** | Option<[**models::UnitAmount**](UnitAmount.md)> | Time quantity | [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 | +| ------------ | ------------------------------------------------ | ------------- | ---------- | +| **name** | Option\<**String**> | Name | [optional] | +| **quantity** | Option\<[**models::UnitAmount**](UnitAmount.md)> | Time quantity | [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/Unit.md b/crates/rocie-client/docs/Unit.md index 0e99e49..5822859 100644 --- a/crates/rocie-client/docs/Unit.md +++ b/crates/rocie-client/docs/Unit.md @@ -14,15 +14,15 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## 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 bb263ba..c60d795 100644 --- a/crates/rocie-client/docs/UnitAmount.md +++ b/crates/rocie-client/docs/UnitAmount.md @@ -14,11 +14,11 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## 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 7663daa..e898751 100644 --- a/crates/rocie-client/docs/UnitId.md +++ b/crates/rocie-client/docs/UnitId.md @@ -14,10 +14,10 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## 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 e8ce7bb..1ed7b4c 100644 --- a/crates/rocie-client/docs/UnitProperty.md +++ b/crates/rocie-client/docs/UnitProperty.md @@ -14,13 +14,13 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## 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 bd38c67..fab49bd 100644 --- a/crates/rocie-client/docs/UnitPropertyId.md +++ b/crates/rocie-client/docs/UnitPropertyId.md @@ -14,10 +14,10 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## 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 7c50864..556caf0 100644 --- a/crates/rocie-client/docs/UnitPropertyStub.md +++ b/crates/rocie-client/docs/UnitPropertyStub.md @@ -14,11 +14,11 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## 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 d272828..f9220dc 100644 --- a/crates/rocie-client/docs/UnitStub.md +++ b/crates/rocie-client/docs/UnitStub.md @@ -14,14 +14,14 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## 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 0b6b4b8..3e79afe 100644 --- a/crates/rocie-client/docs/User.md +++ b/crates/rocie-client/docs/User.md @@ -14,13 +14,13 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## 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 3144e57..6780054 100644 --- a/crates/rocie-client/docs/UserId.md +++ b/crates/rocie-client/docs/UserId.md @@ -14,10 +14,10 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## 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 2d1e6c9..5d474be 100644 --- a/crates/rocie-client/docs/UserStub.md +++ b/crates/rocie-client/docs/UserStub.md @@ -14,12 +14,12 @@ If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. ## 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) |