Skip to content
/ tricentis_tm_api-ruby Public

Tricentis Test Management for Jira API client in Ruby

0 stars 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

duhast/tricentis_tm_api-ruby

BranchesTags

Repository files navigation

tricentis_tm_api

TricentisTmApi - the Ruby gem for the TTM for Jira

Tricentis Test Management for Jira

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build tricentis_tm_api.gemspec

Then either install the gem locally:

gem install ./tricentis_tm_api-1.0.0.gem

(for development, run gem install --dev ./tricentis_tm_api-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'tricentis_tm_api', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'tricentis_tm_api', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'tricentis_tm_api'

# Setup authorization
TricentisTmApi.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['api_key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['api_key'] = 'Bearer'
  # Configure faraday connection
  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
end

api_instance = TricentisTmApi::AttachmentsApi.new
attachment_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The attachment Id.
project_key = 'project_key_example' # String | 

begin
  #Get attachment link.
  api_instance.v1_projects_project_key_test_runs_attachments_attachment_id_get(attachment_id, project_key)
rescue TricentisTmApi::ApiError => e
  puts "Exception when calling AttachmentsApi->v1_projects_project_key_test_runs_attachments_attachment_id_get: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.ttm4j.tricentis.com

Class Method HTTP request Description
TricentisTmApi::AttachmentsApi v1_projects_project_key_test_runs_attachments_attachment_id_get GET /v1/projects/{project-key}/test-runs/attachments/{attachmentId} Get attachment link.
TricentisTmApi::AttachmentsApi v1_projects_project_key_test_runs_attachments_id_put PUT /v1/projects/{project-key}/test-runs/attachments/{id} Query if attachment is uploaded to storage.
TricentisTmApi::AttachmentsApi v1_projects_project_key_test_runs_test_run_key_attachments_get GET /v1/projects/{project-key}/test-runs/{test-run-key}/attachments Get attachment of a test run.
TricentisTmApi::AttachmentsApi v1_projects_project_key_test_runs_test_run_key_attachments_post POST /v1/projects/{project-key}/test-runs/{test-run-key}/attachments Upload attachment to a test run.
TricentisTmApi::AttachmentsApi v1_projects_project_key_test_runs_test_run_key_steps_step_number_attachments_post POST /v1/projects/{project-key}/test-runs/{test-run-key}/steps/{step-number}/attachments Upload attachment to a test run step.
TricentisTmApi::CyclesApi v1_projects_project_key_cycles_cycle_id_put PUT /v1/projects/{project-key}/cycles/{cycleId} Update cycle.
TricentisTmApi::CyclesApi v1_projects_project_key_cycles_post POST /v1/projects/{project-key}/cycles Create cycle(s).
TricentisTmApi::CyclesApi v1_projects_project_key_cycles_search_get GET /v1/projects/{project-key}/cycles/search Get cycles.
TricentisTmApi::DefectsApi v1_projects_project_key_test_runs_test_run_key_defects_link_post POST /v1/projects/{project-key}/test-runs/{test-run-key}/defects/link Link Defects to test run.
TricentisTmApi::DefectsApi v1_projects_project_key_test_runs_test_run_key_defects_post POST /v1/projects/{project-key}/test-runs/{test-run-key}/defects Create defects and link to test run.
TricentisTmApi::FoldersApi v1_projects_project_key_folders_folder_id_put PUT /v1/projects/{project-key}/folders/{folderId} Update folder.
TricentisTmApi::FoldersApi v1_projects_project_key_folders_get GET /v1/projects/{project-key}/folders Get folder(s).
TricentisTmApi::FoldersApi v1_projects_project_key_folders_post POST /v1/projects/{project-key}/folders Create folder(s).
TricentisTmApi::ProjectsApi v1_projects_get GET /v1/projects Get Jira project(s).
TricentisTmApi::RequirementsApi v1_projects_project_key_test_cases_key_requirement_link_post POST /v1/projects/{project-key}/test-cases/{key}/requirement/link Link Requirements to test case.
TricentisTmApi::RequirementsApi v1_projects_project_key_test_cases_key_requirements_post POST /v1/projects/{project-key}/test-cases/{key}/requirements Create Requirements and link to test case.
TricentisTmApi::RequirementsApi v1_projects_project_key_test_cases_requirements_post POST /v1/projects/{project-key}/test-cases/requirements Create Requirements.
TricentisTmApi::StatusApi v1_api_key_is_alive_head HEAD /v1/api-key/is-alive Validate if api key is still valid.
TricentisTmApi::TestCasesApi v1_projects_project_key_jobs_job_id_get GET /v1/projects/{project-key}/jobs/{job-id} Query job status.
TricentisTmApi::TestCasesApi v1_projects_project_key_test_cases_get GET /v1/projects/{project-key}/test-cases Read test case(s).
TricentisTmApi::TestCasesApi v1_projects_project_key_test_cases_key_automation_put PUT /v1/projects/{project-key}/test-cases/{key}/automation Add or update automation content for a test case.
TricentisTmApi::TestCasesApi v1_projects_project_key_test_cases_key_delete DELETE /v1/projects/{project-key}/test-cases/{key} Delete test case(s).
TricentisTmApi::TestCasesApi v1_projects_project_key_test_cases_key_put PUT /v1/projects/{project-key}/test-cases/{key} Update test case(s).
TricentisTmApi::TestCasesApi v1_projects_project_key_test_cases_post POST /v1/projects/{project-key}/test-cases Create test case(s).
TricentisTmApi::TestCasesApi v1_test_cases_search_post POST /v1/test-cases/search Search test case(s).
TricentisTmApi::TestRunsApi v1_projects_project_key_import_execution_junit_post POST /v1/projects/{project-key}/import/execution/junit Create test runs from junit xml string.
TricentisTmApi::TestRunsApi v1_projects_project_key_test_runs_post POST /v1/projects/{project-key}/test-runs Create test run(s).
TricentisTmApi::TestRunsApi v1_projects_project_key_test_runs_search_post POST /v1/projects/{project-key}/test-runs/search Read test run(s).
TricentisTmApi::TestRunsApi v1_projects_project_key_test_runs_test_run_key_delete DELETE /v1/projects/{project-key}/test-runs/{test-run-key} Delete test run(s).
TricentisTmApi::TestRunsApi v1_projects_project_key_test_runs_test_run_key_put PUT /v1/projects/{project-key}/test-runs/{test-run-key} Update test run(s).
TricentisTmApi::TestRunsFieldsApi v1_test_runs_scheme_scheme_name_allowed_values_allowed_value_name_delete DELETE /v1/test-runs/scheme/{schemeName}/allowed-values/{allowedValueName} Delete allowed value from scheme.
TricentisTmApi::TestRunsFieldsApi v1_test_runs_scheme_scheme_name_allowed_values_post POST /v1/test-runs/scheme/{schemeName}/allowed-values Add allowed value to scheme.

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

api_key

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

About

Tricentis Test Management for Jira API client in Ruby

Topics

ruby api swagger openapi tricentis

Resources

Readme
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Languages