Versions Compared

Old Version 16

changes.mady.by.user Kamil Parzyjagła

Saved on

compared with

New Version 17

changes.mady.by.user Michał Tkacz

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
TestStep: {
  attachments: String, // TEST ATTACHMENTS, Array<Attachement> stored as String (JSON.stringify)
  data: String, // TEST DATA, stored as HTML
  id: Long,
  testCaseId: Long,
  position: int, // step position
  result: String, // EXPECTED RESULT, stored as HTML
  step: String, //TEST STEP, stored as HTML
}

Attachement: {
  id: int, // id of attachement in Jira issue
}

...

Statuses

Status model

Code Block
type Status = {
  id: number;
  name: string;
  isDefault: boolean;
  position: number;
  color: {
    name:
      | 'RED'
      | 'YELLOW'
      | 'GREEN'
      | 'BLUE'
      | 'GRAY'
      | 'MAGENTA'
      | 'TEAL'
      | 'PURPLE'
      | 'ORANGE'
      | 'DARK GRAY'
      | 'LIME';
    textToken: string;
    backgroundToken: string;
  };
}

GET

/statuses?jwt=<JWT>

Response

Code Block
languagetypescript
{
  statuses: Array<Status>;
}

...

Test Executions

GET

...

history

/testExecution/?jwt=<JWT>&testCaseId=<TEST_CASE_ID>&page=<PAGE>

...

Code Block
{
  comment: String, // stored as HTML,
  createdDate: String, // example: 2022-01-31T11:11:11.111+0000,
  executionAssignee: String, // Jira user accountId,
  id: Long,
  name: String,
  statusstatusObject: Status,
  testCaseId: Long, // Jira issue Id
  version: Version,
}

Status = 'passed' | 'failed' | 'in_progress' | 'blocked' | 'unexecuted', // Jira issue Id
  version: Version,
}

Version: {
  id: Long,
  testCaseId: Long, // Jira issue Id
  testCaseName: String, // Jira issue name
  testSteps: Array<TestStep>,
}

TestStep: {
  attachments: String, // TEST ATTACHMENTS, Array<Attachement> stored as String (JSON.stringify)
  data: String, // TEST DATA, stored as HTML
  id: Long,
  testCaseId: Long,
  position: int, // step position
  result: String, // EXPECTED RESULT, stored as HTML
  step: String, //TEST STEP, stored as HTML
}

Attachement: {
  id: number, // id of attachement in Jira issue
}

...

Code Block
{
  name: String,
  statusstatusObject: Status,
  testCaseId: Long,
  testSteps: Array, // should be an empty array []
  testCaseInCycleId: Long, // OPTIONAL, retrieve this id from test cycle. Check POST Add Test Case To Cycle
}

Status = 'passed' | 'failed' | 'in_progress' | 'blocked' | 'unexecuted' cycle. Check POST Add Test Case To Cycle
}

Response:

Code Block
{
  comment: String, // stored as HTML,
  createdDate: String, // example: 2022-01-31T11:11:11.111+0000,
  executionAssignee: String, // Jira user accountId,
  id: Long,
  name: String,
  statusstatusObject: Status,
  testCaseId: Long, // Jira issue Id
  version: Version,
}

Status = 'passed' | 'failed' | 'in_progress' | 'blocked' | 'unexecuted'// Jira issue Id
  version: Version,
}

Version: {
  id: Long,
  testCaseId: Long, // Jira issue Id
  testCaseName: String, // Jira issue name
  testSteps: Array<TestStep>,
}

TestStep: {
  attachments: String, // TEST ATTACHMENTS, Array<Attachement> stored as String (JSON.stringify)
  data: String, // TEST DATA, stored as HTML
  id: Long,
  testCaseId: Long,
  position: int, // step position
  result: String, // EXPECTED RESULT, stored as HTML
  step: String, //TEST STEP, stored as HTML
}

Attachement: {
  id: number, // id of attachement in Jira issue
}

...

Code Block
languagejava
{
  comment: String, // stored as HTML,
  executionAssignee: String, // Jira user accountId,
  id: Long,
  name: String,
  statusstatusObject: Status,
  testCaseId: Long, // Jira issue Id
  testSteps: Array<TestStep>,
}

Status = 'passed' | 'failed' | 'in_progress' | 'blocked' | 'unexecuted' issue Id
  testSteps: Array<TestStep>,
}

TestStep: {
  comment: String, // stored as HTML
  id: Long,
  statusstatusObject: Status,
  testCaseStepId: Long,
}

...

Code Block
{
  comment: String, // stored as HTML,
  createdDate: String, // example: 2022-01-31T11:11:11.111+0000,
  executionAssignee: String, // Jira user accountId,
  id: Long,
  name: String,
  statusstatusObject: Status,
  testCaseId: Long, // Jira issue Id
  version: Version,
}

Status = 'passed' | 'failed' | 'in_progress' | 'blocked' | 'unexecuted'
}

Version: {
  id: Long,
  testCaseId: Long, // Jira issue Id
  testCaseName: String, // Jira issue name
  testSteps: Array<TestStep>,
}

TestStep: {
  attachments: String, // TEST ATTACHMENTS, Array<Attachement> stored as String (JSON.stringify)
  data: String, // TEST DATA, stored as HTML
  id: Long,
  testCaseId: Long,
  position: int, // step position
  result: String, // EXPECTED RESULT, stored as HTML
  step: String, //TEST STEP, stored as HTML
}

Attachement: {
  id: number, // id of attachement in Jira issue
}

...

Code Block
Response: {
  content: Array<TestCycle>;
  pageable: Pageable;
  totalElements: number;
  totalPages: number;
  last: boolean;
  sort: Sort;
  first: boolean;
  number: number;
  numberOfElements: number;
  size: number;
  empty: boolean;
}

TestCycle: {
  id: number;
  name: string;
  versionId: null | string;
  dueDate: null;
  comment: null | string;
  isClosed: boolean;
  projectId: string;
  createdDate: Date;
  numberOfTestCases: number;
  testCaseExistInCycle: null;
  statuses: StatusesStatusesSummary;
}

StatusesStatusesSummary: Array<{
  [keystatus: in Status]: number;
}  Status = 'passed' | 'failed' | 'in_progress' | 'blocked' | 'unexecuted'total: number;
  percent: number;
}>

Pageable: {
  sort: Sort;
  pageNumber: number;
  pageSize: number;
  offset: number;
  paged: boolean;
  unpaged: boolean;
}

Sort: {
  sorted: boolean;
  unsorted: boolean;
  empty: boolean;
}

...