npm.io
1.0.11 • Published 3 weeks ago

qase-api-v2-client

Licence
Apache-2.0
Version
1.0.11
Deps
2
Size
134 kB
Vulns
0
Weekly
0
Stars
56
SummaryDependencyVersions

qase

Qase TestOps API v2 Specification.

This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:

  • API version: 2.0.0
  • Package version: 1.0.0
  • Generator version: 7.4.0
  • Build package: org.openapitools.codegen.languages.TypeScriptAxiosClientCodegen

For more information, please visit https://qase.io

Requirements

  • Node.js >= 14.0.0
  • npm >= 6.0.0

Installation & Usage

npm install
npm install qase-api-v2-client
yarn install
yarn add qase-api-v2-client

Then import the package:

import { ResultsApi } from 'qase-api-v2-client';

Getting Started

Please follow the installation procedure and then run the following:

import { ResultsApi, Configuration } from 'qase-api-v2-client';

// Defining the host is optional and defaults to https://api.qase.io/v2
// See configuration.ts for a list of all supported configuration parameters.
const configuration = new Configuration({
    basePath: "https://api.qase.io/v2"
});

// The client must configure the authentication and authorization parameters
// in accordance with the API server security policy.
// Examples for each auth method are provided below, use the example that
// satisfies your auth use case.

// Configure API key authorization: TokenAuth
configuration.apiKey = process.env.API_KEY;

// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// configuration.apiKeyPrefix = 'Bearer';

// Create an instance of the API class
const qaseApi = new ResultsApi(configuration);

// Create test run result
try {
    const result = await qaseApi.results.createResultV2('MP', 1, {
        title: 'Test Result',
        execution: {
            status: 'passed',
            duration: 1000
        },
        testops_id: 1,
        steps: [
            {
                position: 1,
                status: 'passed',
                comment: 'Step completed successfully'
            }
        ]
    });
    console.log(result);
} catch (error) {
    console.error('Error creating result:', error);
}

Documentation for API Endpoints

All URIs are relative to https://api.qase.io/v2

Class Method HTTP request Description
CustomFieldsApi getCustomFieldV2 GET /custom_field/{id} Get Custom Field
CustomFieldsApi getCustomFieldsV2 GET /custom_field Get all Custom Fields
ResultsApi createResultV2 POST /{project_code}/run/{run_id}/result Create test run result
ResultsApi createResultsV2 POST /{project_code}/run/{run_id}/results Bulk create test run result

Documentation For Models

Documentation For Authorization

TokenAuth
  • Type: API key
  • API key parameter name: Token
  • Location: HTTP header

Author

support@qase.io