diff options
Diffstat (limited to 'crates/rocie-client/docs/ApiGetAuthProductApi.md')
| -rw-r--r-- | crates/rocie-client/docs/ApiGetAuthProductApi.md | 138 |
1 files changed, 72 insertions, 66 deletions
diff --git a/crates/rocie-client/docs/ApiGetAuthProductApi.md b/crates/rocie-client/docs/ApiGetAuthProductApi.md index cb7fb13..bcf2013 100644 --- a/crates/rocie-client/docs/ApiGetAuthProductApi.md +++ b/crates/rocie-client/docs/ApiGetAuthProductApi.md @@ -10,34 +10,30 @@ You should have received a copy of the License along with this program. If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>. --> -# \ApiGetAuthProductApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**product_by_id**](ApiGetAuthProductApi.md#product_by_id) | **GET** /product/by-id/{id} | Get Product by id -[**product_by_name**](ApiGetAuthProductApi.md#product_by_name) | **GET** /product/by-name/{name} | Get Product by name -[**product_suggestion_by_name**](ApiGetAuthProductApi.md#product_suggestion_by_name) | **GET** /product/by-part-name/{name} | Get Product suggestion by name -[**products_by_product_parent_id_direct**](ApiGetAuthProductApi.md#products_by_product_parent_id_direct) | **GET** /product/by-product-parent-id-direct/{id} | Get Products by it's product parent id -[**products_by_product_parent_id_indirect**](ApiGetAuthProductApi.md#products_by_product_parent_id_indirect) | **GET** /product/by-product-parent-id-indirect/{id} | Get Products by it's product parent id -[**products_in_storage**](ApiGetAuthProductApi.md#products_in_storage) | **GET** /products_in_storage/ | Return all products, which non-null amount in storage -[**products_registered**](ApiGetAuthProductApi.md#products_registered) | **GET** /products_registered/ | Return all registered products -[**products_without_product_parent**](ApiGetAuthProductApi.md#products_without_product_parent) | **GET** /product/without-product-parent | Get Products by it's absents of a product parent +# \\ApiGetAuthProductApi +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------- | ----------------------------------------------------- | +| [**product_by_id**](ApiGetAuthProductApi.md#product_by_id) | **GET** /product/by-id/{id} | Get Product by id | +| [**product_by_name**](ApiGetAuthProductApi.md#product_by_name) | **GET** /product/by-name/{name} | Get Product by name | +| [**product_suggestion_by_name**](ApiGetAuthProductApi.md#product_suggestion_by_name) | **GET** /product/by-part-name/{name} | Get Product suggestion by name | +| [**products_by_product_parent_id_direct**](ApiGetAuthProductApi.md#products_by_product_parent_id_direct) | **GET** /product/by-product-parent-id-direct/{id} | Get Products by it's product parent id | +| [**products_by_product_parent_id_indirect**](ApiGetAuthProductApi.md#products_by_product_parent_id_indirect) | **GET** /product/by-product-parent-id-indirect/{id} | Get Products by it's product parent id | +| [**products_in_storage**](ApiGetAuthProductApi.md#products_in_storage) | **GET** /products_in_storage/ | Return all products, which non-null amount in storage | +| [**products_registered**](ApiGetAuthProductApi.md#products_registered) | **GET** /products_registered/ | Return all registered products | +| [**products_without_product_parent**](ApiGetAuthProductApi.md#products_without_product_parent) | **GET** /product/without-product-parent | Get Products by it's absents of a product parent | ## product_by_id -> models::Product product_by_id(id) -Get Product by id +> models::Product product_by_id(id) Get Product by id ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**ProductId**](.md) | Product id | [required] | +| Name | Type | Description | Required | Notes | +| ------ | -------------------- | ----------- | ---------- | ----- | +| **id** | [**ProductId**](.md) | Product id | [required] | ### Return type @@ -52,20 +48,20 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json, text/plain -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) ## product_by_name -> models::Product product_by_name(name) -Get Product by name +> models::Product product_by_name(name) Get Product by name ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**name** | **String** | Name of the product | [required] | +| Name | Type | Description | Required | Notes | +| -------- | ---------- | ------------------- | ---------- | ----- | +| **name** | **String** | Name of the product | [required] | ### Return type @@ -80,20 +76,21 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json, text/plain -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) ## product_suggestion_by_name -> Vec<models::Product> product_suggestion_by_name(name) -Get Product suggestion by name +> Vec<models::Product> product_suggestion_by_name(name) Get Product suggestion +> by name ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**name** | **String** | Partial name of a product | [required] | +| Name | Type | Description | Required | Notes | +| -------- | ---------- | ------------------------- | ---------- | ----- | +| **name** | **String** | Partial name of a product | [required] | ### Return type @@ -108,22 +105,23 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json, text/plain -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) ## products_by_product_parent_id_direct -> Vec<models::Product> products_by_product_parent_id_direct(id) -Get Products by it's product parent id +> Vec<models::Product> products_by_product_parent_id_direct(id) Get Products by +> it's product parent id This will only return products directly associated with this product parent id ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**ProductParentId**](.md) | Product parent id | [required] | +| Name | Type | Description | Required | Notes | +| ------ | -------------------------- | ----------------- | ---------- | ----- | +| **id** | [**ProductParentId**](.md) | Product parent id | [required] | ### Return type @@ -138,22 +136,23 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json, text/plain -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) ## products_by_product_parent_id_indirect -> Vec<models::Product> products_by_product_parent_id_indirect(id) -Get Products by it's product parent id +> Vec<models::Product> products_by_product_parent_id_indirect(id) Get Products +> by it's product parent id This will also return all products below this product parent id ### Parameters - -Name | Type | Description | Required | Notes -------------- | ------------- | ------------- | ------------- | ------------- -**id** | [**ProductParentId**](.md) | Product parent id | [required] | +| Name | Type | Description | Required | Notes | +| ------ | -------------------------- | ----------------- | ---------- | ----- | +| **id** | [**ProductParentId**](.md) | Product parent id | [required] | ### Return type @@ -168,13 +167,15 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json, text/plain -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) ## products_in_storage -> Vec<models::Product> products_in_storage() -Return all products, which non-null amount in storage +> Vec<models::Product> products_in_storage() Return all products, which non-null +> amount in storage ### Parameters @@ -193,13 +194,14 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json, text/plain -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) ## products_registered -> Vec<models::Product> products_registered() -Return all registered products +> Vec<models::Product> products_registered() Return all registered products ### Parameters @@ -218,13 +220,15 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json, text/plain -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) ## products_without_product_parent -> Vec<models::Product> products_without_product_parent() -Get Products by it's absents of a product parent +> Vec<models::Product> products_without_product_parent() Get Products by it's +> absents of a product parent This will only return products without a product parent associated with it @@ -245,5 +249,7 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json, text/plain -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) |