about summary refs log tree commit diff stats
path: root/crates/rocie-client/docs/ApiGetAuthProductApi.md
diff options
context:
space:
mode:
authorBenedikt Peetz <benedikt.peetz@b-peetz.de>2026-02-15 22:25:39 +0100
committerBenedikt Peetz <benedikt.peetz@b-peetz.de>2026-02-15 22:25:39 +0100
commitb467f7202f5c0c3970e39ea396a0cec0fd6a36ee (patch)
treeaa567f84f0c2891d03de5b6414507c2d9a5f4754 /crates/rocie-client/docs/ApiGetAuthProductApi.md
parentfeat(treewide): Add recipes and user handling (diff)
downloadserver-b467f7202f5c0c3970e39ea396a0cec0fd6a36ee.zip
chore(rocie-client): Re-generate the client api
Diffstat (limited to 'crates/rocie-client/docs/ApiGetAuthProductApi.md')
-rw-r--r--crates/rocie-client/docs/ApiGetAuthProductApi.md154


1 files changed, 89 insertions, 65 deletions
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)
+

 

generated by cgit-pink 1.4.1 (git 2.36.1) at 2026-03-21 18:09:30 +0000