diff options
| author | Benedikt Peetz <benedikt.peetz@b-peetz.de> | 2026-02-15 22:25:39 +0100 |
|---|---|---|
| committer | Benedikt Peetz <benedikt.peetz@b-peetz.de> | 2026-02-15 22:25:39 +0100 |
| commit | b467f7202f5c0c3970e39ea396a0cec0fd6a36ee (patch) | |
| tree | aa567f84f0c2891d03de5b6414507c2d9a5f4754 /crates/rocie-client/docs | |
| parent | feat(treewide): Add recipes and user handling (diff) | |
| download | server-b467f7202f5c0c3970e39ea396a0cec0fd6a36ee.zip | |
chore(rocie-client): Re-generate the client api
Diffstat (limited to 'crates/rocie-client/docs')
70 files changed, 1254 insertions, 537 deletions
diff --git a/crates/rocie-client/docs/ApiGetAuthInventoryApi.md b/crates/rocie-client/docs/ApiGetAuthInventoryApi.md index 1551249..ece4d4b 100644 --- a/crates/rocie-client/docs/ApiGetAuthInventoryApi.md +++ b/crates/rocie-client/docs/ApiGetAuthInventoryApi.md @@ -1,20 +1,24 @@ -# \\ApiGetAuthInventoryApi +# \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 -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 @@ -29,7 +33,5 @@ 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 44471fa..cd3c140 100644 --- a/crates/rocie-client/docs/ApiGetAuthProductApi.md +++ b/crates/rocie-client/docs/ApiGetAuthProductApi.md @@ -1,26 +1,31 @@ -# \\ApiGetAuthProductApi +# \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 -All URIs are relative to _http://localhost_ -| Method | HTTP request | Description | -| ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------- | ----------------------------------------------------- | -| [**product_by_id**](ApiGetAuthProductApi.md#product_by_id) | **GET** /product/by-id/{id} | Get Product by id | -| [**product_by_name**](ApiGetAuthProductApi.md#product_by_name) | **GET** /product/by-name/{name} | Get Product by name | -| [**product_suggestion_by_name**](ApiGetAuthProductApi.md#product_suggestion_by_name) | **GET** /product/by-part-name/{name} | Get Product suggestion by name | -| [**products_by_product_parent_id_direct**](ApiGetAuthProductApi.md#products_by_product_parent_id_direct) | **GET** /product/by-product-parent-id-direct/{id} | Get Products by it's product parent id | -| [**products_by_product_parent_id_indirect**](ApiGetAuthProductApi.md#products_by_product_parent_id_indirect) | **GET** /product/by-product-parent-id-indirect/{id} | Get Products by it's product parent id | -| [**products_in_storage**](ApiGetAuthProductApi.md#products_in_storage) | **GET** /products_in_storage/ | Return all products, which non-null amount in storage | -| [**products_registered**](ApiGetAuthProductApi.md#products_registered) | **GET** /products_registered/ | Return all registered products | ## product_by_id -> models::Product product_by_id(id) Get Product by id +> models::Product product_by_id(id) +Get Product by id ### Parameters -| Name | Type | Description | Required | Notes | -| ------ | -------------------- | ----------- | ---------- | ----- | -| **id** | [**ProductId**](.md) | Product id | [required] | + +Name | Type | Description | Required | Notes +------------- | ------------- | ------------- | ------------- | ------------- +**id** | [**ProductId**](.md) | Product id | [required] | ### Return type @@ -35,20 +40,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 @@ -63,21 +68,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_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 @@ -92,23 +96,22 @@ 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 @@ -123,23 +126,22 @@ 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 @@ -154,15 +156,13 @@ 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 @@ -181,14 +181,40 @@ 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 + +This endpoint does not need any parameter. + +### Return type + +[**Vec<models::Product>**](Product.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json, text/plain + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +## products_without_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 ### Parameters @@ -207,7 +233,5 @@ 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 f51a316..fbdc3b1 100644 --- a/crates/rocie-client/docs/ApiGetAuthProductParentApi.md +++ b/crates/rocie-client/docs/ApiGetAuthProductParentApi.md @@ -1,17 +1,19 @@ -# \\ApiGetAuthProductParentApi +# \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 -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 @@ -30,15 +32,13 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json, text/plain -[[Back to top]](#) -[[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + ## product_parents_toplevel -> Vec<models::ProductParent> product_parents_toplevel() Return all registered -> product parents, that have no parents themselves +> Vec<models::ProductParent> product_parents_toplevel() +Return all registered product parents, that have no parents themselves ### Parameters @@ -57,21 +57,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_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 @@ -86,7 +85,5 @@ 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 29e2e36..b3fd96c 100644 --- a/crates/rocie-client/docs/ApiGetAuthRecipeApi.md +++ b/crates/rocie-client/docs/ApiGetAuthRecipeApi.md @@ -1,21 +1,29 @@ -# \\ApiGetAuthRecipeApi +# \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 -All URIs are relative to _http://localhost_ -| Method | HTTP request | Description | -| ------------------------------------------------------- | -------------------------- | ------------------------- | -| [**recipe_by_id**](ApiGetAuthRecipeApi.md#recipe_by_id) | **GET** /recipe/by-id/{id} | Get an recipe by it's id. | -| [**recipes**](ApiGetAuthRecipeApi.md#recipes) | **GET** /recipe/all | Get all added recipes | ## recipe_by_id -> models::Recipe recipe_by_id(id) Get an recipe by it's id. +> models::Recipe recipe_by_id(id) +Get an recipe by it's id. ### Parameters -| Name | Type | Description | Required | Notes | -| ------ | ------------------- | ----------- | ---------- | ----- | -| **id** | [**RecipeId**](.md) | Recipe id | [required] | + +Name | Type | Description | Required | Notes +------------- | ------------- | ------------- | ------------- | ------------- +**id** | [**RecipeId**](.md) | Recipe id | [required] | ### Return type @@ -30,14 +38,41 @@ 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. + +### Parameters + + +Name | Type | Description | Required | Notes +------------- | ------------- | ------------- | ------------- | ------------- +**name** | **String** | Recipe name | [required] | + +### Return type + +[**models::Recipe**](Recipe.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json, text/plain + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + ## recipes -> models::Recipe recipes() Get all added recipes +> Vec<models::Recipe> recipes() +Get all added recipes ### Parameters @@ -45,7 +80,67 @@ This endpoint does not need any parameter. ### Return type -[**models::Recipe**](Recipe.md) +[**Vec<models::Recipe>**](Recipe.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json, text/plain + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +## recipes_by_recipe_parent_id_direct + +> 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] | + +### Return type + +[**Vec<models::Recipe>**](Recipe.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json, text/plain + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +## recipes_by_recipe_parent_id_indirect + +> 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] | + +### Return type + +[**Vec<models::Recipe>**](Recipe.md) ### Authorization @@ -56,7 +151,32 @@ 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 + +This will only return recipes without a recipe parent associated with it + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**Vec<models::Recipe>**](Recipe.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json, text/plain + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/crates/rocie-client/docs/ApiGetAuthRecipeParentApi.md b/crates/rocie-client/docs/ApiGetAuthRecipeParentApi.md new file mode 100644 index 0000000..0490daf --- /dev/null +++ b/crates/rocie-client/docs/ApiGetAuthRecipeParentApi.md @@ -0,0 +1,89 @@ +# \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 + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**Vec<models::RecipeParent>**](RecipeParent.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json, text/plain + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +## recipe_parents_toplevel + +> Vec<models::RecipeParent> recipe_parents_toplevel() +Return all registered recipe parents, that have no parents themselves + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**Vec<models::RecipeParent>**](RecipeParent.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json, text/plain + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +## recipe_parents_under + +> 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] | + +### Return type + +[**Vec<models::RecipeParent>**](RecipeParent.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json, text/plain + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/crates/rocie-client/docs/ApiGetAuthRefinedRecipeApi.md b/crates/rocie-client/docs/ApiGetAuthRefinedRecipeApi.md new file mode 100644 index 0000000..9f0bbf9 --- /dev/null +++ b/crates/rocie-client/docs/ApiGetAuthRefinedRecipeApi.md @@ -0,0 +1,37 @@ +# \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. + +### Parameters + + +Name | Type | Description | Required | Notes +------------- | ------------- | ------------- | ------------- | ------------- +**id** | [**RecipeId**](.md) | Recipe id | [required] | + +### Return type + +[**models::RefinedRecipe**](RefinedRecipe.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json, text/plain + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/crates/rocie-client/docs/ApiGetAuthUnitApi.md b/crates/rocie-client/docs/ApiGetAuthUnitApi.md index d8db77d..3f2b02f 100644 --- a/crates/rocie-client/docs/ApiGetAuthUnitApi.md +++ b/crates/rocie-client/docs/ApiGetAuthUnitApi.md @@ -1,22 +1,26 @@ -# \\ApiGetAuthUnitApi +# \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 -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 @@ -31,14 +35,13 @@ 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 @@ -57,21 +60,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) + ## 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 @@ -86,7 +88,5 @@ 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 09c261f..d88249a 100644 --- a/crates/rocie-client/docs/ApiGetAuthUnitPropertyApi.md +++ b/crates/rocie-client/docs/ApiGetAuthUnitPropertyApi.md @@ -1,16 +1,18 @@ -# \\ApiGetAuthUnitPropertyApi +# \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 -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 @@ -29,20 +31,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 @@ -57,7 +59,5 @@ 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 be9fe70..653e82a 100644 --- a/crates/rocie-client/docs/ApiGetAuthUserApi.md +++ b/crates/rocie-client/docs/ApiGetAuthUserApi.md @@ -1,21 +1,25 @@ -# \\ApiGetAuthUserApi +# \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. -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 @@ -30,14 +34,13 @@ 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 @@ -56,7 +59,5 @@ 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 new file mode 100644 index 0000000..c72e9e2 --- /dev/null +++ b/crates/rocie-client/docs/ApiGetNoAuthStateApi.md @@ -0,0 +1,60 @@ +# \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 + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**bool** + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: text/plain + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +## is_logged_in + +> bool is_logged_in() +Check if you are logged in + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**bool** + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: text/plain + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/crates/rocie-client/docs/ApiSetAuthBarcodeApi.md b/crates/rocie-client/docs/ApiSetAuthBarcodeApi.md index 357c26b..535643b 100644 --- a/crates/rocie-client/docs/ApiSetAuthBarcodeApi.md +++ b/crates/rocie-client/docs/ApiSetAuthBarcodeApi.md @@ -1,26 +1,30 @@ -# \\ApiSetAuthBarcodeApi +# \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 -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 @@ -31,25 +35,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 @@ -60,7 +64,5 @@ 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 df659ef..eb52b59 100644 --- a/crates/rocie-client/docs/ApiSetAuthProductApi.md +++ b/crates/rocie-client/docs/ApiSetAuthProductApi.md @@ -1,26 +1,30 @@ -# \\ApiSetAuthProductApi +# \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 -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 @@ -31,20 +35,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 @@ -59,7 +63,5 @@ 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 54fbef1..e48c269 100644 --- a/crates/rocie-client/docs/ApiSetAuthProductParentApi.md +++ b/crates/rocie-client/docs/ApiSetAuthProductParentApi.md @@ -1,21 +1,24 @@ -# \\ApiSetAuthProductParentApi +# \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 -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 @@ -30,7 +33,5 @@ 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 a897210..0ec118b 100644 --- a/crates/rocie-client/docs/ApiSetAuthRecipeApi.md +++ b/crates/rocie-client/docs/ApiSetAuthRecipeApi.md @@ -1,20 +1,24 @@ -# \\ApiSetAuthRecipeApi +# \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 -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 @@ -29,7 +33,5 @@ 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 new file mode 100644 index 0000000..20190e5 --- /dev/null +++ b/crates/rocie-client/docs/ApiSetAuthRecipeParentApi.md @@ -0,0 +1,37 @@ +# \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 + +### Parameters + + +Name | Type | Description | Required | Notes +------------- | ------------- | ------------- | ------------- | ------------- +**recipe_parent_stub** | [**RecipeParentStub**](RecipeParentStub.md) | | [required] | + +### Return type + +[**models::RecipeParentId**](RecipeParentId.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json, text/plain + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/crates/rocie-client/docs/ApiSetAuthUnitApi.md b/crates/rocie-client/docs/ApiSetAuthUnitApi.md index ddb7581..d5927f8 100644 --- a/crates/rocie-client/docs/ApiSetAuthUnitApi.md +++ b/crates/rocie-client/docs/ApiSetAuthUnitApi.md @@ -1,20 +1,24 @@ -# \\ApiSetAuthUnitApi +# \ApiSetAuthUnitApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**register_unit**](ApiSetAuthUnitApi.md#register_unit) | **POST** /unit/new | Register an Unit -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 @@ -29,7 +33,5 @@ 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 df662c8..855065c 100644 --- a/crates/rocie-client/docs/ApiSetAuthUnitPropertyApi.md +++ b/crates/rocie-client/docs/ApiSetAuthUnitPropertyApi.md @@ -1,21 +1,24 @@ -# \\ApiSetAuthUnitPropertyApi +# \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 -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 @@ -30,7 +33,5 @@ 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 77bdd60..7409a8a 100644 --- a/crates/rocie-client/docs/ApiSetAuthUserApi.md +++ b/crates/rocie-client/docs/ApiSetAuthUserApi.md @@ -1,20 +1,24 @@ -# \\ApiSetAuthUserApi +# \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 -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 @@ -29,7 +33,5 @@ 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 4cfc846..f532533 100644 --- a/crates/rocie-client/docs/ApiSetNoAuthUserApi.md +++ b/crates/rocie-client/docs/ApiSetNoAuthUserApi.md @@ -1,26 +1,30 @@ -# \\ApiSetNoAuthUserApi +# \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. -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 @@ -31,14 +35,13 @@ 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 @@ -46,7 +49,7 @@ This endpoint does not need any parameter. ### Return type -(empty response body) + (empty response body) ### Authorization @@ -57,22 +60,22 @@ No authorization required - **Content-Type**: Not defined - **Accept**: text/plain -[[Back to top]](#) -[[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + ## provision -> models::UserId provision(user_stub) Provision this instance. +> models::UserId provision(user_stub) +Provision this instance. This only works, if no users exist yet. ### Parameters -| Name | Type | Description | Required | Notes | -| ------------- | --------------------------- | ----------- | ---------- | ----- | -| **user_stub** | [**UserStub**](UserStub.md) | | [required] | + +Name | Type | Description | Required | Notes +------------- | ------------- | ------------- | ------------- | ------------- +**user_stub** | [**UserStub**](UserStub.md) | | [required] | ### Return type @@ -87,7 +90,5 @@ 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 7d84458..622b82d 100644 --- a/crates/rocie-client/docs/Barcode.md +++ b/crates/rocie-client/docs/Barcode.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---------- | --------------------------------------- | ----------- | ----- | -| **amount** | [**models::UnitAmount**](UnitAmount.md) | | -| **id** | [**models::BarcodeId**](BarcodeId.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to README]](../README.md) +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**amount** | [**models::UnitAmount**](UnitAmount.md) | | +**id** | [**models::BarcodeId**](BarcodeId.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/crates/rocie-client/docs/BarcodeId.md b/crates/rocie-client/docs/BarcodeId.md index b180bd9..630e07f 100644 --- a/crates/rocie-client/docs/BarcodeId.md +++ b/crates/rocie-client/docs/BarcodeId.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| --------- | ------- | ----------- | ----- | -| **value** | **u32** | | +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) + -[[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 new file mode 100644 index 0000000..e69b125 --- /dev/null +++ b/crates/rocie-client/docs/Content.md @@ -0,0 +1,12 @@ +# Content + +## Enum Variants + +| 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) + + diff --git a/crates/rocie-client/docs/ContentOneOf.md b/crates/rocie-client/docs/ContentOneOf.md new file mode 100644 index 0000000..61ea868 --- /dev/null +++ b/crates/rocie-client/docs/ContentOneOf.md @@ -0,0 +1,12 @@ +# ContentOneOf + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**r#type** | **String** | | +**value** | [**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 new file mode 100644 index 0000000..eef8337 --- /dev/null +++ b/crates/rocie-client/docs/ContentOneOf1.md @@ -0,0 +1,12 @@ +# ContentOneOf1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**r#type** | **String** | | +**value** | **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 new file mode 100644 index 0000000..0bee54e --- /dev/null +++ b/crates/rocie-client/docs/CooklangRecipe.md @@ -0,0 +1,15 @@ +# CooklangRecipe + +## 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) + + diff --git a/crates/rocie-client/docs/Cookware.md b/crates/rocie-client/docs/Cookware.md new file mode 100644 index 0000000..8861782 --- /dev/null +++ b/crates/rocie-client/docs/Cookware.md @@ -0,0 +1,14 @@ +# Cookware + +## 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) + + diff --git a/crates/rocie-client/docs/Ingredient.md b/crates/rocie-client/docs/Ingredient.md new file mode 100644 index 0000000..9dee5c9 --- /dev/null +++ b/crates/rocie-client/docs/Ingredient.md @@ -0,0 +1,13 @@ +# Ingredient + +## Enum Variants + +| 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) + + diff --git a/crates/rocie-client/docs/IngredientOneOf.md b/crates/rocie-client/docs/IngredientOneOf.md new file mode 100644 index 0000000..a4e4fb9 --- /dev/null +++ b/crates/rocie-client/docs/IngredientOneOf.md @@ -0,0 +1,11 @@ +# IngredientOneOf + +## 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) + + diff --git a/crates/rocie-client/docs/IngredientOneOf1.md b/crates/rocie-client/docs/IngredientOneOf1.md new file mode 100644 index 0000000..fd70578 --- /dev/null +++ b/crates/rocie-client/docs/IngredientOneOf1.md @@ -0,0 +1,11 @@ +# IngredientOneOf1 + +## 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) + + diff --git a/crates/rocie-client/docs/IngredientOneOf1NotRegisteredProduct.md b/crates/rocie-client/docs/IngredientOneOf1NotRegisteredProduct.md new file mode 100644 index 0000000..b23f98b --- /dev/null +++ b/crates/rocie-client/docs/IngredientOneOf1NotRegisteredProduct.md @@ -0,0 +1,12 @@ +# IngredientOneOf1NotRegisteredProduct + +## 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) + + diff --git a/crates/rocie-client/docs/IngredientOneOf2.md b/crates/rocie-client/docs/IngredientOneOf2.md new file mode 100644 index 0000000..33a7ffc --- /dev/null +++ b/crates/rocie-client/docs/IngredientOneOf2.md @@ -0,0 +1,11 @@ +# IngredientOneOf2 + +## 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) + + diff --git a/crates/rocie-client/docs/IngredientOneOf2RecipeReference.md b/crates/rocie-client/docs/IngredientOneOf2RecipeReference.md new file mode 100644 index 0000000..469603f --- /dev/null +++ b/crates/rocie-client/docs/IngredientOneOf2RecipeReference.md @@ -0,0 +1,11 @@ +# IngredientOneOf2RecipeReference + +## 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) + + diff --git a/crates/rocie-client/docs/IngredientOneOfRegisteredProduct.md b/crates/rocie-client/docs/IngredientOneOfRegisteredProduct.md new file mode 100644 index 0000000..a85bc6f --- /dev/null +++ b/crates/rocie-client/docs/IngredientOneOfRegisteredProduct.md @@ -0,0 +1,13 @@ +# IngredientOneOfRegisteredProduct + +## 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) + + diff --git a/crates/rocie-client/docs/Item.md b/crates/rocie-client/docs/Item.md new file mode 100644 index 0000000..805f99d --- /dev/null +++ b/crates/rocie-client/docs/Item.md @@ -0,0 +1,15 @@ +# Item + +## 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) + + diff --git a/crates/rocie-client/docs/ItemOneOf.md b/crates/rocie-client/docs/ItemOneOf.md new file mode 100644 index 0000000..5009d60 --- /dev/null +++ b/crates/rocie-client/docs/ItemOneOf.md @@ -0,0 +1,12 @@ +# ItemOneOf + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**r#type** | **String** | | +**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/ItemOneOf1.md b/crates/rocie-client/docs/ItemOneOf1.md new file mode 100644 index 0000000..8160228 --- /dev/null +++ b/crates/rocie-client/docs/ItemOneOf1.md @@ -0,0 +1,12 @@ +# ItemOneOf1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**index** | **u32** | | +**r#type** | **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/ItemOneOf2.md b/crates/rocie-client/docs/ItemOneOf2.md new file mode 100644 index 0000000..8cfe0f3 --- /dev/null +++ b/crates/rocie-client/docs/ItemOneOf2.md @@ -0,0 +1,12 @@ +# ItemOneOf2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**index** | **u32** | | +**r#type** | **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/ItemOneOf3.md b/crates/rocie-client/docs/ItemOneOf3.md new file mode 100644 index 0000000..2fd7331 --- /dev/null +++ b/crates/rocie-client/docs/ItemOneOf3.md @@ -0,0 +1,12 @@ +# ItemOneOf3 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**index** | **u32** | | +**r#type** | **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/ItemOneOf4.md b/crates/rocie-client/docs/ItemOneOf4.md new file mode 100644 index 0000000..f50a058 --- /dev/null +++ b/crates/rocie-client/docs/ItemOneOf4.md @@ -0,0 +1,12 @@ +# ItemOneOf4 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**index** | **u32** | | +**r#type** | **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 97c02c4..f1a371f 100644 --- a/crates/rocie-client/docs/LoginInfo.md +++ b/crates/rocie-client/docs/LoginInfo.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ------------ | ------------------------------- | ------------------------- | ----- | -| **id** | [**models::UserId**](UserId.md) | The id of the user. | -| **password** | **String** | The password of the user. | - -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to README]](../README.md) +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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 new file mode 100644 index 0000000..4794f5c --- /dev/null +++ b/crates/rocie-client/docs/Metadata.md @@ -0,0 +1,15 @@ +# Metadata + +## 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) + + diff --git a/crates/rocie-client/docs/NameAndUrl.md b/crates/rocie-client/docs/NameAndUrl.md new file mode 100644 index 0000000..829b4db --- /dev/null +++ b/crates/rocie-client/docs/NameAndUrl.md @@ -0,0 +1,12 @@ +# NameAndUrl + +## 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) + + diff --git a/crates/rocie-client/docs/PasswordHash.md b/crates/rocie-client/docs/PasswordHash.md index 208e234..ac022d2 100644 --- a/crates/rocie-client/docs/PasswordHash.md +++ b/crates/rocie-client/docs/PasswordHash.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| --------- | ---------- | ----------- | ----- | -| **value** | **String** | | +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) + -[[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 7e4bdf6..b04a9f1 100644 --- a/crates/rocie-client/docs/Product.md +++ b/crates/rocie-client/docs/Product.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ------------------------ | ---------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------- | -| **associated_bar_codes** | [**Vec<models::Barcode>**](Barcode.md) | Which barcodes are associated with this product. | -| **description** | Option\<**String**> | An optional description of this product. | [optional] | -| **id** | [**models::ProductId**](ProductId.md) | The id of the product. | -| **name** | **String** | The name of the product. This should be globally unique, to make searching easier for the user. | -| **parent** | Option\<[**models::ProductParentId**](ProductParentId.md)> | The parent this product has. This is effectively it's anchor in the product DAG. | [optional] | -| **unit_property** | [**models::UnitPropertyId**](UnitPropertyId.md) | The property this product is measured in. (This is probably always either Mass, Volume or Quantity). | +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) + -[[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 7a841bf..ac5d9cc 100644 --- a/crates/rocie-client/docs/ProductAmount.md +++ b/crates/rocie-client/docs/ProductAmount.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| -------------- | --------------------------------------- | ----------- | ----- | -| **amount** | [**models::UnitAmount**](UnitAmount.md) | | -| **product_id** | [**models::ProductId**](ProductId.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to README]](../README.md) +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**amount** | [**models::UnitAmount**](UnitAmount.md) | | +**product_id** | [**models::ProductId**](ProductId.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/crates/rocie-client/docs/ProductId.md b/crates/rocie-client/docs/ProductId.md index af4e0a9..90dc866 100644 --- a/crates/rocie-client/docs/ProductId.md +++ b/crates/rocie-client/docs/ProductId.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| --------- | ------------------------------- | ----------- | ----- | -| **value** | [**uuid::Uuid**](uuid::Uuid.md) | | +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) + -[[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 8cb0028..a63384b 100644 --- a/crates/rocie-client/docs/ProductParent.md +++ b/crates/rocie-client/docs/ProductParent.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| --------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | ---------- | -| **description** | Option\<**String**> | An optional description of this product parent. | [optional] | -| **id** | [**models::ProductParentId**](ProductParentId.md) | The id of the product parent. | -| **name** | **String** | The name of the product parent. This should be globally unique, to make searching easier for the user. | -| **parent** | Option\<[**models::ProductParentId**](ProductParentId.md)> | The optional id of the parent of this product parent. This must not form a cycle. | [optional] | - -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to README]](../README.md) +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | Option<**String**> | An optional description of this product parent. | [optional] +**id** | [**models::ProductParentId**](ProductParentId.md) | The id of the product parent. | +**name** | **String** | The name of the product parent. This should be globally unique, to make searching easier for the user. | +**parent** | Option<[**models::ProductParentId**](ProductParentId.md)> | The optional id of the parent of this product parent. This must not form a cycle. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/crates/rocie-client/docs/ProductParentId.md b/crates/rocie-client/docs/ProductParentId.md index 49f4e17..c9163f4 100644 --- a/crates/rocie-client/docs/ProductParentId.md +++ b/crates/rocie-client/docs/ProductParentId.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| --------- | ------------------------------- | ----------- | ----- | -| **value** | [**uuid::Uuid**](uuid::Uuid.md) | | +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) + -[[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 a8a3544..c15118e 100644 --- a/crates/rocie-client/docs/ProductParentStub.md +++ b/crates/rocie-client/docs/ProductParentStub.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| --------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ---------- | -| **description** | Option\<**String**> | A description. | [optional] | -| **name** | **String** | The name of the product parent | -| **parent** | Option\<[**models::ProductParentId**](ProductParentId.md)> | A parent of this product parent, otherwise the parent will be the root of the parent tree. | [optional] | - -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to README]](../README.md) +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | Option<**String**> | A description. | [optional] +**name** | **String** | The name of the product parent | +**parent** | Option<[**models::ProductParentId**](ProductParentId.md)> | A parent of this product parent, otherwise the parent will be the root of the parent tree. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/crates/rocie-client/docs/ProductStub.md b/crates/rocie-client/docs/ProductStub.md index 3c25dd4..10d783b 100644 --- a/crates/rocie-client/docs/ProductStub.md +++ b/crates/rocie-client/docs/ProductStub.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ----------------- | ---------------------------------------------------------- | ----------------------------------------------------------------------------------- | ---------- | -| **description** | Option\<**String**> | A description. | [optional] | -| **name** | **String** | The name of the product | -| **parent** | Option\<[**models::ProductParentId**](ProductParentId.md)> | A parent of this product, otherwise the parent will be the root of the parent tree. | [optional] | -| **unit_property** | [**models::UnitPropertyId**](UnitPropertyId.md) | The Unit Property to use for this product. | - -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to README]](../README.md) +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | Option<**String**> | A description. | [optional] +**name** | **String** | The name of the product | +**parent** | Option<[**models::ProductParentId**](ProductParentId.md)> | A parent of this product, otherwise the parent will be the root of the parent tree. | [optional] +**unit_property** | [**models::UnitPropertyId**](UnitPropertyId.md) | The Unit Property to use for this product. | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/crates/rocie-client/docs/Recipe.md b/crates/rocie-client/docs/Recipe.md index d2aa0f9..1c088a6 100644 --- a/crates/rocie-client/docs/Recipe.md +++ b/crates/rocie-client/docs/Recipe.md @@ -2,12 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ----------- | ----------------------------------- | ----------- | ----- | -| **content** | **String** | | -| **id** | [**models::RecipeId**](RecipeId.md) | | -| **path** | **String** | | - -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to README]](../README.md) +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | [**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 812de9a..5211596 100644 --- a/crates/rocie-client/docs/RecipeId.md +++ b/crates/rocie-client/docs/RecipeId.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| --------- | ------------------------------- | ----------- | ----- | -| **value** | [**uuid::Uuid**](uuid::Uuid.md) | | +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) + -[[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 new file mode 100644 index 0000000..3c0c462 --- /dev/null +++ b/crates/rocie-client/docs/RecipeParent.md @@ -0,0 +1,14 @@ +# RecipeParent + +## 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) + + diff --git a/crates/rocie-client/docs/RecipeParentId.md b/crates/rocie-client/docs/RecipeParentId.md new file mode 100644 index 0000000..96737d2 --- /dev/null +++ b/crates/rocie-client/docs/RecipeParentId.md @@ -0,0 +1,11 @@ +# RecipeParentId + +## 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) + + diff --git a/crates/rocie-client/docs/RecipeParentStub.md b/crates/rocie-client/docs/RecipeParentStub.md new file mode 100644 index 0000000..92d8b6d --- /dev/null +++ b/crates/rocie-client/docs/RecipeParentStub.md @@ -0,0 +1,13 @@ +# RecipeParentStub + +## 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) + + diff --git a/crates/rocie-client/docs/RecipeStub.md b/crates/rocie-client/docs/RecipeStub.md index b123337..d1c8a53 100644 --- a/crates/rocie-client/docs/RecipeStub.md +++ b/crates/rocie-client/docs/RecipeStub.md @@ -2,11 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ----------- | ---------- | ---------------------------------------------- | ----- | -| **content** | **String** | The content of this recipe, in cooklang format | -| **path** | **String** | The path the recipe should have | - -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to README]](../README.md) +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | **String** | The content of this recipe, in cooklang format | +**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 new file mode 100644 index 0000000..bc3dcd0 --- /dev/null +++ b/crates/rocie-client/docs/RefinedRecipe.md @@ -0,0 +1,12 @@ +# RefinedRecipe + +## 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) + + diff --git a/crates/rocie-client/docs/Section.md b/crates/rocie-client/docs/Section.md new file mode 100644 index 0000000..2a6de45 --- /dev/null +++ b/crates/rocie-client/docs/Section.md @@ -0,0 +1,12 @@ +# Section + +## 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) + + diff --git a/crates/rocie-client/docs/Step.md b/crates/rocie-client/docs/Step.md new file mode 100644 index 0000000..162c52f --- /dev/null +++ b/crates/rocie-client/docs/Step.md @@ -0,0 +1,12 @@ +# Step + +## 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) + + diff --git a/crates/rocie-client/docs/Timer.md b/crates/rocie-client/docs/Timer.md new file mode 100644 index 0000000..0e65ee7 --- /dev/null +++ b/crates/rocie-client/docs/Timer.md @@ -0,0 +1,12 @@ +# Timer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | Option<**String**> | Name | [optional] +**quantity** | [**models::UnitAmount**](UnitAmount.md) | Time 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/Unit.md b/crates/rocie-client/docs/Unit.md index 2db7b1a..5349b7a 100644 --- a/crates/rocie-client/docs/Unit.md +++ b/crates/rocie-client/docs/Unit.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ---------------------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | -| **description** | Option\<**String**> | Description of this unit. | [optional] | -| **full_name_plural** | **String** | The plural version of this unit's name. Is used by a value of two and more. (We do not support Slovenian dual numerus versions) E.g.: Kilogram -> Kilograms gram -> meters | -| **full_name_singular** | **String** | The singular version of this unit's name. E.g.: Kilogram Gram | -| **id** | [**models::UnitId**](UnitId.md) | Unique id for this unit. | -| **short_name** | **String** | Short name or abbreviation of this unit. E.g.: kg for Kilogram g for gram m for meter | -| **unit_property** | [**models::UnitPropertyId**](UnitPropertyId.md) | Which property is described by this unit. E.g.: kg -> Mass L -> Volume m/s -> Speed and so forth | +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) + -[[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 1bb855d..1546f57 100644 --- a/crates/rocie-client/docs/UnitAmount.md +++ b/crates/rocie-client/docs/UnitAmount.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| --------- | ------------------------------- | ----------- | ----- | -| **unit** | [**models::UnitId**](UnitId.md) | | -| **value** | **u32** | | - -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to README]](../README.md) +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**unit** | [**models::UnitId**](UnitId.md) | | +**value** | **u32** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/crates/rocie-client/docs/UnitId.md b/crates/rocie-client/docs/UnitId.md index 551eda2..7d0979c 100644 --- a/crates/rocie-client/docs/UnitId.md +++ b/crates/rocie-client/docs/UnitId.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| --------- | ------------------------------- | ----------- | ----- | -| **value** | [**uuid::Uuid**](uuid::Uuid.md) | | +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) + -[[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 fc6bfc9..b560f0c 100644 --- a/crates/rocie-client/docs/UnitProperty.md +++ b/crates/rocie-client/docs/UnitProperty.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| --------------- | ----------------------------------------------- | ------------------------------------------- | ---------- | -| **description** | Option\<**String**> | An description of this property. | [optional] | -| **id** | [**models::UnitPropertyId**](UnitPropertyId.md) | The unique ID for this unit property. | -| **name** | **String** | The user-displayed name of this property. | -| **units** | [**Vec<models::UnitId>**](UnitId.md) | The units with are measuring this property. | - -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to README]](../README.md) +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | Option<**String**> | An description of this property. | [optional] +**id** | [**models::UnitPropertyId**](UnitPropertyId.md) | The unique ID for this unit property. | +**name** | **String** | The user-displayed name of this property. | +**units** | [**Vec<models::UnitId>**](UnitId.md) | The units with are measuring this property. | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/crates/rocie-client/docs/UnitPropertyId.md b/crates/rocie-client/docs/UnitPropertyId.md index 7a228c1..34d572f 100644 --- a/crates/rocie-client/docs/UnitPropertyId.md +++ b/crates/rocie-client/docs/UnitPropertyId.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| --------- | ------------------------------- | ----------- | ----- | -| **value** | [**uuid::Uuid**](uuid::Uuid.md) | | +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) + -[[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 e537d6f..0fae3f7 100644 --- a/crates/rocie-client/docs/UnitPropertyStub.md +++ b/crates/rocie-client/docs/UnitPropertyStub.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| --------------- | ------------------- | --------------------------------------------- | ---------- | -| **description** | Option\<**String**> | An optional description of the unit property. | [optional] | -| **name** | **String** | The name of the unit property. | - -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to README]](../README.md) +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | Option<**String**> | An optional description of the unit property. | [optional] +**name** | **String** | The name of the unit property. | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/crates/rocie-client/docs/UnitStub.md b/crates/rocie-client/docs/UnitStub.md index 5b89817..92398c5 100644 --- a/crates/rocie-client/docs/UnitStub.md +++ b/crates/rocie-client/docs/UnitStub.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ---------------------- | ----------------------------------------------- | ----------- | ---------- | -| **description** | Option\<**String**> | | [optional] | -| **full_name_plural** | **String** | | -| **full_name_singular** | **String** | | -| **short_name** | **String** | | -| **unit_property** | [**models::UnitPropertyId**](UnitPropertyId.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to README]](../README.md) +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | Option<**String**> | | [optional] +**full_name_plural** | **String** | | +**full_name_singular** | **String** | | +**short_name** | **String** | | +**unit_property** | [**models::UnitPropertyId**](UnitPropertyId.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/crates/rocie-client/docs/User.md b/crates/rocie-client/docs/User.md index 016740a..d0f2a81 100644 --- a/crates/rocie-client/docs/User.md +++ b/crates/rocie-client/docs/User.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ----------------- | ------------------------------------------- | ------------------------------------- | ---------- | -| **description** | Option\<**String**> | An description of this user. | [optional] | -| **id** | [**models::UserId**](UserId.md) | The unique ID for this user. | -| **name** | **String** | The user-displayed name of this user. | -| **password_hash** | [**models::PasswordHash**](PasswordHash.md) | The hash of the user's password. | - -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to README]](../README.md) +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | Option<**String**> | An description of this user. | [optional] +**id** | [**models::UserId**](UserId.md) | The unique ID for this user. | +**name** | **String** | The user-displayed name of this user. | +**password_hash** | [**models::PasswordHash**](PasswordHash.md) | The hash of the user's password. | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/crates/rocie-client/docs/UserId.md b/crates/rocie-client/docs/UserId.md index b58b3dc..f183106 100644 --- a/crates/rocie-client/docs/UserId.md +++ b/crates/rocie-client/docs/UserId.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| --------- | ------------------------------- | ----------- | ----- | -| **value** | [**uuid::Uuid**](uuid::Uuid.md) | | +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) + -[[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 ef83846..60bd072 100644 --- a/crates/rocie-client/docs/UserStub.md +++ b/crates/rocie-client/docs/UserStub.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| --------------- | ------------------- | ---------------------------------------- | ---------- | -| **description** | Option\<**String**> | An optional description of the new user. | [optional] | -| **name** | **String** | The name of the new user. | -| **password** | **String** | The password of the new user. | - -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to README]](../README.md) +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | Option<**String**> | An optional description of the new user. | [optional] +**name** | **String** | The name of the new user. | +**password** | **String** | The password of the new user. | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + |