aboutsummaryrefslogtreecommitdiffstats
path: root/crates/rocie-client/docs/ApiGetProductApi.md
diff options
context:
space:
mode:
authorBenedikt Peetz <benedikt.peetz@b-peetz.de>2025-12-09 13:12:31 +0100
committerBenedikt Peetz <benedikt.peetz@b-peetz.de>2025-12-09 13:12:31 +0100
commit7565c34d69ee259fef3ac9813d689d97689a6d58 (patch)
treeee4f00e3d090ec288d481cc92781e55637619824 /crates/rocie-client/docs/ApiGetProductApi.md
parentfeat(rocie-server): Implement basic user handling and authentication (diff)
downloadserver-7565c34d69ee259fef3ac9813d689d97689a6d58.zip
style(rocie-client): Format
Diffstat (limited to '')
-rw-r--r--crates/rocie-client/docs/ApiGetProductApi.md126
1 files changed, 65 insertions, 61 deletions
diff --git a/crates/rocie-client/docs/ApiGetProductApi.md b/crates/rocie-client/docs/ApiGetProductApi.md
index 3491910..3310f86 100644
--- a/crates/rocie-client/docs/ApiGetProductApi.md
+++ b/crates/rocie-client/docs/ApiGetProductApi.md
@@ -1,30 +1,26 @@
-# \ApiGetProductApi
-
-All URIs are relative to *http://localhost*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**product_by_id**](ApiGetProductApi.md#product_by_id) | **GET** /product/by-id/{id} | Get Product by id
-[**product_by_name**](ApiGetProductApi.md#product_by_name) | **GET** /product/by-name/{name} | Get Product by name
-[**product_suggestion_by_name**](ApiGetProductApi.md#product_suggestion_by_name) | **GET** /product/by-part-name/{name} | Get Product suggestion by name
-[**products_by_product_parent_id_direct**](ApiGetProductApi.md#products_by_product_parent_id_direct) | **GET** /product/by-product-parent-id-direct/{id} | Get Products by it's product parent id
-[**products_by_product_parent_id_indirect**](ApiGetProductApi.md#products_by_product_parent_id_indirect) | **GET** /product/by-product-parent-id-indirect/{id} | Get Products by it's product parent id
-[**products_in_storage**](ApiGetProductApi.md#products_in_storage) | **GET** /products_in_storage/ | Return all products, which non-null amount in storage
-[**products_registered**](ApiGetProductApi.md#products_registered) | **GET** /products_registered/ | Return all registered products
+# \\ApiGetProductApi
+All URIs are relative to _http://localhost_
+| Method | HTTP request | Description |
+| -------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | ----------------------------------------------------- |
+| [**product_by_id**](ApiGetProductApi.md#product_by_id) | **GET** /product/by-id/{id} | Get Product by id |
+| [**product_by_name**](ApiGetProductApi.md#product_by_name) | **GET** /product/by-name/{name} | Get Product by name |
+| [**product_suggestion_by_name**](ApiGetProductApi.md#product_suggestion_by_name) | **GET** /product/by-part-name/{name} | Get Product suggestion by name |
+| [**products_by_product_parent_id_direct**](ApiGetProductApi.md#products_by_product_parent_id_direct) | **GET** /product/by-product-parent-id-direct/{id} | Get Products by it's product parent id |
+| [**products_by_product_parent_id_indirect**](ApiGetProductApi.md#products_by_product_parent_id_indirect) | **GET** /product/by-product-parent-id-indirect/{id} | Get Products by it's product parent id |
+| [**products_in_storage**](ApiGetProductApi.md#products_in_storage) | **GET** /products_in_storage/ | Return all products, which non-null amount in storage |
+| [**products_registered**](ApiGetProductApi.md#products_registered) | **GET** /products_registered/ | Return all registered products |
## product_by_id
-> models::Product product_by_id(id)
-Get Product by id
+> models::Product product_by_id(id) Get Product by id
### Parameters
-
-Name | Type | Description | Required | Notes
-------------- | ------------- | ------------- | ------------- | -------------
-**id** | [**ProductId**](.md) | Product id | [required] |
+| Name | Type | Description | Required | Notes |
+| ------ | -------------------- | ----------- | ---------- | ----- |
+| **id** | [**ProductId**](.md) | Product id | [required] |
### Return type
@@ -39,20 +35,20 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
+[[Back to top]](#)
+[[Back to API list]](../README.md#documentation-for-api-endpoints)
+[[Back to Model list]](../README.md#documentation-for-models)
+[[Back to README]](../README.md)
## product_by_name
-> models::Product product_by_name(name)
-Get Product by name
+> models::Product product_by_name(name) Get Product by name
### Parameters
-
-Name | Type | Description | Required | Notes
-------------- | ------------- | ------------- | ------------- | -------------
-**name** | **String** | Name of the product | [required] |
+| Name | Type | Description | Required | Notes |
+| -------- | ---------- | ------------------- | ---------- | ----- |
+| **name** | **String** | Name of the product | [required] |
### Return type
@@ -67,20 +63,21 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
+[[Back to top]](#)
+[[Back to API list]](../README.md#documentation-for-api-endpoints)
+[[Back to Model list]](../README.md#documentation-for-models)
+[[Back to README]](../README.md)
## product_suggestion_by_name
-> Vec<models::Product> product_suggestion_by_name(name)
-Get Product suggestion by name
+> Vec<models::Product> product_suggestion_by_name(name) Get Product suggestion
+> by name
### Parameters
-
-Name | Type | Description | Required | Notes
-------------- | ------------- | ------------- | ------------- | -------------
-**name** | **String** | Partial name of a product | [required] |
+| Name | Type | Description | Required | Notes |
+| -------- | ---------- | ------------------------- | ---------- | ----- |
+| **name** | **String** | Partial name of a product | [required] |
### Return type
@@ -95,22 +92,23 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
+[[Back to top]](#)
+[[Back to API list]](../README.md#documentation-for-api-endpoints)
+[[Back to Model list]](../README.md#documentation-for-models)
+[[Back to README]](../README.md)
## products_by_product_parent_id_direct
-> Vec<models::Product> products_by_product_parent_id_direct(id)
-Get Products by it's product parent id
+> Vec<models::Product> products_by_product_parent_id_direct(id) Get Products by
+> it's product parent id
This will only return products directly associated with this product parent id
### Parameters
-
-Name | Type | Description | Required | Notes
-------------- | ------------- | ------------- | ------------- | -------------
-**id** | [**ProductParentId**](.md) | Product parent id | [required] |
+| Name | Type | Description | Required | Notes |
+| ------ | -------------------------- | ----------------- | ---------- | ----- |
+| **id** | [**ProductParentId**](.md) | Product parent id | [required] |
### Return type
@@ -125,22 +123,23 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
+[[Back to top]](#)
+[[Back to API list]](../README.md#documentation-for-api-endpoints)
+[[Back to Model list]](../README.md#documentation-for-models)
+[[Back to README]](../README.md)
## products_by_product_parent_id_indirect
-> Vec<models::Product> products_by_product_parent_id_indirect(id)
-Get Products by it's product parent id
+> Vec<models::Product> products_by_product_parent_id_indirect(id) Get Products
+> by it's product parent id
This will also return all products below this product parent id
### Parameters
-
-Name | Type | Description | Required | Notes
-------------- | ------------- | ------------- | ------------- | -------------
-**id** | [**ProductParentId**](.md) | Product parent id | [required] |
+| Name | Type | Description | Required | Notes |
+| ------ | -------------------------- | ----------------- | ---------- | ----- |
+| **id** | [**ProductParentId**](.md) | Product parent id | [required] |
### Return type
@@ -155,13 +154,15 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
+[[Back to top]](#)
+[[Back to API list]](../README.md#documentation-for-api-endpoints)
+[[Back to Model list]](../README.md#documentation-for-models)
+[[Back to README]](../README.md)
## products_in_storage
-> Vec<models::Product> products_in_storage()
-Return all products, which non-null amount in storage
+> Vec<models::Product> products_in_storage() Return all products, which non-null
+> amount in storage
### Parameters
@@ -180,13 +181,14 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
+[[Back to top]](#)
+[[Back to API list]](../README.md#documentation-for-api-endpoints)
+[[Back to Model list]](../README.md#documentation-for-models)
+[[Back to README]](../README.md)
## products_registered
-> Vec<models::Product> products_registered()
-Return all registered products
+> Vec<models::Product> products_registered() Return all registered products
### Parameters
@@ -205,5 +207,7 @@ No authorization required
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
+[[Back to top]](#)
+[[Back to API list]](../README.md#documentation-for-api-endpoints)
+[[Back to Model list]](../README.md#documentation-for-models)
+[[Back to README]](../README.md)