diff options
| author | Benedikt Peetz <benedikt.peetz@b-peetz.de> | 2025-09-06 10:31:40 +0200 |
|---|---|---|
| committer | Benedikt Peetz <benedikt.peetz@b-peetz.de> | 2025-09-06 10:31:40 +0200 |
| commit | 9a9d5c5880095adeb43a045dca638243c8f946e4 (patch) | |
| tree | 86e0d23af339b3139efab15749aaf5b59aa0965b /crates/rocie-client/docs/ApiSetApi.md | |
| parent | chore: Initial commit (diff) | |
| download | server-9a9d5c5880095adeb43a045dca638243c8f946e4.zip | |
feat: Provide basic API frame
Diffstat (limited to 'crates/rocie-client/docs/ApiSetApi.md')
| -rw-r--r-- | crates/rocie-client/docs/ApiSetApi.md | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/crates/rocie-client/docs/ApiSetApi.md b/crates/rocie-client/docs/ApiSetApi.md new file mode 100644 index 0000000..87f88b8 --- /dev/null +++ b/crates/rocie-client/docs/ApiSetApi.md @@ -0,0 +1,67 @@ +# \ApiSetApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**associate_barcode**](ApiSetApi.md#associate_barcode) | **POST** /product/{id}/associate | Associate a barcode with a product +[**register_product**](ApiSetApi.md#register_product) | **POST** /product/new | Register a product + + + +## associate_barcode + +> associate_barcode(id, barcode) +Associate a barcode with a product + +### Parameters + + +Name | Type | Description | Required | Notes +------------- | ------------- | ------------- | ------------- | ------------- +**id** | **uuid::Uuid** | The id of the product to associated the barcode with | [required] | +**barcode** | [**Barcode**](Barcode.md) | | [required] | + +### Return type + + (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + +[[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) + + +## register_product + +> uuid::Uuid register_product(product_stub) +Register a product + +### Parameters + + +Name | Type | Description | Required | Notes +------------- | ------------- | ------------- | ------------- | ------------- +**product_stub** | [**ProductStub**](ProductStub.md) | | [required] | + +### Return type + +[**uuid::Uuid**](uuid::Uuid.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[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) + |
