From ca9442279f1ddd8958d681e1204b0234e6256b91 Mon Sep 17 00:00:00 2001 From: Slavko Rihtaric Date: Mon, 26 Aug 2024 14:44:56 +0200 Subject: [PATCH] Remove symlink --- README.md | 121 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 120 insertions(+), 1 deletion(-) mode change 120000 => 100644 README.md diff --git a/README.md b/README.md deleted file mode 120000 index 07eda6c..0000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -./src/README.md \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..7c4627f --- /dev/null +++ b/README.md @@ -0,0 +1,120 @@ +# Databox + +Push API resources Open API documentation + + +## Installation & Usage + +### Requirements + +PHP 7.4 and later. +Should also work with PHP 8.0. + +### Composer + +To install the bindings via [Composer](https://getcomposer.org/), add the following to `composer.json`: + +```json +{ + "repositories": [ + { + "type": "vcs", + "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" + } + ], + "require": { + "GIT_USER_ID/GIT_REPO_ID": "*@dev" + } +} +``` + +Then run `composer install` + +### Manual Installation + +Download the files and include `autoload.php`: + +```php +setUsername('YOUR_USERNAME') + ->setPassword('YOUR_PASSWORD'); + + +$apiInstance = new Databox\Api\DefaultApi( + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. + // This is optional, `GuzzleHttp\Client` will be used as default. + new GuzzleHttp\Client(), + $config +); + +try { + $apiInstance->dataDelete(); +} catch (Exception $e) { + echo 'Exception when calling DefaultApi->dataDelete: ', $e->getMessage(), PHP_EOL; +} + +``` + +## API Endpoints + +All URIs are relative to *https://push.databox.com* + +Class | Method | HTTP request | Description +------------ | ------------- | ------------- | ------------- +*DefaultApi* | [**dataDelete**](docs/Api/DefaultApi.md#datadelete) | **DELETE** /data | +*DefaultApi* | [**dataMetricKeyDelete**](docs/Api/DefaultApi.md#datametrickeydelete) | **DELETE** /data/{metricKey} | +*DefaultApi* | [**dataPost**](docs/Api/DefaultApi.md#datapost) | **POST** /data | +*DefaultApi* | [**metrickeysGet**](docs/Api/DefaultApi.md#metrickeysget) | **GET** /metrickeys | +*DefaultApi* | [**metrickeysPost**](docs/Api/DefaultApi.md#metrickeyspost) | **POST** /metrickeys | +*DefaultApi* | [**pingGet**](docs/Api/DefaultApi.md#pingget) | **GET** /ping | + +## Models + +- [ApiResponse](docs/Model/ApiResponse.md) +- [PushData](docs/Model/PushData.md) +- [PushDataAttribute](docs/Model/PushDataAttribute.md) +- [State](docs/Model/State.md) + +## Authorization + +Authentication schemes defined for the API: +### basicAuth + +- **Type**: HTTP basic authentication + +## Tests + +To run the tests, use: + +```bash +composer install +vendor/bin/phpunit +``` + +## Author + + + +## About this package + +This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: + +- API version: `0.4.1` + - Package version: `2.1.3` + - Generator version: `7.6.0` +- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`