Merge pull request #25 from databox/improvement/cleanup-templates

Update readme and examples

Author: marcelkoren

.github/workflows/generate_sdk_code.yml

@@ -77,9 +77,7 @@ jobs:
       - name: Generate SDK
         run: |
           java --version
-          java -jar ${{ runner.temp }}/openapi-generator-cli.jar generate -i ${{ runner.temp }}/openapispec/openapi.yml -g java -o ./src -c ${{ runner.temp }}/${{ env.CONFIG_FILE }} --skip-validate-spec -t ./codegen-template
-          cp ./src/README.md ./README.md
-          cp -r ./src/docs ./docs
+          java -jar ${{ runner.temp }}/openapi-generator-cli.jar generate -i ${{ runner.temp }}/openapispec/openapi.yml -g java -o ./src -c ${{ runner.temp }}/${{ env.CONFIG_FILE }} --skip-validate-spec
 
       - name: Create Pull Request
         id: cpr

README.md

@@ -1,38 +1,9 @@
-# databox
+# Databox
+This package is designed to consume the Databox Push API functionality via a Java client.
 
-Static OpenAPI document of Push API resource
-- API version: 0.4.1
-  - Build date: 2024-07-11T08:40:29.068083Z[Etc/UTC]
-  - Generator version: 7.6.0
-
-Push API resources Open API documentation
-
-
-*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*
-
-
-## Requirements
-
-Building the API client library requires:
-1. Java 1.8+
-2. Maven (3.8.3+)/Gradle (7.2+)
 
 ## Installation
 
-To install the API client library to your local Maven repository, simply execute:
-
-```shell
-mvn clean install
-```
-
-To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
-
-```shell
-mvn clean deploy
-```
-
-Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.
-
 ### Maven users
 
 Add this dependency to your project's POM:
@@ -61,96 +32,42 @@ Add this dependency to your project's build file:
   }
 ```
 
-### Others
-
-At first generate the JAR by executing:
-
-```shell
-mvn clean package
-```
-
-Then manually install the following JARs:
-
-* `target/databox-2.5.1.jar`
-* `target/lib/*.jar`
-
-## Getting Started
+## Prerequisites
+In use the Databox Push API functionality, please refer to [Databox Developers Page](https://developers.databox.com/), specifically the **Quick Guide** section, where you will learn how to create a **Databox Push API token** which is required for pushing your data.
 
-Please follow the [installation](#installation) instruction and execute the following Java code:
+## Example
 
 ```java
-
-// Import classes:
 import org.databox.ApiClient;
 import org.databox.ApiException;
 import org.databox.Configuration;
-import org.databox.auth.*;
-import org.databox.models.*;
 import org.databox.api.DefaultApi;
+import org.databox.auth.HttpBasicAuth;
+import org.openapitools.client.model.PushData;
+import org.openapitools.client.model.PushDataAttribute;
 
 public class Example {
   public static void main(String[] args) {
     ApiClient defaultClient = Configuration.getDefaultApiClient();
     defaultClient.setBasePath("https://push.databox.com");
-    
-    // Configure HTTP basic authorization: basicAuth
+    defaultClient.addDefaultHeader("Accept", "application/vnd.databox.v2+json");
+
     HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
-    basicAuth.setUsername("YOUR USERNAME");
-    basicAuth.setPassword("YOUR PASSWORD");
+    basicAuth.setUsername("Your_Databox_API_Token");
+
+    PushData data = new PushData()
+            .key("Metric_name") // e.g. sales
+            .value(123f)
+            .date("Date_in_ISO8601") // e.g. "2024-08-01T00:00:00Z"
+            .unit("Unit") // optional - e.g. USD
+            .attributes(List.of(new PushDataAttribute().key("Dimension_name").value("Dimension_value"))); // optional - e.g. currency & USD
 
     DefaultApi apiInstance = new DefaultApi(defaultClient);
     try {
-      apiInstance.dataDelete();
+      apiInstance.dataPost(List.of(data));
     } catch (ApiException e) {
-      System.err.println("Exception when calling DefaultApi#dataDelete");
-      System.err.println("Status code: " + e.getCode());
-      System.err.println("Reason: " + e.getResponseBody());
-      System.err.println("Response headers: " + e.getResponseHeaders());
       e.printStackTrace();
     }
   }
 }
-
-```
-
-## Documentation for API Endpoints
-
-All URIs are relative to *https://push.databox.com*
-
-Class | Method | HTTP request | Description
------------- | ------------- | ------------- | -------------
-*DefaultApi* | [**dataDelete**](docs/DefaultApi.md#dataDelete) | **DELETE** /data | 
-*DefaultApi* | [**dataMetricKeyDelete**](docs/DefaultApi.md#dataMetricKeyDelete) | **DELETE** /data/{metricKey} | 
-*DefaultApi* | [**dataPost**](docs/DefaultApi.md#dataPost) | **POST** /data | 
-*DefaultApi* | [**metrickeysGet**](docs/DefaultApi.md#metrickeysGet) | **GET** /metrickeys | 
-*DefaultApi* | [**metrickeysPost**](docs/DefaultApi.md#metrickeysPost) | **POST** /metrickeys | 
-*DefaultApi* | [**pingGet**](docs/DefaultApi.md#pingGet) | **GET** /ping | 
-
-
-## Documentation for Models
-
- - [ModelApiResponse](docs/ModelApiResponse.md)
- - [PushData](docs/PushData.md)
- - [PushDataAttribute](docs/PushDataAttribute.md)
- - [State](docs/State.md)
-
-
-<a id="documentation-for-authorization"></a>
-## Documentation for Authorization
-
-
-Authentication schemes defined for the API:
-<a id="basicAuth"></a>
-### basicAuth
-
-- **Type**: HTTP basic authentication
-
-
-## Recommendation
-
-It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.
-
-## Author
-
-
-
+```