about summary refs log tree commit diff stats
path: root/crates/rocie-client/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'crates/rocie-client/README.md')
-rw-r--r--crates/rocie-client/README.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/crates/rocie-client/README.md b/crates/rocie-client/README.md
new file mode 100644
index 0000000..7649325
--- /dev/null
+++ b/crates/rocie-client/README.md
@@ -0,0 +1,52 @@
+# Rust API client for openapi
+
+An enterprise grocery management system
+
+
+## Overview
+
+This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.
+
+- API version: 0.1.0
+- Package version: 0.1.0
+- Generator version: 7.14.0
+- Build package: `org.openapitools.codegen.languages.RustClientCodegen`
+
+## Installation
+
+Put the package under your project folder in a directory named `openapi` and add the following to `Cargo.toml` under `[dependencies]`:
+
+```
+openapi = { path = "./openapi" }
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://localhost*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*ApiGetApi* | [**product_by_id**](docs/ApiGetApi.md#product_by_id) | **GET** /product/{id} | Get Product by id
+*ApiGetApi* | [**products**](docs/ApiGetApi.md#products) | **GET** /products/ | Return all registered products
+*ApiSetApi* | [**associate_barcode**](docs/ApiSetApi.md#associate_barcode) | **POST** /product/{id}/associate | Associate a barcode with a product
+*ApiSetApi* | [**register_product**](docs/ApiSetApi.md#register_product) | **POST** /product/new | Register a product
+
+
+## Documentation For Models
+
+ - [Barcode](docs/Barcode.md)
+ - [Product](docs/Product.md)
+ - [ProductStub](docs/ProductStub.md)
+ - [UnitAmount](docs/UnitAmount.md)
+
+
+To get access to the crate's generated documentation, use:
+
+```
+cargo doc --open
+```
+
+## Author
+
+benedikt.peetz@b-peetz.de
+