testra-api-client

v0.2.0

Published

4 years ago

API client for Testra

0High
0Medium
0Low

testra

testra-api-js-client

JavaScript client for Testra API

Includes API documentation for Testra API

This SDK is automatically generated by the Swagger Codegen project:

API version: 1.0-SNAPSHOT
Package version: 1.0-SNAPSHOT
Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

yarn

install it via:

yarn add testra-api-js-client --save

npm

install it via:

npm install testra-api-js-client --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var TestraApi = require('testra_api');

var api = new TestraApi.CounterApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCounters(callback);

Documentation for API Endpoints

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- TestraApi.CounterApi | getCounters | GET /counters | Counters TestraApi.ExecutionApi | createExecution | POST /projects/{projectId}/executions | Create a New Execution TestraApi.ExecutionApi | deleteExecution | DELETE /projects/{projectId}/executions/{id} | Deletes execution info TestraApi.ExecutionApi | getExecution | GET /projects/{projectId}/executions/{id} | Get execution by id TestraApi.ExecutionApi | getExecutionResultStats | GET /projects/{projectId}/executions/{id}/result-stats | Get test execution's result stats TestraApi.ExecutionApi | getExecutions | GET /projects/{projectId}/executions | List all executions TestraApi.ExecutionApi | recentExecutions | GET /executions/recents | Recent executions TestraApi.ExecutionApi | updateExecution | PUT /projects/{projectId}/executions/{id} | Update execution info TestraApi.ProjectApi | createProject | POST /projects | Create a New Project TestraApi.ProjectApi | deleteProject | DELETE /projects/{id} | Deletes project info TestraApi.ProjectApi | getProject | GET /projects/{id} | Get project by id or name TestraApi.ProjectApi | getProjectCounters | GET /projects/{id}/counters | Get couters for project children TestraApi.ProjectApi | getProjects | GET /projects | List All Projects TestraApi.ProjectApi | topProjects | GET /projects/top | Top Projects TestraApi.ProjectApi | updateProject | PUT /projects/{id} | Update project info TestraApi.ResultApi | createResult | POST /projects/{projectId}/executions/{executionId}/results | Create a New Result TestraApi.ResultApi | deleteResult | DELETE /projects/{projectId}/executions/{executionId}/results/{id} | Deletes result info TestraApi.ResultApi | getResult | GET /projects/{projectId}/executions/{executionId}/results/{id} | Get result by id TestraApi.ResultApi | getResults | GET /projects/{projectId}/executions/{executionId}/results | List of all results TestraApi.ResultApi | updateResult | PUT /projects/{projectId}/executions/{executionId}/results/{id} | Update result info TestraApi.ScenarioApi | createScenario | POST /projects/{projectId}/scenarios | Create a New Scenario TestraApi.ScenarioApi | deleteScenario | DELETE /projects/{projectId}/scenarios/{id} | Deletes scenario info TestraApi.ScenarioApi | getScenario | GET /projects/{projectId}/scenarios/{id} | Get scenario by id TestraApi.ScenarioApi | getScenarios | GET /projects/{projectId}/scenarios | List all scenarios TestraApi.ScenarioApi | updateScenario | PUT /projects/{projectId}/scenarios/{id} | Update scenario info TestraApi.SimulationApi | createSimulation | POST /projects/{projectId}/executions/{executionId}/simulations | Create a New Simulation TestraApi.SimulationApi | deleteSimulation | DELETE /projects/{projectId}/executions/{executionId}/simulation/{id} | Deletes simulation info TestraApi.SimulationApi | getSimulations | GET /projects/{projectId}/executions/{executionId}/simulations | List of all simulations TestraApi.TestGroupApi | getTestGroups | GET /projects/{projectId}/test-groups | List all test groups TestraApi.TestGroupApi | getTestGroupsInExecution | GET /projects/{projectId}/executions/{executionId}/groups | List all test groups under execution TestraApi.TestcaseApi | createTestcase | POST /projects/{projectId}/testcases | Create a New Testcase TestraApi.TestcaseApi | deleteTestcase | DELETE /projects/{projectId}/testcases/{id} | Deletes testcase info TestraApi.TestcaseApi | getTestcase | GET /projects/{projectId}/testcases/{id} | Get testcase by id TestraApi.TestcaseApi | getTestcases | GET /projects/{projectId}/testcases | List all testcases TestraApi.TestcaseApi | updateTestcase | PUT /projects/{projectId}/testcases/{id} | Update testcase info

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme