adesso-mobile/php-jira-client

This is the jira rest resources endpoint documentation

0.1.1 2019-12-10 11:49 UTC

Requires

• php: >=7.1
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^6.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ~2.12
• phpunit/phpunit: ^7.4
• squizlabs/php_codesniffer: ~2.6

unlicense

• OpenAPI-Generator contributors

• php
• rest
• api
• sdk
• openapi
• openapitools
• openapi-generator

README

This is the jira rest resources endpoint documentation

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

• API version: 8.3.2
• Build package: org.openapitools.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

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

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

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/php-jira-client/vendor/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');



// Configure HTTP basic authorization: crowdAuth
$config = JiraClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new JiraClient\Api\JiraApi(
    // 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
);
$issue_id_or_key = 'issue_id_or_key_example'; // string | 
$file = "/path/to/file.txt"; // \SplFileObject | The attachment to upload
$x_atlassian_token = 'no-check'; // string | 

try {
    $apiInstance->addAttachment($issue_id_or_key, $file, $x_atlassian_token);
} catch (Exception $e) {
    echo 'Exception when calling JiraApi->addAttachment: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
JiraApi	addAttachment	POST /issue/{issueIdOrKey}/attachments	Add one or more attachments to an issue
JiraApi	createIssue	POST /issue	Creates an issue or a sub-task from a JSON representation
JiraApi	findUsers	GET /user/search	Returns a list of users that match the search string. This resource cannot be accessed anonymously.

Documentation For Models

• JiraCreatedIssue
• JiraIssueCreationProperties
• JiraIssueFields
• JiraIssueFieldsAssignee
• JiraIssueFieldsIssuetype
• JiraIssueFieldsPriority
• JiraIssueFieldsProject
• JiraIssueFieldsReporter
• JiraUser

Documentation For Authorization

crowdAuth

• Type: HTTP basic authentication

Author