The API usable by the Lenra applications
For more information, please visit https://www.lenra.io/contact.html.
PHP 7.4 and later. Should also work with PHP 8.0.
To install the bindings via Composer, add the following to composer.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
Download the files and include autoload.php
:
<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');
Please follow the installation procedure and then run the following:
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new OpenAPI\Client\Api\DataApi(
// 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->abortTransaction();
} catch (Exception $e) {
echo 'Exception when calling DataApi->abortTransaction: ', $e->getMessage(), PHP_EOL;
}
All URIs are relative to http://localhost:4001
Class | Method | HTTP request | Description |
---|---|---|---|
DataApi | abortTransaction | POST /app-api/v1/data/transaction/abort | Aborts a transaction |
DataApi | commitTransaction | POST /app-api/v1/data/transaction/commit | Commits a transaction |
DataApi | createDocument | POST /app-api/v1/data/colls/{coll}/docs | Creates a document in database |
DataApi | createTransaction | POST /app-api/v1/data/transaction | Creates a transaction |
DataApi | deleteCollection | DELETE /app-api/v1-api/v1/data/colls/{coll} | Deletes a collection from database |
DataApi | deleteDocumentById | DELETE /app-api/v1/data/colls/{coll}/docs/{id} | Deletes a document from database |
DataApi | findDocuments | POST /app-api/v1/data/colls/{coll}/find | Finds documents in database |
DataApi | getDocumentById | GET /app-api/v1/data/colls/{coll}/docs/{id} | Gets a document from database |
DataApi | getDocuments | GET /app-api/v1/data/colls/{coll}/docs | Gets documents from database |
DataApi | updateDocumentById | PUT /app-api/v1/data/colls/{coll}/docs/{id} | Updates a document in database |
DataApi | updateManyDocuments | POST /app-api/v1/data/colls/{coll}/updateMany | Updates many documents in database |
Authentication schemes defined for the API:
- Type: Bearer authentication
To run the tests, use:
composer install
vendor/bin/phpunit
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
0.0.0
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen