qase-api-v2-client 2.0.5

Qase TestOps API V2 client for Python

qase

Qase TestOps API v2 Specification.

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

• API version: 2.0.0
• Generator version: 7.15.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://qase.io

Requirements

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install qase-api-v2-client

(you may need to run pip with root permission: sudo pip install qase-api-v2-client)

Then import the package:

import qase.api_client_v2

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import qase.api_client_v2

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

from qase.api_client_v2.rest import ApiException
from pprint import pprint
import certifi

# Defining the host is optional and defaults to https://api.qase.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = qase.api_client_v2.Configuration(
    host="https://api.qase.io/v2"
)

configuration.ssl_ca_cert = certifi.where()

# 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.api_key['TokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TokenAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with qase.api_client_v2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qase.api_client_v2.ResultsApi(api_client)
    project_code = 'project_code_example'  # str | 
    run_id = 56  # int | 
    result_create = qase.api_client_v2.ResultCreate()  # ResultCreate | 

    try:
        # (Beta) Create test run result
        api_instance.create_result_v2(project_code, run_id, result_create)
    except ApiException as e:
        print("Exception when calling ResultsApi->create_result_v2: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
ResultsApi	create_result_v2	POST /{project_code}/run/{run_id}/result	(Beta) Create test run result
ResultsApi	create_results_v2	POST /{project_code}/run/{run_id}/results	(Beta) Bulk create test run result
CustomFieldsApi	get_custom_field_v2	GET /custom-fields/{id}	Get custom field
CustomFieldsApi	get_custom_fields_v2	GET /custom-fields	Get custom fields

Documentation For Models

• CreateResultsRequestV2
• CustomField
• CustomFieldListResponse
• CustomFieldListResponseAllOfResult
• CustomFieldOption
• CustomFieldResponse
• RelationSuite
• RelationSuiteItem
• ResultCreate
• ResultCreateFields
• ResultExecution
• ResultRelations
• ResultStep
• ResultStepData
• ResultStepExecution
• ResultStepStatus
• ResultStepsType

Documentation For Authorization

Authentication schemes defined for the API:

TokenAuth

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

Author

[e-mail]