aboutsummaryrefslogtreecommitdiffstats
path: root/crates/rocie-client/docs/ApiSetApi.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/ApiSetApi.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/ApiSetApi.md50
1 files changed, 24 insertions, 26 deletions
diff --git a/crates/rocie-client/docs/ApiSetApi.md b/crates/rocie-client/docs/ApiSetApi.md
index 6129e50..21f6c35 100644
--- a/crates/rocie-client/docs/ApiSetApi.md
+++ b/crates/rocie-client/docs/ApiSetApi.md
@@ -1,30 +1,26 @@
-# \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
+# \\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
+> 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] |
+| 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)
+(empty response body)
### Authorization
@@ -35,20 +31,20 @@ No authorization required
- **Content-Type**: application/json
- **Accept**: 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)
## register_product
-> uuid::Uuid register_product(product_stub)
-Register a product
+> uuid::Uuid register_product(product_stub) Register a product
### Parameters
-
-Name | Type | Description | Required | Notes
-------------- | ------------- | ------------- | ------------- | -------------
-**product_stub** | [**ProductStub**](ProductStub.md) | | [required] |
+| Name | Type | Description | Required | Notes |
+| ---------------- | --------------------------------- | ----------- | ---------- | ----- |
+| **product_stub** | [**ProductStub**](ProductStub.md) | | [required] |
### Return type
@@ -63,5 +59,7 @@ No authorization required
- **Content-Type**: application/json
- **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)