README

Semaphore API provides endpoints for managing and interacting with the Semaphore UI. This documentation outlines the available operations and data models.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/client-api/semaphore-php.git"
    }
  ],
  "require": {
    "client-api/semaphore-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

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

Getting Started

Please follow the installation procedure and then run the following:

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




$apiInstance = new ClientAPI\Semaphore\Api\AuthenticationApi(
    // 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()
);

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

API Endpoints

All URIs are relative to http://localhost:3000/api

Models

• APIToken
• AccessKey
• AccessKeyRequest
• AccessKeyRequestLoginPassword
• AccessKeyRequestSsh
• Environment
• EnvironmentRequest
• EnvironmentSecret
• EnvironmentSecretRequest
• Event
• InfoType
• InfoTypeUpdate
• Integration
• IntegrationExtractValue
• IntegrationExtractValueRequest
• IntegrationMatcher
• IntegrationMatcherRequest
• IntegrationRequest
• Inventory
• InventoryRequest
• Login
• LoginMetadata
• LoginMetadataOidcProvidersInner
• Project
• ProjectBackup
• ProjectBackupEnvironmentsInner
• ProjectBackupInventoriesInner
• ProjectBackupKeysInner
• ProjectBackupMeta
• ProjectBackupRepositoriesInner
• ProjectBackupTemplatesInner
• ProjectBackupViewsInner
• ProjectProjectIdPutRequest
• ProjectProjectIdRoleGet200Response
• ProjectProjectIdTasksPostRequest
• ProjectProjectIdUsersPostRequest
• ProjectProjectIdUsersUserIdPutRequest
• ProjectRequest
• ProjectUser
• Repository
• RepositoryRequest
• Runner
• Schedule
• ScheduleRequest
• Task
• TaskOutput
• Template
• TemplateRequest
• TemplateSurveyVar
• TemplateSurveyVarValue
• TemplateVault
• User
• UserPutRequest
• UserRequest
• UsersUserIdPasswordPostRequest
• View
• ViewRequest

Authorization

cookie

• Type: API key
• API key parameter name: Cookie
• Location: HTTP header

bearer

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

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: 2.13.0
  • Generator version: 7.12.0
• Build package: org.openapitools.codegen.languages.PhpNextgenClientCodegen