zephyr-api-wrapper
TypeScript icon, indicating that this package has built-in type declarations

0.3.0 • Public • Published

Zephyr-api Library

npm version Known Vulnerabilities

Overview

  • zephyr-api is a wrapper around Zephyr Scale Cloud REST API to automated tasks, test-cycles creations, etc. in JIRA.

Requirements

  • Requires Node.js 14+
  • Set env with zephyr toke ZEPHYR_TOKEN=XXXXXXXXX

Documentation

API specification can be found in -> zephyr-spec

Endpoints implemented

  • Automations
  • TestCases
  • Folders
  • Statuses
  • ⚠️ TestCycles - partially done
  • ⚠️ TestExecution - partially done

Example (using Typescript)

NOTE: Remember to set the environment variable ZEPHYR_TOKEN

To use a subset of calls for a specific endpoint:

import { TestCycle } from 'zephyr-api-wrapper';

const api = new TestCycle();

api.getTestCycles().then((result) => {
  console.log(result);
});

To use all the possible calls for:

import { FullZephyrAPI } from 'zephyr-api-wrapper';

const api = new FullZephyrAPI();

api.testCycles.getTestCycles().then((result) => {
  console.log(result);
});

Future Plans

  • [ ] Implement all the endpoints
  • [ ] Add interfaces for responses/requests
  • [ ] Implement tests to check basic functionality
  • [ ] Create CI with github actions

Package Sidebar

Install

npm i zephyr-api-wrapper

Weekly Downloads

4

Version

0.3.0

License

MIT

Unpacked Size

26 kB

Total Files

21

Last publish

Collaborators

  • juangm