@testcollab/sdk 3.11.0 → 3.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +44 -0
- package/dist/apis/ReleasesApi.d.ts +280 -0
- package/dist/apis/ReleasesApi.js +379 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/ReleasesApi.d.ts +280 -0
- package/dist/esm/apis/ReleasesApi.js +375 -0
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/Activity.d.ts +9 -0
- package/dist/esm/models/Activity.js +6 -1
- package/dist/esm/models/ActivityAuditInfo.d.ts +44 -0
- package/dist/esm/models/ActivityAuditInfo.js +45 -0
- package/dist/esm/models/Release.d.ts +131 -0
- package/dist/esm/models/Release.js +95 -0
- package/dist/esm/models/ReleaseGoNoGoThreshold.d.ts +45 -0
- package/dist/esm/models/ReleaseGoNoGoThreshold.js +45 -0
- package/dist/esm/models/ReleaseMinified.d.ts +67 -0
- package/dist/esm/models/ReleaseMinified.js +65 -0
- package/dist/esm/models/ReleasePayload.d.ts +98 -0
- package/dist/esm/models/ReleasePayload.js +75 -0
- package/dist/esm/models/ReleaseReadiness.d.ts +106 -0
- package/dist/esm/models/ReleaseReadiness.js +79 -0
- package/dist/esm/models/ReleaseReadinessComparison.d.ts +52 -0
- package/dist/esm/models/ReleaseReadinessComparison.js +47 -0
- package/dist/esm/models/ReleaseReadinessConfigurationCoverage.d.ts +84 -0
- package/dist/esm/models/ReleaseReadinessConfigurationCoverage.js +71 -0
- package/dist/esm/models/ReleaseReadinessCoverageItem.d.ts +75 -0
- package/dist/esm/models/ReleaseReadinessCoverageItem.js +65 -0
- package/dist/esm/models/ReleaseReadinessCustomFieldCoverage.d.ts +77 -0
- package/dist/esm/models/ReleaseReadinessCustomFieldCoverage.js +75 -0
- package/dist/esm/models/ReleaseReadinessCustomFieldGroup.d.ts +75 -0
- package/dist/esm/models/ReleaseReadinessCustomFieldGroup.js +69 -0
- package/dist/esm/models/ReleaseReadinessDefectSeverity.d.ts +38 -0
- package/dist/esm/models/ReleaseReadinessDefectSeverity.js +47 -0
- package/dist/esm/models/ReleaseReadinessDefects.d.ts +46 -0
- package/dist/esm/models/ReleaseReadinessDefects.js +52 -0
- package/dist/esm/models/ReleaseReadinessEvidence.d.ts +45 -0
- package/dist/esm/models/ReleaseReadinessEvidence.js +51 -0
- package/dist/esm/models/ReleaseReadinessRequirementCoverage.d.ts +41 -0
- package/dist/esm/models/ReleaseReadinessRequirementCoverage.js +48 -0
- package/dist/esm/models/ReleaseReadinessRequirementItem.d.ts +92 -0
- package/dist/esm/models/ReleaseReadinessRequirementItem.js +84 -0
- package/dist/esm/models/ReleaseReadinessRequirementSummary.d.ts +57 -0
- package/dist/esm/models/ReleaseReadinessRequirementSummary.js +59 -0
- package/dist/esm/models/ReleaseReadinessSummary.d.ts +70 -0
- package/dist/esm/models/ReleaseReadinessSummary.js +51 -0
- package/dist/esm/models/ReleaseReadinessTestPlan.d.ts +69 -0
- package/dist/esm/models/ReleaseReadinessTestPlan.js +68 -0
- package/dist/esm/models/ReleaseReadinessTestPlanRun.d.ts +51 -0
- package/dist/esm/models/ReleaseReadinessTestPlanRun.js +51 -0
- package/dist/esm/models/ReleaseReadinessVerdict.d.ts +50 -0
- package/dist/esm/models/ReleaseReadinessVerdict.js +56 -0
- package/dist/esm/models/StepWiseResult.d.ts +6 -0
- package/dist/esm/models/StepWiseResult.js +2 -0
- package/dist/esm/models/TestDatasetWiseResult.d.ts +6 -0
- package/dist/esm/models/TestDatasetWiseResult.js +2 -0
- package/dist/esm/models/TestPlan.d.ts +7 -0
- package/dist/esm/models/TestPlan.js +2 -0
- package/dist/esm/models/TestPlanBulkActionPayload.d.ts +6 -0
- package/dist/esm/models/TestPlanBulkActionPayload.js +2 -0
- package/dist/esm/models/TestPlanPayload.d.ts +6 -0
- package/dist/esm/models/TestPlanPayload.js +2 -0
- package/dist/esm/models/TraceabilityMatrixPayload.d.ts +7 -0
- package/dist/esm/models/TraceabilityMatrixPayload.js +2 -0
- package/dist/esm/models/index.d.ts +21 -0
- package/dist/esm/models/index.js +21 -0
- package/dist/models/Activity.d.ts +9 -0
- package/dist/models/Activity.js +6 -1
- package/dist/models/ActivityAuditInfo.d.ts +44 -0
- package/dist/models/ActivityAuditInfo.js +52 -0
- package/dist/models/Release.d.ts +131 -0
- package/dist/models/Release.js +103 -0
- package/dist/models/ReleaseGoNoGoThreshold.d.ts +45 -0
- package/dist/models/ReleaseGoNoGoThreshold.js +52 -0
- package/dist/models/ReleaseMinified.d.ts +67 -0
- package/dist/models/ReleaseMinified.js +73 -0
- package/dist/models/ReleasePayload.d.ts +98 -0
- package/dist/models/ReleasePayload.js +83 -0
- package/dist/models/ReleaseReadiness.d.ts +106 -0
- package/dist/models/ReleaseReadiness.js +86 -0
- package/dist/models/ReleaseReadinessComparison.d.ts +52 -0
- package/dist/models/ReleaseReadinessComparison.js +54 -0
- package/dist/models/ReleaseReadinessConfigurationCoverage.d.ts +84 -0
- package/dist/models/ReleaseReadinessConfigurationCoverage.js +78 -0
- package/dist/models/ReleaseReadinessCoverageItem.d.ts +75 -0
- package/dist/models/ReleaseReadinessCoverageItem.js +72 -0
- package/dist/models/ReleaseReadinessCustomFieldCoverage.d.ts +77 -0
- package/dist/models/ReleaseReadinessCustomFieldCoverage.js +83 -0
- package/dist/models/ReleaseReadinessCustomFieldGroup.d.ts +75 -0
- package/dist/models/ReleaseReadinessCustomFieldGroup.js +76 -0
- package/dist/models/ReleaseReadinessDefectSeverity.d.ts +38 -0
- package/dist/models/ReleaseReadinessDefectSeverity.js +54 -0
- package/dist/models/ReleaseReadinessDefects.d.ts +46 -0
- package/dist/models/ReleaseReadinessDefects.js +59 -0
- package/dist/models/ReleaseReadinessEvidence.d.ts +45 -0
- package/dist/models/ReleaseReadinessEvidence.js +58 -0
- package/dist/models/ReleaseReadinessRequirementCoverage.d.ts +41 -0
- package/dist/models/ReleaseReadinessRequirementCoverage.js +55 -0
- package/dist/models/ReleaseReadinessRequirementItem.d.ts +92 -0
- package/dist/models/ReleaseReadinessRequirementItem.js +92 -0
- package/dist/models/ReleaseReadinessRequirementSummary.d.ts +57 -0
- package/dist/models/ReleaseReadinessRequirementSummary.js +66 -0
- package/dist/models/ReleaseReadinessSummary.d.ts +70 -0
- package/dist/models/ReleaseReadinessSummary.js +58 -0
- package/dist/models/ReleaseReadinessTestPlan.d.ts +69 -0
- package/dist/models/ReleaseReadinessTestPlan.js +76 -0
- package/dist/models/ReleaseReadinessTestPlanRun.d.ts +51 -0
- package/dist/models/ReleaseReadinessTestPlanRun.js +58 -0
- package/dist/models/ReleaseReadinessVerdict.d.ts +50 -0
- package/dist/models/ReleaseReadinessVerdict.js +64 -0
- package/dist/models/StepWiseResult.d.ts +6 -0
- package/dist/models/StepWiseResult.js +2 -0
- package/dist/models/TestDatasetWiseResult.d.ts +6 -0
- package/dist/models/TestDatasetWiseResult.js +2 -0
- package/dist/models/TestPlan.d.ts +7 -0
- package/dist/models/TestPlan.js +2 -0
- package/dist/models/TestPlanBulkActionPayload.d.ts +6 -0
- package/dist/models/TestPlanBulkActionPayload.js +2 -0
- package/dist/models/TestPlanPayload.d.ts +6 -0
- package/dist/models/TestPlanPayload.js +2 -0
- package/dist/models/TraceabilityMatrixPayload.d.ts +7 -0
- package/dist/models/TraceabilityMatrixPayload.js +2 -0
- package/dist/models/index.d.ts +21 -0
- package/dist/models/index.js +21 -0
- package/docs/Activity.md +2 -0
- package/docs/ActivityAuditInfo.md +39 -0
- package/docs/Release.md +62 -0
- package/docs/ReleaseGoNoGoThreshold.md +39 -0
- package/docs/ReleaseMinified.md +42 -0
- package/docs/ReleasePayload.md +52 -0
- package/docs/ReleaseReadiness.md +55 -0
- package/docs/ReleaseReadinessComparison.md +41 -0
- package/docs/ReleaseReadinessConfigurationCoverage.md +51 -0
- package/docs/ReleaseReadinessCoverageItem.md +49 -0
- package/docs/ReleaseReadinessCustomFieldCoverage.md +43 -0
- package/docs/ReleaseReadinessCustomFieldGroup.md +49 -0
- package/docs/ReleaseReadinessDefectSeverity.md +36 -0
- package/docs/ReleaseReadinessDefects.md +39 -0
- package/docs/ReleaseReadinessEvidence.md +39 -0
- package/docs/ReleaseReadinessRequirementCoverage.md +37 -0
- package/docs/ReleaseReadinessRequirementItem.md +51 -0
- package/docs/ReleaseReadinessRequirementSummary.md +43 -0
- package/docs/ReleaseReadinessSummary.md +47 -0
- package/docs/ReleaseReadinessTestPlan.md +43 -0
- package/docs/ReleaseReadinessTestPlanRun.md +41 -0
- package/docs/ReleaseReadinessVerdict.md +37 -0
- package/docs/ReleasesApi.md +655 -0
- package/docs/StepWiseResult.md +2 -0
- package/docs/TestDatasetWiseResult.md +2 -0
- package/docs/TestPlan.md +2 -0
- package/docs/TestPlanBulkActionPayload.md +2 -0
- package/docs/TestPlanPayload.md +2 -0
- package/docs/TraceabilityMatrixPayload.md +2 -0
- package/package.json +1 -1
- package/src/apis/ReleasesApi.ts +663 -0
- package/src/apis/index.ts +1 -0
- package/src/models/Activity.ts +18 -1
- package/src/models/ActivityAuditInfo.ts +81 -0
- package/src/models/Release.ts +227 -0
- package/src/models/ReleaseGoNoGoThreshold.ts +82 -0
- package/src/models/ReleaseMinified.ts +114 -0
- package/src/models/ReleasePayload.ts +162 -0
- package/src/models/ReleaseReadiness.ts +233 -0
- package/src/models/ReleaseReadinessComparison.ts +98 -0
- package/src/models/ReleaseReadinessConfigurationCoverage.ts +138 -0
- package/src/models/ReleaseReadinessCoverageItem.ts +127 -0
- package/src/models/ReleaseReadinessCustomFieldCoverage.ts +133 -0
- package/src/models/ReleaseReadinessCustomFieldGroup.ts +129 -0
- package/src/models/ReleaseReadinessDefectSeverity.ts +75 -0
- package/src/models/ReleaseReadinessDefects.ts +93 -0
- package/src/models/ReleaseReadinessEvidence.ts +85 -0
- package/src/models/ReleaseReadinessRequirementCoverage.ts +91 -0
- package/src/models/ReleaseReadinessRequirementItem.ts +153 -0
- package/src/models/ReleaseReadinessRequirementSummary.ts +103 -0
- package/src/models/ReleaseReadinessSummary.ts +124 -0
- package/src/models/ReleaseReadinessTestPlan.ts +131 -0
- package/src/models/ReleaseReadinessTestPlanRun.ts +92 -0
- package/src/models/ReleaseReadinessVerdict.ts +90 -0
- package/src/models/StepWiseResult.ts +8 -0
- package/src/models/TestDatasetWiseResult.ts +8 -0
- package/src/models/TestPlan.ts +15 -0
- package/src/models/TestPlanBulkActionPayload.ts +8 -0
- package/src/models/TestPlanPayload.ts +8 -0
- package/src/models/TraceabilityMatrixPayload.ts +9 -0
- package/src/models/index.ts +21 -0
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* TC API
|
|
3
|
+
* TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2. # Authentication TestCollab supports two forms of authentication: - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token> - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API. Send this token as the Authorization header while making requests to protected resources: `Authorization: Bearer <token>` For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it. # Error Handling Error responses - `Not Found` - Error is sent when requested resource is not available. - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401 - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.3.1
|
|
6
|
+
* Contact: support@testcollab.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Test coverage for a single suite/module within the release. Supports tree structure — parent suites aggregate totals from children.
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface ReleaseReadinessCoverageItem
|
|
17
|
+
*/
|
|
18
|
+
export interface ReleaseReadinessCoverageItem {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {number}
|
|
22
|
+
* @memberof ReleaseReadinessCoverageItem
|
|
23
|
+
*/
|
|
24
|
+
suiteId: number;
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof ReleaseReadinessCoverageItem
|
|
29
|
+
*/
|
|
30
|
+
suiteTitle: string;
|
|
31
|
+
/**
|
|
32
|
+
* Total test cases from this suite (including children) in release test plans
|
|
33
|
+
* @type {number}
|
|
34
|
+
* @memberof ReleaseReadinessCoverageItem
|
|
35
|
+
*/
|
|
36
|
+
total: number;
|
|
37
|
+
/**
|
|
38
|
+
* Number of test cases executed (including children, any status except unexecuted)
|
|
39
|
+
* @type {number}
|
|
40
|
+
* @memberof ReleaseReadinessCoverageItem
|
|
41
|
+
*/
|
|
42
|
+
executed: number;
|
|
43
|
+
/**
|
|
44
|
+
*
|
|
45
|
+
* @type {number}
|
|
46
|
+
* @memberof ReleaseReadinessCoverageItem
|
|
47
|
+
*/
|
|
48
|
+
passed?: number;
|
|
49
|
+
/**
|
|
50
|
+
*
|
|
51
|
+
* @type {number}
|
|
52
|
+
* @memberof ReleaseReadinessCoverageItem
|
|
53
|
+
*/
|
|
54
|
+
failed?: number;
|
|
55
|
+
/**
|
|
56
|
+
* Percentage of passed out of executed
|
|
57
|
+
* @type {number}
|
|
58
|
+
* @memberof ReleaseReadinessCoverageItem
|
|
59
|
+
*/
|
|
60
|
+
passRate: number;
|
|
61
|
+
/**
|
|
62
|
+
* Child suite coverage nodes (tree structure)
|
|
63
|
+
* @type {Array<ReleaseReadinessCoverageItem>}
|
|
64
|
+
* @memberof ReleaseReadinessCoverageItem
|
|
65
|
+
*/
|
|
66
|
+
children?: Array<ReleaseReadinessCoverageItem>;
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Check if a given object implements the ReleaseReadinessCoverageItem interface.
|
|
70
|
+
*/
|
|
71
|
+
export declare function instanceOfReleaseReadinessCoverageItem(value: object): value is ReleaseReadinessCoverageItem;
|
|
72
|
+
export declare function ReleaseReadinessCoverageItemFromJSON(json: any): ReleaseReadinessCoverageItem;
|
|
73
|
+
export declare function ReleaseReadinessCoverageItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseReadinessCoverageItem;
|
|
74
|
+
export declare function ReleaseReadinessCoverageItemToJSON(json: any): ReleaseReadinessCoverageItem;
|
|
75
|
+
export declare function ReleaseReadinessCoverageItemToJSONTyped(value?: ReleaseReadinessCoverageItem | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* TC API
|
|
5
|
+
* TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2. # Authentication TestCollab supports two forms of authentication: - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token> - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API. Send this token as the Authorization header while making requests to protected resources: `Authorization: Bearer <token>` For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it. # Error Handling Error responses - `Not Found` - Error is sent when requested resource is not available. - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401 - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2.3.1
|
|
8
|
+
* Contact: support@testcollab.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* Check if a given object implements the ReleaseReadinessCoverageItem interface.
|
|
16
|
+
*/
|
|
17
|
+
export function instanceOfReleaseReadinessCoverageItem(value) {
|
|
18
|
+
if (!('suiteId' in value) || value['suiteId'] === undefined)
|
|
19
|
+
return false;
|
|
20
|
+
if (!('suiteTitle' in value) || value['suiteTitle'] === undefined)
|
|
21
|
+
return false;
|
|
22
|
+
if (!('total' in value) || value['total'] === undefined)
|
|
23
|
+
return false;
|
|
24
|
+
if (!('executed' in value) || value['executed'] === undefined)
|
|
25
|
+
return false;
|
|
26
|
+
if (!('passRate' in value) || value['passRate'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
return true;
|
|
29
|
+
}
|
|
30
|
+
export function ReleaseReadinessCoverageItemFromJSON(json) {
|
|
31
|
+
return ReleaseReadinessCoverageItemFromJSONTyped(json, false);
|
|
32
|
+
}
|
|
33
|
+
export function ReleaseReadinessCoverageItemFromJSONTyped(json, ignoreDiscriminator) {
|
|
34
|
+
if (json == null) {
|
|
35
|
+
return json;
|
|
36
|
+
}
|
|
37
|
+
return {
|
|
38
|
+
'suiteId': json['suite_id'],
|
|
39
|
+
'suiteTitle': json['suite_title'],
|
|
40
|
+
'total': json['total'],
|
|
41
|
+
'executed': json['executed'],
|
|
42
|
+
'passed': json['passed'] == null ? undefined : json['passed'],
|
|
43
|
+
'failed': json['failed'] == null ? undefined : json['failed'],
|
|
44
|
+
'passRate': json['pass_rate'],
|
|
45
|
+
'children': json['children'] == null ? undefined : (json['children'].map(ReleaseReadinessCoverageItemFromJSON)),
|
|
46
|
+
};
|
|
47
|
+
}
|
|
48
|
+
export function ReleaseReadinessCoverageItemToJSON(json) {
|
|
49
|
+
return ReleaseReadinessCoverageItemToJSONTyped(json, false);
|
|
50
|
+
}
|
|
51
|
+
export function ReleaseReadinessCoverageItemToJSONTyped(value, ignoreDiscriminator = false) {
|
|
52
|
+
if (value == null) {
|
|
53
|
+
return value;
|
|
54
|
+
}
|
|
55
|
+
return {
|
|
56
|
+
'suite_id': value['suiteId'],
|
|
57
|
+
'suite_title': value['suiteTitle'],
|
|
58
|
+
'total': value['total'],
|
|
59
|
+
'executed': value['executed'],
|
|
60
|
+
'passed': value['passed'],
|
|
61
|
+
'failed': value['failed'],
|
|
62
|
+
'pass_rate': value['passRate'],
|
|
63
|
+
'children': value['children'] == null ? undefined : (value['children'].map(ReleaseReadinessCoverageItemToJSON)),
|
|
64
|
+
};
|
|
65
|
+
}
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* TC API
|
|
3
|
+
* TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2. # Authentication TestCollab supports two forms of authentication: - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token> - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API. Send this token as the Authorization header while making requests to protected resources: `Authorization: Bearer <token>` For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it. # Error Handling Error responses - `Not Found` - Error is sent when requested resource is not available. - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401 - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.3.1
|
|
6
|
+
* Contact: support@testcollab.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { ReleaseReadinessCustomFieldGroup } from './ReleaseReadinessCustomFieldGroup';
|
|
13
|
+
/**
|
|
14
|
+
* Coverage breakdown for a single custom field. Groups test cases by their custom field value and shows execution statistics per group. Supports both test case and test plan custom fields.
|
|
15
|
+
*
|
|
16
|
+
* @export
|
|
17
|
+
* @interface ReleaseReadinessCustomFieldCoverage
|
|
18
|
+
*/
|
|
19
|
+
export interface ReleaseReadinessCustomFieldCoverage {
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @type {number}
|
|
23
|
+
* @memberof ReleaseReadinessCustomFieldCoverage
|
|
24
|
+
*/
|
|
25
|
+
fieldId: number;
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @type {string}
|
|
29
|
+
* @memberof ReleaseReadinessCustomFieldCoverage
|
|
30
|
+
*/
|
|
31
|
+
fieldLabel: string;
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {string}
|
|
35
|
+
* @memberof ReleaseReadinessCustomFieldCoverage
|
|
36
|
+
*/
|
|
37
|
+
fieldType: ReleaseReadinessCustomFieldCoverageFieldTypeEnum;
|
|
38
|
+
/**
|
|
39
|
+
* Whether this is a test case or test plan custom field
|
|
40
|
+
* @type {string}
|
|
41
|
+
* @memberof ReleaseReadinessCustomFieldCoverage
|
|
42
|
+
*/
|
|
43
|
+
entity?: ReleaseReadinessCustomFieldCoverageEntityEnum;
|
|
44
|
+
/**
|
|
45
|
+
*
|
|
46
|
+
* @type {Array<ReleaseReadinessCustomFieldGroup>}
|
|
47
|
+
* @memberof ReleaseReadinessCustomFieldCoverage
|
|
48
|
+
*/
|
|
49
|
+
groups: Array<ReleaseReadinessCustomFieldGroup>;
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* @export
|
|
53
|
+
*/
|
|
54
|
+
export declare const ReleaseReadinessCustomFieldCoverageFieldTypeEnum: {
|
|
55
|
+
readonly Dropdown: "dropdown";
|
|
56
|
+
readonly MultipleSelect: "multipleSelect";
|
|
57
|
+
readonly Date: "date";
|
|
58
|
+
readonly Number: "number";
|
|
59
|
+
readonly User: "user";
|
|
60
|
+
};
|
|
61
|
+
export type ReleaseReadinessCustomFieldCoverageFieldTypeEnum = typeof ReleaseReadinessCustomFieldCoverageFieldTypeEnum[keyof typeof ReleaseReadinessCustomFieldCoverageFieldTypeEnum];
|
|
62
|
+
/**
|
|
63
|
+
* @export
|
|
64
|
+
*/
|
|
65
|
+
export declare const ReleaseReadinessCustomFieldCoverageEntityEnum: {
|
|
66
|
+
readonly TestCase: "TestCase";
|
|
67
|
+
readonly TestPlan: "TestPlan";
|
|
68
|
+
};
|
|
69
|
+
export type ReleaseReadinessCustomFieldCoverageEntityEnum = typeof ReleaseReadinessCustomFieldCoverageEntityEnum[keyof typeof ReleaseReadinessCustomFieldCoverageEntityEnum];
|
|
70
|
+
/**
|
|
71
|
+
* Check if a given object implements the ReleaseReadinessCustomFieldCoverage interface.
|
|
72
|
+
*/
|
|
73
|
+
export declare function instanceOfReleaseReadinessCustomFieldCoverage(value: object): value is ReleaseReadinessCustomFieldCoverage;
|
|
74
|
+
export declare function ReleaseReadinessCustomFieldCoverageFromJSON(json: any): ReleaseReadinessCustomFieldCoverage;
|
|
75
|
+
export declare function ReleaseReadinessCustomFieldCoverageFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseReadinessCustomFieldCoverage;
|
|
76
|
+
export declare function ReleaseReadinessCustomFieldCoverageToJSON(json: any): ReleaseReadinessCustomFieldCoverage;
|
|
77
|
+
export declare function ReleaseReadinessCustomFieldCoverageToJSONTyped(value?: ReleaseReadinessCustomFieldCoverage | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* TC API
|
|
5
|
+
* TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2. # Authentication TestCollab supports two forms of authentication: - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token> - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API. Send this token as the Authorization header while making requests to protected resources: `Authorization: Bearer <token>` For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it. # Error Handling Error responses - `Not Found` - Error is sent when requested resource is not available. - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401 - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2.3.1
|
|
8
|
+
* Contact: support@testcollab.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import { ReleaseReadinessCustomFieldGroupFromJSON, ReleaseReadinessCustomFieldGroupToJSON, } from './ReleaseReadinessCustomFieldGroup';
|
|
15
|
+
/**
|
|
16
|
+
* @export
|
|
17
|
+
*/
|
|
18
|
+
export const ReleaseReadinessCustomFieldCoverageFieldTypeEnum = {
|
|
19
|
+
Dropdown: 'dropdown',
|
|
20
|
+
MultipleSelect: 'multipleSelect',
|
|
21
|
+
Date: 'date',
|
|
22
|
+
Number: 'number',
|
|
23
|
+
User: 'user'
|
|
24
|
+
};
|
|
25
|
+
/**
|
|
26
|
+
* @export
|
|
27
|
+
*/
|
|
28
|
+
export const ReleaseReadinessCustomFieldCoverageEntityEnum = {
|
|
29
|
+
TestCase: 'TestCase',
|
|
30
|
+
TestPlan: 'TestPlan'
|
|
31
|
+
};
|
|
32
|
+
/**
|
|
33
|
+
* Check if a given object implements the ReleaseReadinessCustomFieldCoverage interface.
|
|
34
|
+
*/
|
|
35
|
+
export function instanceOfReleaseReadinessCustomFieldCoverage(value) {
|
|
36
|
+
if (!('fieldId' in value) || value['fieldId'] === undefined)
|
|
37
|
+
return false;
|
|
38
|
+
if (!('fieldLabel' in value) || value['fieldLabel'] === undefined)
|
|
39
|
+
return false;
|
|
40
|
+
if (!('fieldType' in value) || value['fieldType'] === undefined)
|
|
41
|
+
return false;
|
|
42
|
+
if (!('groups' in value) || value['groups'] === undefined)
|
|
43
|
+
return false;
|
|
44
|
+
return true;
|
|
45
|
+
}
|
|
46
|
+
export function ReleaseReadinessCustomFieldCoverageFromJSON(json) {
|
|
47
|
+
return ReleaseReadinessCustomFieldCoverageFromJSONTyped(json, false);
|
|
48
|
+
}
|
|
49
|
+
export function ReleaseReadinessCustomFieldCoverageFromJSONTyped(json, ignoreDiscriminator) {
|
|
50
|
+
if (json == null) {
|
|
51
|
+
return json;
|
|
52
|
+
}
|
|
53
|
+
return {
|
|
54
|
+
'fieldId': json['field_id'],
|
|
55
|
+
'fieldLabel': json['field_label'],
|
|
56
|
+
'fieldType': json['field_type'],
|
|
57
|
+
'entity': json['entity'] == null ? undefined : json['entity'],
|
|
58
|
+
'groups': (json['groups'].map(ReleaseReadinessCustomFieldGroupFromJSON)),
|
|
59
|
+
};
|
|
60
|
+
}
|
|
61
|
+
export function ReleaseReadinessCustomFieldCoverageToJSON(json) {
|
|
62
|
+
return ReleaseReadinessCustomFieldCoverageToJSONTyped(json, false);
|
|
63
|
+
}
|
|
64
|
+
export function ReleaseReadinessCustomFieldCoverageToJSONTyped(value, ignoreDiscriminator = false) {
|
|
65
|
+
if (value == null) {
|
|
66
|
+
return value;
|
|
67
|
+
}
|
|
68
|
+
return {
|
|
69
|
+
'field_id': value['fieldId'],
|
|
70
|
+
'field_label': value['fieldLabel'],
|
|
71
|
+
'field_type': value['fieldType'],
|
|
72
|
+
'entity': value['entity'],
|
|
73
|
+
'groups': (value['groups'].map(ReleaseReadinessCustomFieldGroupToJSON)),
|
|
74
|
+
};
|
|
75
|
+
}
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* TC API
|
|
3
|
+
* TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2. # Authentication TestCollab supports two forms of authentication: - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token> - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API. Send this token as the Authorization header while making requests to protected resources: `Authorization: Bearer <token>` For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it. # Error Handling Error responses - `Not Found` - Error is sent when requested resource is not available. - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401 - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.3.1
|
|
6
|
+
* Contact: support@testcollab.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Coverage data for a single value/group within a custom field.
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface ReleaseReadinessCustomFieldGroup
|
|
17
|
+
*/
|
|
18
|
+
export interface ReleaseReadinessCustomFieldGroup {
|
|
19
|
+
/**
|
|
20
|
+
* The raw custom field value (systemValue for dropdown, actual value for others)
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof ReleaseReadinessCustomFieldGroup
|
|
23
|
+
*/
|
|
24
|
+
value: string;
|
|
25
|
+
/**
|
|
26
|
+
* Human-readable label for this value
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof ReleaseReadinessCustomFieldGroup
|
|
29
|
+
*/
|
|
30
|
+
label: string;
|
|
31
|
+
/**
|
|
32
|
+
* Hex color for dropdown/multipleSelect options (if available)
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof ReleaseReadinessCustomFieldGroup
|
|
35
|
+
*/
|
|
36
|
+
color?: string;
|
|
37
|
+
/**
|
|
38
|
+
* Total test cases with this custom field value that are in the release
|
|
39
|
+
* @type {number}
|
|
40
|
+
* @memberof ReleaseReadinessCustomFieldGroup
|
|
41
|
+
*/
|
|
42
|
+
total: number;
|
|
43
|
+
/**
|
|
44
|
+
*
|
|
45
|
+
* @type {number}
|
|
46
|
+
* @memberof ReleaseReadinessCustomFieldGroup
|
|
47
|
+
*/
|
|
48
|
+
executed: number;
|
|
49
|
+
/**
|
|
50
|
+
*
|
|
51
|
+
* @type {number}
|
|
52
|
+
* @memberof ReleaseReadinessCustomFieldGroup
|
|
53
|
+
*/
|
|
54
|
+
passed: number;
|
|
55
|
+
/**
|
|
56
|
+
*
|
|
57
|
+
* @type {number}
|
|
58
|
+
* @memberof ReleaseReadinessCustomFieldGroup
|
|
59
|
+
*/
|
|
60
|
+
failed: number;
|
|
61
|
+
/**
|
|
62
|
+
* Percentage of passed out of executed
|
|
63
|
+
* @type {number}
|
|
64
|
+
* @memberof ReleaseReadinessCustomFieldGroup
|
|
65
|
+
*/
|
|
66
|
+
passRate: number;
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Check if a given object implements the ReleaseReadinessCustomFieldGroup interface.
|
|
70
|
+
*/
|
|
71
|
+
export declare function instanceOfReleaseReadinessCustomFieldGroup(value: object): value is ReleaseReadinessCustomFieldGroup;
|
|
72
|
+
export declare function ReleaseReadinessCustomFieldGroupFromJSON(json: any): ReleaseReadinessCustomFieldGroup;
|
|
73
|
+
export declare function ReleaseReadinessCustomFieldGroupFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseReadinessCustomFieldGroup;
|
|
74
|
+
export declare function ReleaseReadinessCustomFieldGroupToJSON(json: any): ReleaseReadinessCustomFieldGroup;
|
|
75
|
+
export declare function ReleaseReadinessCustomFieldGroupToJSONTyped(value?: ReleaseReadinessCustomFieldGroup | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* TC API
|
|
5
|
+
* TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2. # Authentication TestCollab supports two forms of authentication: - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token> - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API. Send this token as the Authorization header while making requests to protected resources: `Authorization: Bearer <token>` For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it. # Error Handling Error responses - `Not Found` - Error is sent when requested resource is not available. - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401 - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2.3.1
|
|
8
|
+
* Contact: support@testcollab.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* Check if a given object implements the ReleaseReadinessCustomFieldGroup interface.
|
|
16
|
+
*/
|
|
17
|
+
export function instanceOfReleaseReadinessCustomFieldGroup(value) {
|
|
18
|
+
if (!('value' in value) || value['value'] === undefined)
|
|
19
|
+
return false;
|
|
20
|
+
if (!('label' in value) || value['label'] === undefined)
|
|
21
|
+
return false;
|
|
22
|
+
if (!('total' in value) || value['total'] === undefined)
|
|
23
|
+
return false;
|
|
24
|
+
if (!('executed' in value) || value['executed'] === undefined)
|
|
25
|
+
return false;
|
|
26
|
+
if (!('passed' in value) || value['passed'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
if (!('failed' in value) || value['failed'] === undefined)
|
|
29
|
+
return false;
|
|
30
|
+
if (!('passRate' in value) || value['passRate'] === undefined)
|
|
31
|
+
return false;
|
|
32
|
+
return true;
|
|
33
|
+
}
|
|
34
|
+
export function ReleaseReadinessCustomFieldGroupFromJSON(json) {
|
|
35
|
+
return ReleaseReadinessCustomFieldGroupFromJSONTyped(json, false);
|
|
36
|
+
}
|
|
37
|
+
export function ReleaseReadinessCustomFieldGroupFromJSONTyped(json, ignoreDiscriminator) {
|
|
38
|
+
if (json == null) {
|
|
39
|
+
return json;
|
|
40
|
+
}
|
|
41
|
+
return {
|
|
42
|
+
'value': json['value'],
|
|
43
|
+
'label': json['label'],
|
|
44
|
+
'color': json['color'] == null ? undefined : json['color'],
|
|
45
|
+
'total': json['total'],
|
|
46
|
+
'executed': json['executed'],
|
|
47
|
+
'passed': json['passed'],
|
|
48
|
+
'failed': json['failed'],
|
|
49
|
+
'passRate': json['pass_rate'],
|
|
50
|
+
};
|
|
51
|
+
}
|
|
52
|
+
export function ReleaseReadinessCustomFieldGroupToJSON(json) {
|
|
53
|
+
return ReleaseReadinessCustomFieldGroupToJSONTyped(json, false);
|
|
54
|
+
}
|
|
55
|
+
export function ReleaseReadinessCustomFieldGroupToJSONTyped(value, ignoreDiscriminator = false) {
|
|
56
|
+
if (value == null) {
|
|
57
|
+
return value;
|
|
58
|
+
}
|
|
59
|
+
return {
|
|
60
|
+
'value': value['value'],
|
|
61
|
+
'label': value['label'],
|
|
62
|
+
'color': value['color'],
|
|
63
|
+
'total': value['total'],
|
|
64
|
+
'executed': value['executed'],
|
|
65
|
+
'passed': value['passed'],
|
|
66
|
+
'failed': value['failed'],
|
|
67
|
+
'pass_rate': value['passRate'],
|
|
68
|
+
};
|
|
69
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* TC API
|
|
3
|
+
* TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2. # Authentication TestCollab supports two forms of authentication: - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token> - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API. Send this token as the Authorization header while making requests to protected resources: `Authorization: Bearer <token>` For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it. # Error Handling Error responses - `Not Found` - Error is sent when requested resource is not available. - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401 - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.3.1
|
|
6
|
+
* Contact: support@testcollab.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface ReleaseReadinessDefectSeverity
|
|
16
|
+
*/
|
|
17
|
+
export interface ReleaseReadinessDefectSeverity {
|
|
18
|
+
/**
|
|
19
|
+
* Severity label from the external issue tracker (e.g. Blocker, Critical, Major, Minor)
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof ReleaseReadinessDefectSeverity
|
|
22
|
+
*/
|
|
23
|
+
severity: string;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {number}
|
|
27
|
+
* @memberof ReleaseReadinessDefectSeverity
|
|
28
|
+
*/
|
|
29
|
+
count: number;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Check if a given object implements the ReleaseReadinessDefectSeverity interface.
|
|
33
|
+
*/
|
|
34
|
+
export declare function instanceOfReleaseReadinessDefectSeverity(value: object): value is ReleaseReadinessDefectSeverity;
|
|
35
|
+
export declare function ReleaseReadinessDefectSeverityFromJSON(json: any): ReleaseReadinessDefectSeverity;
|
|
36
|
+
export declare function ReleaseReadinessDefectSeverityFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseReadinessDefectSeverity;
|
|
37
|
+
export declare function ReleaseReadinessDefectSeverityToJSON(json: any): ReleaseReadinessDefectSeverity;
|
|
38
|
+
export declare function ReleaseReadinessDefectSeverityToJSONTyped(value?: ReleaseReadinessDefectSeverity | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* TC API
|
|
5
|
+
* TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2. # Authentication TestCollab supports two forms of authentication: - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token> - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API. Send this token as the Authorization header while making requests to protected resources: `Authorization: Bearer <token>` For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it. # Error Handling Error responses - `Not Found` - Error is sent when requested resource is not available. - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401 - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2.3.1
|
|
8
|
+
* Contact: support@testcollab.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* Check if a given object implements the ReleaseReadinessDefectSeverity interface.
|
|
16
|
+
*/
|
|
17
|
+
export function instanceOfReleaseReadinessDefectSeverity(value) {
|
|
18
|
+
if (!('severity' in value) || value['severity'] === undefined)
|
|
19
|
+
return false;
|
|
20
|
+
if (!('count' in value) || value['count'] === undefined)
|
|
21
|
+
return false;
|
|
22
|
+
return true;
|
|
23
|
+
}
|
|
24
|
+
export function ReleaseReadinessDefectSeverityFromJSON(json) {
|
|
25
|
+
return ReleaseReadinessDefectSeverityFromJSONTyped(json, false);
|
|
26
|
+
}
|
|
27
|
+
export function ReleaseReadinessDefectSeverityFromJSONTyped(json, ignoreDiscriminator) {
|
|
28
|
+
if (json == null) {
|
|
29
|
+
return json;
|
|
30
|
+
}
|
|
31
|
+
return {
|
|
32
|
+
'severity': json['severity'],
|
|
33
|
+
'count': json['count'],
|
|
34
|
+
};
|
|
35
|
+
}
|
|
36
|
+
export function ReleaseReadinessDefectSeverityToJSON(json) {
|
|
37
|
+
return ReleaseReadinessDefectSeverityToJSONTyped(json, false);
|
|
38
|
+
}
|
|
39
|
+
export function ReleaseReadinessDefectSeverityToJSONTyped(value, ignoreDiscriminator = false) {
|
|
40
|
+
if (value == null) {
|
|
41
|
+
return value;
|
|
42
|
+
}
|
|
43
|
+
return {
|
|
44
|
+
'severity': value['severity'],
|
|
45
|
+
'count': value['count'],
|
|
46
|
+
};
|
|
47
|
+
}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* TC API
|
|
3
|
+
* TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2. # Authentication TestCollab supports two forms of authentication: - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token> - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API. Send this token as the Authorization header while making requests to protected resources: `Authorization: Bearer <token>` For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it. # Error Handling Error responses - `Not Found` - Error is sent when requested resource is not available. - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401 - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.3.1
|
|
6
|
+
* Contact: support@testcollab.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { ReleaseReadinessDefectSeverity } from './ReleaseReadinessDefectSeverity';
|
|
13
|
+
/**
|
|
14
|
+
* Defects linked to test plans in this release, with open count and severity breakdown.
|
|
15
|
+
*
|
|
16
|
+
* @export
|
|
17
|
+
* @interface ReleaseReadinessDefects
|
|
18
|
+
*/
|
|
19
|
+
export interface ReleaseReadinessDefects {
|
|
20
|
+
/**
|
|
21
|
+
* Total number of defects (all statuses) across all test plans
|
|
22
|
+
* @type {number}
|
|
23
|
+
* @memberof ReleaseReadinessDefects
|
|
24
|
+
*/
|
|
25
|
+
total: number;
|
|
26
|
+
/**
|
|
27
|
+
* Total number of open defects across all test plans
|
|
28
|
+
* @type {number}
|
|
29
|
+
* @memberof ReleaseReadinessDefects
|
|
30
|
+
*/
|
|
31
|
+
totalOpen: number;
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {Array<ReleaseReadinessDefectSeverity>}
|
|
35
|
+
* @memberof ReleaseReadinessDefects
|
|
36
|
+
*/
|
|
37
|
+
bySeverity: Array<ReleaseReadinessDefectSeverity>;
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Check if a given object implements the ReleaseReadinessDefects interface.
|
|
41
|
+
*/
|
|
42
|
+
export declare function instanceOfReleaseReadinessDefects(value: object): value is ReleaseReadinessDefects;
|
|
43
|
+
export declare function ReleaseReadinessDefectsFromJSON(json: any): ReleaseReadinessDefects;
|
|
44
|
+
export declare function ReleaseReadinessDefectsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseReadinessDefects;
|
|
45
|
+
export declare function ReleaseReadinessDefectsToJSON(json: any): ReleaseReadinessDefects;
|
|
46
|
+
export declare function ReleaseReadinessDefectsToJSONTyped(value?: ReleaseReadinessDefects | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* TC API
|
|
5
|
+
* TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2. # Authentication TestCollab supports two forms of authentication: - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token> - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API. Send this token as the Authorization header while making requests to protected resources: `Authorization: Bearer <token>` For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it. # Error Handling Error responses - `Not Found` - Error is sent when requested resource is not available. - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401 - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2.3.1
|
|
8
|
+
* Contact: support@testcollab.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import { ReleaseReadinessDefectSeverityFromJSON, ReleaseReadinessDefectSeverityToJSON, } from './ReleaseReadinessDefectSeverity';
|
|
15
|
+
/**
|
|
16
|
+
* Check if a given object implements the ReleaseReadinessDefects interface.
|
|
17
|
+
*/
|
|
18
|
+
export function instanceOfReleaseReadinessDefects(value) {
|
|
19
|
+
if (!('total' in value) || value['total'] === undefined)
|
|
20
|
+
return false;
|
|
21
|
+
if (!('totalOpen' in value) || value['totalOpen'] === undefined)
|
|
22
|
+
return false;
|
|
23
|
+
if (!('bySeverity' in value) || value['bySeverity'] === undefined)
|
|
24
|
+
return false;
|
|
25
|
+
return true;
|
|
26
|
+
}
|
|
27
|
+
export function ReleaseReadinessDefectsFromJSON(json) {
|
|
28
|
+
return ReleaseReadinessDefectsFromJSONTyped(json, false);
|
|
29
|
+
}
|
|
30
|
+
export function ReleaseReadinessDefectsFromJSONTyped(json, ignoreDiscriminator) {
|
|
31
|
+
if (json == null) {
|
|
32
|
+
return json;
|
|
33
|
+
}
|
|
34
|
+
return {
|
|
35
|
+
'total': json['total'],
|
|
36
|
+
'totalOpen': json['total_open'],
|
|
37
|
+
'bySeverity': (json['by_severity'].map(ReleaseReadinessDefectSeverityFromJSON)),
|
|
38
|
+
};
|
|
39
|
+
}
|
|
40
|
+
export function ReleaseReadinessDefectsToJSON(json) {
|
|
41
|
+
return ReleaseReadinessDefectsToJSONTyped(json, false);
|
|
42
|
+
}
|
|
43
|
+
export function ReleaseReadinessDefectsToJSONTyped(value, ignoreDiscriminator = false) {
|
|
44
|
+
if (value == null) {
|
|
45
|
+
return value;
|
|
46
|
+
}
|
|
47
|
+
return {
|
|
48
|
+
'total': value['total'],
|
|
49
|
+
'total_open': value['totalOpen'],
|
|
50
|
+
'by_severity': (value['bySeverity'].map(ReleaseReadinessDefectSeverityToJSON)),
|
|
51
|
+
};
|
|
52
|
+
}
|