about summary refs log tree commit diff stats
path: root/crates/rocie-client/README.md
diff options
context:
space:
mode:
authorBenedikt Peetz <benedikt.peetz@b-peetz.de>2025-12-09 13:01:20 +0100
committerBenedikt Peetz <benedikt.peetz@b-peetz.de>2025-12-09 13:01:20 +0100
commit24a1c946b7017237627d69d293c05237d9b96ca5 (patch)
treefc9669287a86df5bc863507743ca9961519bef86 /crates/rocie-client/README.md
parentchore(crates/rocie-client): Re-generate (diff)
downloadserver-24a1c946b7017237627d69d293c05237d9b96ca5.zip
chore(rocie-client): Regenerate
This also adds cookie persisting to the default configuration.
Diffstat (limited to 'crates/rocie-client/README.md')
-rw-r--r--crates/rocie-client/README.md63
1 files changed, 37 insertions, 26 deletions
diff --git a/crates/rocie-client/README.md b/crates/rocie-client/README.md
index e25385a..ebcdd73 100644
--- a/crates/rocie-client/README.md
+++ b/crates/rocie-client/README.md
@@ -26,38 +26,46 @@ All URIs are relative to *http://localhost*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*ApiGetInventoryApi* | [**amount_by_id**](docs/ApiGetInventoryApi.md#amount_by_id) | **GET** /inventory/{id} | Get the amount of an product
-*ApiGetProductApi* | [**product_by_id**](docs/ApiGetProductApi.md#product_by_id) | **GET** /product/by-id/{id} | Get Product by id
-*ApiGetProductApi* | [**product_by_name**](docs/ApiGetProductApi.md#product_by_name) | **GET** /product/by-name/{name} | Get Product by name
-*ApiGetProductApi* | [**product_suggestion_by_name**](docs/ApiGetProductApi.md#product_suggestion_by_name) | **GET** /product/by-part-name/{name} | Get Product suggestion by name
-*ApiGetProductApi* | [**products_by_product_parent_id_direct**](docs/ApiGetProductApi.md#products_by_product_parent_id_direct) | **GET** /product/by-product-parent-id-direct/{id} | Get Products by it's product parent id
-*ApiGetProductApi* | [**products_by_product_parent_id_indirect**](docs/ApiGetProductApi.md#products_by_product_parent_id_indirect) | **GET** /product/by-product-parent-id-indirect/{id} | Get Products by it's product parent id
-*ApiGetProductApi* | [**products_in_storage**](docs/ApiGetProductApi.md#products_in_storage) | **GET** /products_in_storage/ | Return all products, which non-null amount in storage
-*ApiGetProductApi* | [**products_registered**](docs/ApiGetProductApi.md#products_registered) | **GET** /products_registered/ | Return all registered products
-*ApiGetProductParentApi* | [**product_parents**](docs/ApiGetProductParentApi.md#product_parents) | **GET** /product_parents/ | Return all registered product parents
-*ApiGetProductParentApi* | [**product_parents_toplevel**](docs/ApiGetProductParentApi.md#product_parents_toplevel) | **GET** /product_parents_toplevel/ | Return all registered product parents, that have no parents themselves
-*ApiGetProductParentApi* | [**product_parents_under**](docs/ApiGetProductParentApi.md#product_parents_under) | **GET** /product_parents_under/{id} | Return all parents, that have this parent as parent
-*ApiGetRecipeApi* | [**recipe_by_id**](docs/ApiGetRecipeApi.md#recipe_by_id) | **GET** /recipe/by-id/{id} | Get an recipe by it's id.
-*ApiGetRecipeApi* | [**recipes**](docs/ApiGetRecipeApi.md#recipes) | **GET** /recipe/all | Get all added recipes
-*ApiGetUnitApi* | [**unit_by_id**](docs/ApiGetUnitApi.md#unit_by_id) | **GET** /unit/{id} | Get Unit by id
-*ApiGetUnitApi* | [**units**](docs/ApiGetUnitApi.md#units) | **GET** /units/ | Return all registered units
-*ApiGetUnitApi* | [**units_by_property_id**](docs/ApiGetUnitApi.md#units_by_property_id) | **GET** /units-by-property/{id} | Return all registered units for a specific unit property
-*ApiGetUnitPropertyApi* | [**unit_properties**](docs/ApiGetUnitPropertyApi.md#unit_properties) | **GET** /unit-properties/ | Return all registered unit properties
-*ApiGetUnitPropertyApi* | [**unit_property_by_id**](docs/ApiGetUnitPropertyApi.md#unit_property_by_id) | **GET** /unit-property/{id} | Get Unit property by id
-*ApiSetBarcodeApi* | [**buy_barcode**](docs/ApiSetBarcodeApi.md#buy_barcode) | **POST** /barcode/{barcode_id}/buy/{times} | Buy an barcode
-*ApiSetBarcodeApi* | [**consume_barcode**](docs/ApiSetBarcodeApi.md#consume_barcode) | **POST** /barcode/{id}/consume | Consume an barcode
-*ApiSetProductApi* | [**associate_barcode**](docs/ApiSetProductApi.md#associate_barcode) | **POST** /product/{id}/associate | Associate a barcode with a product
-*ApiSetProductApi* | [**register_product**](docs/ApiSetProductApi.md#register_product) | **POST** /product/new | Register a product
-*ApiSetProductParentApi* | [**register_product_parent**](docs/ApiSetProductParentApi.md#register_product_parent) | **POST** /product_parent/new | Register a product parent
-*ApiSetRecipeApi* | [**add_recipe**](docs/ApiSetRecipeApi.md#add_recipe) | **POST** /recipe/new | Register a product parent
-*ApiSetUnitApi* | [**register_unit**](docs/ApiSetUnitApi.md#register_unit) | **POST** /unit/new | Register an Unit
-*ApiSetUnitPropertyApi* | [**register_unit_property**](docs/ApiSetUnitPropertyApi.md#register_unit_property) | **POST** /unit-property/new | Register an Unit Property
+*ApiGetAuthInventoryApi* | [**amount_by_id**](docs/ApiGetAuthInventoryApi.md#amount_by_id) | **GET** /inventory/{id} | Get the amount of an product
+*ApiGetAuthProductApi* | [**product_by_id**](docs/ApiGetAuthProductApi.md#product_by_id) | **GET** /product/by-id/{id} | Get Product by id
+*ApiGetAuthProductApi* | [**product_by_name**](docs/ApiGetAuthProductApi.md#product_by_name) | **GET** /product/by-name/{name} | Get Product by name
+*ApiGetAuthProductApi* | [**product_suggestion_by_name**](docs/ApiGetAuthProductApi.md#product_suggestion_by_name) | **GET** /product/by-part-name/{name} | Get Product suggestion by name
+*ApiGetAuthProductApi* | [**products_by_product_parent_id_direct**](docs/ApiGetAuthProductApi.md#products_by_product_parent_id_direct) | **GET** /product/by-product-parent-id-direct/{id} | Get Products by it's product parent id
+*ApiGetAuthProductApi* | [**products_by_product_parent_id_indirect**](docs/ApiGetAuthProductApi.md#products_by_product_parent_id_indirect) | **GET** /product/by-product-parent-id-indirect/{id} | Get Products by it's product parent id
+*ApiGetAuthProductApi* | [**products_in_storage**](docs/ApiGetAuthProductApi.md#products_in_storage) | **GET** /products_in_storage/ | Return all products, which non-null amount in storage
+*ApiGetAuthProductApi* | [**products_registered**](docs/ApiGetAuthProductApi.md#products_registered) | **GET** /products_registered/ | Return all registered products
+*ApiGetAuthProductParentApi* | [**product_parents**](docs/ApiGetAuthProductParentApi.md#product_parents) | **GET** /product_parents/ | Return all registered product parents
+*ApiGetAuthProductParentApi* | [**product_parents_toplevel**](docs/ApiGetAuthProductParentApi.md#product_parents_toplevel) | **GET** /product_parents_toplevel/ | Return all registered product parents, that have no parents themselves
+*ApiGetAuthProductParentApi* | [**product_parents_under**](docs/ApiGetAuthProductParentApi.md#product_parents_under) | **GET** /product_parents_under/{id} | Return all parents, that have this parent as parent
+*ApiGetAuthRecipeApi* | [**recipe_by_id**](docs/ApiGetAuthRecipeApi.md#recipe_by_id) | **GET** /recipe/by-id/{id} | Get an recipe by it's id.
+*ApiGetAuthRecipeApi* | [**recipes**](docs/ApiGetAuthRecipeApi.md#recipes) | **GET** /recipe/all | Get all added recipes
+*ApiGetAuthUnitApi* | [**unit_by_id**](docs/ApiGetAuthUnitApi.md#unit_by_id) | **GET** /unit/{id} | Get Unit by id
+*ApiGetAuthUnitApi* | [**units**](docs/ApiGetAuthUnitApi.md#units) | **GET** /units/ | Return all registered units
+*ApiGetAuthUnitApi* | [**units_by_property_id**](docs/ApiGetAuthUnitApi.md#units_by_property_id) | **GET** /units-by-property/{id} | Return all registered units for a specific unit property
+*ApiGetAuthUnitPropertyApi* | [**unit_properties**](docs/ApiGetAuthUnitPropertyApi.md#unit_properties) | **GET** /unit-properties/ | Return all registered unit properties
+*ApiGetAuthUnitPropertyApi* | [**unit_property_by_id**](docs/ApiGetAuthUnitPropertyApi.md#unit_property_by_id) | **GET** /unit-property/{id} | Get Unit property by id
+*ApiGetAuthUserApi* | [**user_by_id**](docs/ApiGetAuthUserApi.md#user_by_id) | **GET** /user/{id} | Get an specific user by id.
+*ApiGetAuthUserApi* | [**users**](docs/ApiGetAuthUserApi.md#users) | **GET** /users | Get all registered users.
+*ApiSetAuthBarcodeApi* | [**buy_barcode**](docs/ApiSetAuthBarcodeApi.md#buy_barcode) | **POST** /barcode/{barcode_id}/buy/{times} | Buy an barcode
+*ApiSetAuthBarcodeApi* | [**consume_barcode**](docs/ApiSetAuthBarcodeApi.md#consume_barcode) | **POST** /barcode/{id}/consume | Consume an barcode
+*ApiSetAuthProductApi* | [**associate_barcode**](docs/ApiSetAuthProductApi.md#associate_barcode) | **POST** /product/{id}/associate | Associate a barcode with a product
+*ApiSetAuthProductApi* | [**register_product**](docs/ApiSetAuthProductApi.md#register_product) | **POST** /product/new | Register a product
+*ApiSetAuthProductParentApi* | [**register_product_parent**](docs/ApiSetAuthProductParentApi.md#register_product_parent) | **POST** /product_parent/new | Register a product parent
+*ApiSetAuthRecipeApi* | [**add_recipe**](docs/ApiSetAuthRecipeApi.md#add_recipe) | **POST** /recipe/new | Register a product parent
+*ApiSetAuthUnitApi* | [**register_unit**](docs/ApiSetAuthUnitApi.md#register_unit) | **POST** /unit/new | Register an Unit
+*ApiSetAuthUnitPropertyApi* | [**register_unit_property**](docs/ApiSetAuthUnitPropertyApi.md#register_unit_property) | **POST** /unit-property/new | Register an Unit Property
+*ApiSetAuthUserApi* | [**register_user**](docs/ApiSetAuthUserApi.md#register_user) | **POST** /user/new | Register an new User
+*ApiSetNoAuthUserApi* | [**login**](docs/ApiSetNoAuthUserApi.md#login) | **POST** /login | Log in as a specific user
+*ApiSetNoAuthUserApi* | [**logout**](docs/ApiSetNoAuthUserApi.md#logout) | **POST** /logout | Log the current user out
+*ApiSetNoAuthUserApi* | [**provision**](docs/ApiSetNoAuthUserApi.md#provision) | **POST** /provision | Provision this instance.
 
 
 ## Documentation For Models
 
  - [Barcode](docs/Barcode.md)
  - [BarcodeId](docs/BarcodeId.md)
+ - [LoginInfo](docs/LoginInfo.md)
+ - [PasswordHash](docs/PasswordHash.md)
  - [Product](docs/Product.md)
  - [ProductAmount](docs/ProductAmount.md)
  - [ProductId](docs/ProductId.md)
@@ -75,6 +83,9 @@ Class | Method | HTTP request | Description
  - [UnitPropertyId](docs/UnitPropertyId.md)
  - [UnitPropertyStub](docs/UnitPropertyStub.md)
  - [UnitStub](docs/UnitStub.md)
+ - [User](docs/User.md)
+ - [UserId](docs/UserId.md)
+ - [UserStub](docs/UserStub.md)
 
 
 To get access to the crate's generated documentation, use: