diff options
| author | Benedikt Peetz <benedikt.peetz@b-peetz.de> | 2025-09-06 18:31:40 +0200 |
|---|---|---|
| committer | Benedikt Peetz <benedikt.peetz@b-peetz.de> | 2025-09-06 18:31:40 +0200 |
| commit | 1c09b0eb5db415985bfefb52786dbe48d757665e (patch) | |
| tree | db1cdbcff8baae9a73fca34e14b52cb8cf7ff230 /crates/rocie-client/docs/ApiGetProductApi.md | |
| parent | feat: Provide basic API frame (diff) | |
| download | server-1c09b0eb5db415985bfefb52786dbe48d757665e.zip | |
feat: Provide basic barcode handling support
Diffstat (limited to 'crates/rocie-client/docs/ApiGetProductApi.md')
| -rw-r--r-- | crates/rocie-client/docs/ApiGetProductApi.md | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/crates/rocie-client/docs/ApiGetProductApi.md b/crates/rocie-client/docs/ApiGetProductApi.md new file mode 100644 index 0000000..58955c6 --- /dev/null +++ b/crates/rocie-client/docs/ApiGetProductApi.md @@ -0,0 +1,63 @@ +# \ApiGetProductApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**product_by_id**](ApiGetProductApi.md#product_by_id) | **GET** /product/{id} | Get Product by id +[**products**](ApiGetProductApi.md#products) | **GET** /products/ | Return all registered products + + + +## product_by_id + +> models::Product product_by_id(id) +Get Product by id + +### Parameters + + +Name | Type | Description | Required | Notes +------------- | ------------- | ------------- | ------------- | ------------- +**id** | **uuid::Uuid** | Product id | [required] | + +### Return type + +[**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 + +> Vec<models::Product> products() +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) + |
