diff options
| author | Benedikt Peetz <benedikt.peetz@b-peetz.de> | 2025-10-08 12:05:36 +0200 |
|---|---|---|
| committer | Benedikt Peetz <benedikt.peetz@b-peetz.de> | 2025-10-08 12:05:36 +0200 |
| commit | 56f72f4d4c39588fe50414a4db1e8e345047c5d2 (patch) | |
| tree | a542157074c81a724eee6b30a6c26c1f5b3493de /crates/rocie-client/docs | |
| parent | feat(crates/rocie-cli): Add support for unit-properties (diff) | |
| download | server-56f72f4d4c39588fe50414a4db1e8e345047c5d2.zip | |
chore(crates/rocie-client): Re-generate
Diffstat (limited to 'crates/rocie-client/docs')
| -rw-r--r-- | crates/rocie-client/docs/ApiGetUnitPropertyApi.md | 63 | ||||
| -rw-r--r-- | crates/rocie-client/docs/ApiSetUnitPropertyApi.md | 37 | ||||
| -rw-r--r-- | crates/rocie-client/docs/Product.md | 9 | ||||
| -rw-r--r-- | crates/rocie-client/docs/ProductStub.md | 7 | ||||
| -rw-r--r-- | crates/rocie-client/docs/Unit.md | 11 | ||||
| -rw-r--r-- | crates/rocie-client/docs/UnitProperty.md | 14 | ||||
| -rw-r--r-- | crates/rocie-client/docs/UnitPropertyId.md | 11 | ||||
| -rw-r--r-- | crates/rocie-client/docs/UnitPropertyStub.md | 12 | ||||
| -rw-r--r-- | crates/rocie-client/docs/UnitStub.md | 1 |
9 files changed, 153 insertions, 12 deletions
diff --git a/crates/rocie-client/docs/ApiGetUnitPropertyApi.md b/crates/rocie-client/docs/ApiGetUnitPropertyApi.md new file mode 100644 index 0000000..e59d876 --- /dev/null +++ b/crates/rocie-client/docs/ApiGetUnitPropertyApi.md @@ -0,0 +1,63 @@ +# \ApiGetUnitPropertyApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**unit_properties**](ApiGetUnitPropertyApi.md#unit_properties) | **GET** /unit-properties/ | Return all registered unit properties +[**unit_property_by_id**](ApiGetUnitPropertyApi.md#unit_property_by_id) | **GET** /unit-property/{id} | Get Unit property by id + + + +## unit_properties + +> Vec<models::UnitProperty> unit_properties() +Return all registered unit properties + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**Vec<models::UnitProperty>**](UnitProperty.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) + + +## unit_property_by_id + +> models::UnitProperty unit_property_by_id(id) +Get Unit property by id + +### Parameters + + +Name | Type | Description | Required | Notes +------------- | ------------- | ------------- | ------------- | ------------- +**id** | [**UnitPropertyId**](.md) | Unit Property id | [required] | + +### Return type + +[**models::UnitProperty**](UnitProperty.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) + diff --git a/crates/rocie-client/docs/ApiSetUnitPropertyApi.md b/crates/rocie-client/docs/ApiSetUnitPropertyApi.md new file mode 100644 index 0000000..b54aec1 --- /dev/null +++ b/crates/rocie-client/docs/ApiSetUnitPropertyApi.md @@ -0,0 +1,37 @@ +# \ApiSetUnitPropertyApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**register_unit_property**](ApiSetUnitPropertyApi.md#register_unit_property) | **POST** /unit-property/new | Register an Unit Property + + + +## register_unit_property + +> models::UnitPropertyId register_unit_property(unit_property_stub) +Register an Unit Property + +### Parameters + + +Name | Type | Description | Required | Notes +------------- | ------------- | ------------- | ------------- | ------------- +**unit_property_stub** | [**UnitPropertyStub**](UnitPropertyStub.md) | | [required] | + +### Return type + +[**models::UnitPropertyId**](UnitPropertyId.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **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) + diff --git a/crates/rocie-client/docs/Product.md b/crates/rocie-client/docs/Product.md index 6f0f914..3de03ae 100644 --- a/crates/rocie-client/docs/Product.md +++ b/crates/rocie-client/docs/Product.md @@ -4,10 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**associated_bar_codes** | [**Vec<models::Barcode>**](Barcode.md) | | -**description** | Option<**String**> | | [optional] -**id** | [**models::ProductId**](ProductId.md) | | -**name** | **String** | | +**associated_bar_codes** | [**Vec<models::Barcode>**](Barcode.md) | Which barcodes are associated with this product. | +**description** | Option<**String**> | An optional description of this product. | [optional] +**id** | [**models::ProductId**](ProductId.md) | The id of the product. | +**name** | **String** | The name of the product. This should be globally unique, to make searching easier for the user. | +**unit_property** | [**models::UnitPropertyId**](UnitPropertyId.md) | The property this product is measured in. (This is probably always either Mass, Volume or Quantity). | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/crates/rocie-client/docs/ProductStub.md b/crates/rocie-client/docs/ProductStub.md index 4d4ffde..8bed531 100644 --- a/crates/rocie-client/docs/ProductStub.md +++ b/crates/rocie-client/docs/ProductStub.md @@ -4,9 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**description** | Option<**String**> | | [optional] -**name** | **String** | | -**parent** | Option<[**models::ProductId**](ProductId.md)> | | [optional] +**description** | Option<**String**> | A description. | [optional] +**name** | **String** | The name of the product | +**parent** | Option<[**models::ProductId**](ProductId.md)> | A parent of this product, otherwise the parent will be the root of the parent tree. | [optional] +**unit_property** | [**models::UnitPropertyId**](UnitPropertyId.md) | The Unit Property to use for this product. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/crates/rocie-client/docs/Unit.md b/crates/rocie-client/docs/Unit.md index 5e86ab3..5349b7a 100644 --- a/crates/rocie-client/docs/Unit.md +++ b/crates/rocie-client/docs/Unit.md @@ -4,11 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**description** | Option<**String**> | | [optional] -**full_name_plural** | **String** | | -**full_name_singular** | **String** | | -**id** | [**models::UnitId**](UnitId.md) | | -**short_name** | **String** | | +**description** | Option<**String**> | Description of this unit. | [optional] +**full_name_plural** | **String** | The plural version of this unit's name. Is used by a value of two and more. (We do not support Slovenian dual numerus versions) E.g.: Kilogram -> Kilograms gram -> meters | +**full_name_singular** | **String** | The singular version of this unit's name. E.g.: Kilogram Gram | +**id** | [**models::UnitId**](UnitId.md) | Unique id for this unit. | +**short_name** | **String** | Short name or abbreviation of this unit. E.g.: kg for Kilogram g for gram m for meter | +**unit_property** | [**models::UnitPropertyId**](UnitPropertyId.md) | Which property is described by this unit. E.g.: kg -> Mass L -> Volume m/s -> Speed and so forth | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/crates/rocie-client/docs/UnitProperty.md b/crates/rocie-client/docs/UnitProperty.md new file mode 100644 index 0000000..b560f0c --- /dev/null +++ b/crates/rocie-client/docs/UnitProperty.md @@ -0,0 +1,14 @@ +# UnitProperty + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | Option<**String**> | An description of this property. | [optional] +**id** | [**models::UnitPropertyId**](UnitPropertyId.md) | The unique ID for this unit property. | +**name** | **String** | The user-displayed name of this property. | +**units** | [**Vec<models::UnitId>**](UnitId.md) | The units with are measuring this property. | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/crates/rocie-client/docs/UnitPropertyId.md b/crates/rocie-client/docs/UnitPropertyId.md new file mode 100644 index 0000000..34d572f --- /dev/null +++ b/crates/rocie-client/docs/UnitPropertyId.md @@ -0,0 +1,11 @@ +# UnitPropertyId + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | [**uuid::Uuid**](uuid::Uuid.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/crates/rocie-client/docs/UnitPropertyStub.md b/crates/rocie-client/docs/UnitPropertyStub.md new file mode 100644 index 0000000..8f6bcbe --- /dev/null +++ b/crates/rocie-client/docs/UnitPropertyStub.md @@ -0,0 +1,12 @@ +# UnitPropertyStub + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | Option<**String**> | | [optional] +**name** | **String** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/crates/rocie-client/docs/UnitStub.md b/crates/rocie-client/docs/UnitStub.md index 62ab220..92398c5 100644 --- a/crates/rocie-client/docs/UnitStub.md +++ b/crates/rocie-client/docs/UnitStub.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **full_name_plural** | **String** | | **full_name_singular** | **String** | | **short_name** | **String** | | +**unit_property** | [**models::UnitPropertyId**](UnitPropertyId.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
