about summary refs log tree commit diff stats
path: root/crates/rocie-client/docs
diff options
context:
space:
mode:
authorBenedikt Peetz <benedikt.peetz@b-peetz.de>2025-11-28 16:35:35 +0100
committerBenedikt Peetz <benedikt.peetz@b-peetz.de>2025-11-28 16:35:35 +0100
commita479685602347b473d74f99f492e5e85d7afde94 (patch)
treeed7eea0fbab0a9f33d959345719d638271539da0 /crates/rocie-client/docs
parentfeat(crates/rocie-cli): Add support for product parents (diff)
downloadserver-a479685602347b473d74f99f492e5e85d7afde94.zip
chore(crates/rocie-client): Re-generate
Diffstat (limited to 'crates/rocie-client/docs')
-rw-r--r--crates/rocie-client/docs/ApiGetProductApi.md94
-rw-r--r--crates/rocie-client/docs/ApiGetProductParentApi.md89
-rw-r--r--crates/rocie-client/docs/ApiGetRecipeApi.md63
-rw-r--r--crates/rocie-client/docs/ApiGetUnitApi.md29
-rw-r--r--crates/rocie-client/docs/ApiSetProductParentApi.md37
-rw-r--r--crates/rocie-client/docs/ApiSetRecipeApi.md37
-rw-r--r--crates/rocie-client/docs/Product.md1
-rw-r--r--crates/rocie-client/docs/ProductParent.md14
-rw-r--r--crates/rocie-client/docs/ProductParentId.md11
-rw-r--r--crates/rocie-client/docs/ProductParentStub.md13
-rw-r--r--crates/rocie-client/docs/ProductStub.md2
-rw-r--r--crates/rocie-client/docs/Recipe.md13
-rw-r--r--crates/rocie-client/docs/RecipeId.md11
-rw-r--r--crates/rocie-client/docs/RecipeStub.md12
-rw-r--r--crates/rocie-client/docs/UnitPropertyStub.md4
15 files changed, 424 insertions, 6 deletions
diff --git a/crates/rocie-client/docs/ApiGetProductApi.md b/crates/rocie-client/docs/ApiGetProductApi.md
index a7d0918..3491910 100644
--- a/crates/rocie-client/docs/ApiGetProductApi.md
+++ b/crates/rocie-client/docs/ApiGetProductApi.md
@@ -7,7 +7,10 @@ Method | HTTP request | Description
 [**product_by_id**](ApiGetProductApi.md#product_by_id) | **GET** /product/by-id/{id} | Get Product by id
 [**product_by_name**](ApiGetProductApi.md#product_by_name) | **GET** /product/by-name/{name} | Get Product by name
 [**product_suggestion_by_name**](ApiGetProductApi.md#product_suggestion_by_name) | **GET** /product/by-part-name/{name} | Get Product suggestion by name
-[**products**](ApiGetProductApi.md#products) | **GET** /products/ | Return all registered products
+[**products_by_product_parent_id_direct**](ApiGetProductApi.md#products_by_product_parent_id_direct) | **GET** /product/by-product-parent-id-direct/{id} | Get Products by it's product parent id
+[**products_by_product_parent_id_indirect**](ApiGetProductApi.md#products_by_product_parent_id_indirect) | **GET** /product/by-product-parent-id-indirect/{id} | Get Products by it's product parent id
+[**products_in_storage**](ApiGetProductApi.md#products_in_storage) | **GET** /products_in_storage/ | Return all products, which non-null amount in storage
+[**products_registered**](ApiGetProductApi.md#products_registered) | **GET** /products_registered/ | Return all registered products
 
 
 
@@ -95,9 +98,94 @@ No authorization required
 [[Back to top]](#) [[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
+## products_by_product_parent_id_direct
 
-> Vec<models::Product> products()
+> 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] |
+
+### 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_by_product_parent_id_indirect
+
+> 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] |
+
+### 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_in_storage
+
+> Vec<models::Product> products_in_storage()
+Return all products, which non-null amount in storage
+
+### 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_registered
+
+> Vec<models::Product> products_registered()
 Return all registered products
 
 ### Parameters
diff --git a/crates/rocie-client/docs/ApiGetProductParentApi.md b/crates/rocie-client/docs/ApiGetProductParentApi.md
new file mode 100644
index 0000000..3c61982
--- /dev/null
+++ b/crates/rocie-client/docs/ApiGetProductParentApi.md
@@ -0,0 +1,89 @@
+# \ApiGetProductParentApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**product_parents**](ApiGetProductParentApi.md#product_parents) | **GET** /product_parents/ | Return all registered product parents
+[**product_parents_toplevel**](ApiGetProductParentApi.md#product_parents_toplevel) | **GET** /product_parents_toplevel/ | Return all registered product parents, that have no parents themselves
+[**product_parents_under**](ApiGetProductParentApi.md#product_parents_under) | **GET** /product_parents_under/{id} | Return all parents, that have this parent as parent
+
+
+
+## product_parents
+
+> Vec<models::ProductParent> product_parents()
+Return all registered product parents
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Vec<models::ProductParent>**](ProductParent.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)
+
+
+## product_parents_toplevel
+
+> Vec<models::ProductParent> product_parents_toplevel()
+Return all registered product parents, that have no parents themselves
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Vec<models::ProductParent>**](ProductParent.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)
+
+
+## product_parents_under
+
+> 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] |
+
+### Return type
+
+[**Vec<models::ProductParent>**](ProductParent.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/ApiGetRecipeApi.md b/crates/rocie-client/docs/ApiGetRecipeApi.md
new file mode 100644
index 0000000..cce6112
--- /dev/null
+++ b/crates/rocie-client/docs/ApiGetRecipeApi.md
@@ -0,0 +1,63 @@
+# \ApiGetRecipeApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**recipe_by_id**](ApiGetRecipeApi.md#recipe_by_id) | **GET** /recipe/by-id/{id} | Get an recipe by it's id.
+[**recipes**](ApiGetRecipeApi.md#recipes) | **GET** /recipe/all | Get all added recipes
+
+
+
+## recipe_by_id
+
+> models::Recipe recipe_by_id(id)
+Get an recipe by it's id.
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | [**RecipeId**](.md) | Recipe id | [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
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### 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)
+
diff --git a/crates/rocie-client/docs/ApiGetUnitApi.md b/crates/rocie-client/docs/ApiGetUnitApi.md
index f539aec..f2fc6e6 100644
--- a/crates/rocie-client/docs/ApiGetUnitApi.md
+++ b/crates/rocie-client/docs/ApiGetUnitApi.md
@@ -6,6 +6,7 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**unit_by_id**](ApiGetUnitApi.md#unit_by_id) | **GET** /unit/{id} | Get Unit by id
 [**units**](ApiGetUnitApi.md#units) | **GET** /units/ | Return all registered units
+[**units_by_property_id**](ApiGetUnitApi.md#units_by_property_id) | **GET** /units-by-property/{id} | Return all registered units for a specific unit property
 
 
 
@@ -61,3 +62,31 @@ No authorization required
 
 [[Back to top]](#) [[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
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**id** | [**UnitPropertyId**](.md) | Unit property id | [required] |
+
+### Return type
+
+[**Vec<models::Unit>**](Unit.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, text/plain
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
diff --git a/crates/rocie-client/docs/ApiSetProductParentApi.md b/crates/rocie-client/docs/ApiSetProductParentApi.md
new file mode 100644
index 0000000..116175c
--- /dev/null
+++ b/crates/rocie-client/docs/ApiSetProductParentApi.md
@@ -0,0 +1,37 @@
+# \ApiSetProductParentApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**register_product_parent**](ApiSetProductParentApi.md#register_product_parent) | **POST** /product_parent/new | Register a product parent
+
+
+
+## register_product_parent
+
+> models::ProductParentId register_product_parent(product_parent_stub)
+Register a product parent
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**product_parent_stub** | [**ProductParentStub**](ProductParentStub.md) |  | [required] |
+
+### Return type
+
+[**models::ProductParentId**](ProductParentId.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/ApiSetRecipeApi.md b/crates/rocie-client/docs/ApiSetRecipeApi.md
new file mode 100644
index 0000000..00f2670
--- /dev/null
+++ b/crates/rocie-client/docs/ApiSetRecipeApi.md
@@ -0,0 +1,37 @@
+# \ApiSetRecipeApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_recipe**](ApiSetRecipeApi.md#add_recipe) | **POST** /recipe/new | Register a product parent
+
+
+
+## add_recipe
+
+> models::RecipeId add_recipe(recipe_stub)
+Register a product parent
+
+### Parameters
+
+
+Name | Type | Description  | Required | Notes
+------------- | ------------- | ------------- | ------------- | -------------
+**recipe_stub** | [**RecipeStub**](RecipeStub.md) |  | [required] |
+
+### Return type
+
+[**models::RecipeId**](RecipeId.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/Product.md b/crates/rocie-client/docs/Product.md
index 3de03ae..83536ff 100644
--- a/crates/rocie-client/docs/Product.md
+++ b/crates/rocie-client/docs/Product.md
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **description** | Option<**String**> | An optional description of this product. | [optional]
 **id** | [**models::ProductId**](ProductId.md) | The id of the product. | 
 **name** | **String** | The name of the product.  This should be globally unique, to make searching easier for the user. | 
+**parent** | Option<[**models::ProductParentId**](ProductParentId.md)> | The parent this product has.  This is effectively it's anchor in the product DAG. | [optional]
 **unit_property** | [**models::UnitPropertyId**](UnitPropertyId.md) | The property this product is measured in.  (This is probably always either Mass, Volume or Quantity). | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/crates/rocie-client/docs/ProductParent.md b/crates/rocie-client/docs/ProductParent.md
new file mode 100644
index 0000000..a63384b
--- /dev/null
+++ b/crates/rocie-client/docs/ProductParent.md
@@ -0,0 +1,14 @@
+# ProductParent
+
+## 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)
+
+
diff --git a/crates/rocie-client/docs/ProductParentId.md b/crates/rocie-client/docs/ProductParentId.md
new file mode 100644
index 0000000..c9163f4
--- /dev/null
+++ b/crates/rocie-client/docs/ProductParentId.md
@@ -0,0 +1,11 @@
+# ProductParentId
+
+## 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/ProductParentStub.md b/crates/rocie-client/docs/ProductParentStub.md
new file mode 100644
index 0000000..c15118e
--- /dev/null
+++ b/crates/rocie-client/docs/ProductParentStub.md
@@ -0,0 +1,13 @@
+# ProductParentStub
+
+## 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)
+
+
diff --git a/crates/rocie-client/docs/ProductStub.md b/crates/rocie-client/docs/ProductStub.md
index 8bed531..10d783b 100644
--- a/crates/rocie-client/docs/ProductStub.md
+++ b/crates/rocie-client/docs/ProductStub.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **description** | Option<**String**> | A description. | [optional]
 **name** | **String** | The name of the product | 
-**parent** | Option<[**models::ProductId**](ProductId.md)> | A parent of this product, otherwise the parent will be the root of the parent tree. | [optional]
+**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
new file mode 100644
index 0000000..d179f97
--- /dev/null
+++ b/crates/rocie-client/docs/Recipe.md
@@ -0,0 +1,13 @@
+# Recipe
+
+## 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)
+
+
diff --git a/crates/rocie-client/docs/RecipeId.md b/crates/rocie-client/docs/RecipeId.md
new file mode 100644
index 0000000..5211596
--- /dev/null
+++ b/crates/rocie-client/docs/RecipeId.md
@@ -0,0 +1,11 @@
+# RecipeId
+
+## 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/RecipeStub.md b/crates/rocie-client/docs/RecipeStub.md
new file mode 100644
index 0000000..4545fff
--- /dev/null
+++ b/crates/rocie-client/docs/RecipeStub.md
@@ -0,0 +1,12 @@
+# RecipeStub
+
+## 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)
+
+
diff --git a/crates/rocie-client/docs/UnitPropertyStub.md b/crates/rocie-client/docs/UnitPropertyStub.md
index 8f6bcbe..0fae3f7 100644
--- a/crates/rocie-client/docs/UnitPropertyStub.md
+++ b/crates/rocie-client/docs/UnitPropertyStub.md
@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**description** | Option<**String**> |  | [optional]
-**name** | **String** |  | 
+**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)