DEPRECATED

This repository is no longer maintained and has been archived. Feel free to browse the code, but please migrate to other solutions.

tweek-authoring-php-client

API used to query and manipulate Tweek data in git

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 0.2.2
• Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com//.git"
    }
  ],
  "require": {
    "/": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/tweek-authoring-php-client/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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

$api_instance = new Swagger\Client\Api\AppsApi();
$author_name = "author_name_example"; // string | 
$author_email = "author_email_example"; // string | 
$new_app_model = new \Swagger\Client\Model\AppCreationRequestModel(); // \Swagger\Client\Model\AppCreationRequestModel | 

try {
    $result = $api_instance->createApp($author_name, $author_email, $new_app_model);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AppsApi->createApp: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://tweek-authoring/api/

Class	Method	HTTP request	Description
AppsApi	createApp	POST /apps
BulkKeysUploadApi	bulkKeysUpload	PUT /bulk-keys-upload
KeysApi	deleteKey	DELETE /key
KeysApi	listKeys	GET /keys
KeysApi	listManifests	GET /manifests
KeysApi	getDependents	GET /dependent
KeysApi	getKey	GET /key
KeysApi	getKeyRevisionHistory	GET /revision-history
KeysApi	getManifest	GET /manifest
KeysApi	getRevision	GET /revision
KeysApi	updateKey	PUT /key
SchemaApi	addIdentity	POST /schemas/{identityType}
SchemaApi	deleteIdentity	DELETE /schemas/{identityType}
SchemaApi	listSchemas	GET /schemas
SchemaApi	patchIdentity	PATCH /schemas/{identityType}
SearchApi	getSearchIndex	GET /search-index
SearchApi	search	GET /search
SearchApi	getSuggestions	GET /suggestions
TagsApi	listTags	GET /tags
TagsApi	saveTags	PUT /tags

Documentation For Models

• AppCreationRequestModel
• AppCreationResponseModel
• JsonValue
• KeyUpdateModel

Documentation For Authorization

All endpoints do not require authorization.

Author