OpenAPIClient-php

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

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

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');




$apiInstance = new OpenAPI\Client\Api\EnvironmentVariablesApi(
    // 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()
);
$name = 'name_example'; // string

try {
    $result = $apiInstance->getEnvironmentVariable($name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EnvironmentVariablesApi->getEnvironmentVariable: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to http://localhost:59999

Class	Method	HTTP request	Description
EnvironmentVariablesApi	getEnvironmentVariable	GET /environment-variables/{name}
EnvironmentVariablesApi	getEnvironmentVariableKeys	GET /environment-variables
LogsApi	writeLog	POST /logs
QueueApi	publishMessage	POST /queue
QueueApi	validateSecret	POST /queue/validate-secret
SecretsApi	getSecret	GET /secrets/{name}
SecretsApi	getSecretKeys	GET /secrets
SecureStorageApi	deleteSecureStorage	DELETE /secure-storage/{key}
SecureStorageApi	getSecureStorage	GET /secure-storage/{key}
SecureStorageApi	putSecureStorage	PUT /secure-storage/{key}
StorageApi	deleteByKeyFromStorage	DELETE /storage/{key}
StorageApi	getByKeyFromStorage	GET /storage/{key}
StorageApi	incrementCounter	PUT /storage/counter/increment
StorageApi	upsertByKeyFromStorage	PUT /storage/{key}

Models

• GetByKeyFromStorage404Response
• GetByKeyFromStorage500Response
• IncrementCounterParams
• JsonValue
• LogMethods
• Period
• PublishMessageParams
• PublishMessageResponse
• SecureStorageDataContract
• StorageDataContract
• ValidateSecretParams
• ValidateSecretResponse
• WriteLogRequestBody
• WriteLogRequestBodyError

Authorization

Endpoints do not require authorization.

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 0.0.1
  • Generator version: 7.7.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PhpClientCodegen