@resolution/jira-api-client 0.14.1 → 0.15.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/lib/openapi/core/CommonHttpClient.d.ts +7 -1
- package/lib/openapi/core/CommonHttpClient.js +15 -1
- package/lib/openapi/core/CommonHttpClient.js.map +1 -1
- package/lib/openapi/platform/BaseJiraPlatformApiClient.d.ts +6 -6
- package/lib/openapi/platform/BaseJiraPlatformApiClient.js +1 -2
- package/lib/openapi/platform/BaseJiraPlatformApiClient.js.map +1 -1
- package/lib/openapi/platform/models/common.d.ts +0 -17
- package/lib/openapi/platform/models/common.js +0 -12
- package/lib/openapi/platform/models/common.js.map +1 -1
- package/lib/openapi/platform/models/groups.d.ts +20 -0
- package/lib/openapi/platform/models/groups.js +4 -1
- package/lib/openapi/platform/models/groups.js.map +1 -1
- package/lib/openapi/platform/models/issueBulkOperations.d.ts +8 -5
- package/lib/openapi/platform/models/issueBulkOperations.js.map +1 -1
- package/lib/openapi/platform/models/issueRedaction.d.ts +14 -4
- package/lib/openapi/platform/models/issueRedaction.js +1 -1
- package/lib/openapi/platform/models/issueRedaction.js.map +1 -1
- package/lib/openapi/platform/models/issueSearch.d.ts +2 -0
- package/lib/openapi/platform/models/issueSearch.js +1 -0
- package/lib/openapi/platform/models/issueSearch.js.map +1 -1
- package/lib/openapi/platform/models/issueTypes.d.ts +9 -1
- package/lib/openapi/platform/models/issueTypes.js.map +1 -1
- package/lib/openapi/platform/models/jiraExpressions.d.ts +2 -0
- package/lib/openapi/platform/models/jiraExpressions.js +1 -0
- package/lib/openapi/platform/models/jiraExpressions.js.map +1 -1
- package/lib/openapi/platform/models/projectTemplates.d.ts +88 -4
- package/lib/openapi/platform/models/projectTemplates.js +47 -4
- package/lib/openapi/platform/models/projectTemplates.js.map +1 -1
- package/lib/openapi/platform/models/status.d.ts +1 -40
- package/lib/openapi/platform/models/status.js +1 -23
- package/lib/openapi/platform/models/status.js.map +1 -1
- package/lib/openapi/platform/models/workflowSchemes.d.ts +0 -33
- package/lib/openapi/platform/models/workflowSchemes.js +0 -6
- package/lib/openapi/platform/models/workflowSchemes.js.map +1 -1
- package/lib/openapi/platform/models/workflows.d.ts +1 -24
- package/lib/openapi/platform/models/workflows.js +1 -19
- package/lib/openapi/platform/models/workflows.js.map +1 -1
- package/lib/openapi/platform/services/ApplicationRolesService.d.ts +4 -0
- package/lib/openapi/platform/services/ApplicationRolesService.js +4 -0
- package/lib/openapi/platform/services/ApplicationRolesService.js.map +1 -1
- package/lib/openapi/platform/services/GroupsService.d.ts +2 -1
- package/lib/openapi/platform/services/GroupsService.js +3 -2
- package/lib/openapi/platform/services/GroupsService.js.map +1 -1
- package/lib/openapi/platform/services/IssueBulkOperationsService.d.ts +20 -10
- package/lib/openapi/platform/services/IssueBulkOperationsService.js +20 -10
- package/lib/openapi/platform/services/IssueBulkOperationsService.js.map +1 -1
- package/lib/openapi/platform/services/IssueFieldConfigurationsService.d.ts +4 -0
- package/lib/openapi/platform/services/IssueFieldConfigurationsService.js +4 -0
- package/lib/openapi/platform/services/IssueFieldConfigurationsService.js.map +1 -1
- package/lib/openapi/platform/services/IssueSearchService.d.ts +8 -0
- package/lib/openapi/platform/services/IssueSearchService.js +8 -0
- package/lib/openapi/platform/services/IssueSearchService.js.map +1 -1
- package/lib/openapi/platform/services/JiraExpressionsService.d.ts +5 -1
- package/lib/openapi/platform/services/JiraExpressionsService.js +5 -1
- package/lib/openapi/platform/services/JiraExpressionsService.js.map +1 -1
- package/lib/openapi/platform/services/MyselfService.d.ts +0 -15
- package/lib/openapi/platform/services/MyselfService.js +0 -29
- package/lib/openapi/platform/services/MyselfService.js.map +1 -1
- package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.d.ts +4 -0
- package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.js +4 -0
- package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.js.map +1 -1
- package/lib/openapi/platform/services/ProjectTemplatesService.d.ts +83 -1
- package/lib/openapi/platform/services/ProjectTemplatesService.js +138 -0
- package/lib/openapi/platform/services/ProjectTemplatesService.js.map +1 -1
- package/lib/openapi/platform/services/StatusService.d.ts +5 -65
- package/lib/openapi/platform/services/StatusService.js +5 -41
- package/lib/openapi/platform/services/StatusService.js.map +1 -1
- package/lib/openapi/platform/services/UsersService.d.ts +10 -3
- package/lib/openapi/platform/services/UsersService.js +4 -0
- package/lib/openapi/platform/services/UsersService.js.map +1 -1
- package/lib/openapi/platform/services/WorkflowSchemesService.d.ts +1 -30
- package/lib/openapi/platform/services/WorkflowSchemesService.js +1 -21
- package/lib/openapi/platform/services/WorkflowSchemesService.js.map +1 -1
- package/lib/openapi/platform/services/WorkflowsService.d.ts +50 -92
- package/lib/openapi/platform/services/WorkflowsService.js +50 -70
- package/lib/openapi/platform/services/WorkflowsService.js.map +1 -1
- package/lib/openapi/serviceManagement/BaseJiraServiceManagementApiClient.d.ts +1 -1
- package/lib/openapi/serviceManagement/BaseJiraServiceManagementApiClient.js +1 -1
- package/lib/openapi/software/BaseJiraSoftwareApiClient.d.ts +64 -341
- package/lib/openapi/software/BaseJiraSoftwareApiClient.js +58 -335
- package/lib/openapi/software/BaseJiraSoftwareApiClient.js.map +1 -1
- package/lib/openapi/software/models/builds.d.ts +30 -2
- package/lib/openapi/software/models/builds.js +5 -2
- package/lib/openapi/software/models/builds.js.map +1 -1
- package/lib/openapi/software/models/common.d.ts +68 -5
- package/lib/openapi/software/models/common.js +9 -1
- package/lib/openapi/software/models/common.js.map +1 -1
- package/lib/openapi/software/models/deployments.d.ts +33 -90
- package/lib/openapi/software/models/deployments.js +8 -29
- package/lib/openapi/software/models/deployments.js.map +1 -1
- package/lib/openapi/software/models/devOpsComponents.d.ts +1 -1
- package/lib/openapi/software/models/devOpsComponents.js +1 -1
- package/lib/openapi/software/models/devOpsComponents.js.map +1 -1
- package/lib/openapi/software/models/developmentInformation.d.ts +14 -653
- package/lib/openapi/software/models/developmentInformation.js +2 -84
- package/lib/openapi/software/models/developmentInformation.js.map +1 -1
- package/lib/openapi/software/models/featureFlags.d.ts +21 -2
- package/lib/openapi/software/models/featureFlags.js +6 -2
- package/lib/openapi/software/models/featureFlags.js.map +1 -1
- package/lib/openapi/software/models/remoteLinks.d.ts +2 -121
- package/lib/openapi/software/models/remoteLinks.js +1 -16
- package/lib/openapi/software/models/remoteLinks.js.map +1 -1
- package/lib/openapi/software/services/BuildsService.d.ts +11 -23
- package/lib/openapi/software/services/BuildsService.js +11 -23
- package/lib/openapi/software/services/BuildsService.js.map +1 -1
- package/lib/openapi/software/services/DeploymentsService.d.ts +11 -23
- package/lib/openapi/software/services/DeploymentsService.js +11 -23
- package/lib/openapi/software/services/DeploymentsService.js.map +1 -1
- package/lib/openapi/software/services/DevOpsComponentsService.d.ts +8 -111
- package/lib/openapi/software/services/DevOpsComponentsService.js +15 -118
- package/lib/openapi/software/services/DevOpsComponentsService.js.map +1 -1
- package/lib/openapi/software/services/DevelopmentInformationService.d.ts +11 -4
- package/lib/openapi/software/services/DevelopmentInformationService.js +11 -4
- package/lib/openapi/software/services/DevelopmentInformationService.js.map +1 -1
- package/lib/openapi/software/services/FeatureFlagsService.d.ts +9 -21
- package/lib/openapi/software/services/FeatureFlagsService.js +9 -21
- package/lib/openapi/software/services/FeatureFlagsService.js.map +1 -1
- package/lib/openapi/software/services/OperationsService.d.ts +5 -99
- package/lib/openapi/software/services/OperationsService.js +5 -99
- package/lib/openapi/software/services/OperationsService.js.map +1 -1
- package/lib/openapi/software/services/RemoteLinksService.d.ts +10 -123
- package/lib/openapi/software/services/RemoteLinksService.js +10 -123
- package/lib/openapi/software/services/RemoteLinksService.js.map +1 -1
- package/lib/openapi/software/services/SecurityInformationService.d.ts +2 -2
- package/lib/openapi/software/services/SecurityInformationService.js +2 -2
- package/package.json +3 -3
|
@@ -1,11 +1,15 @@
|
|
|
1
1
|
import { CommonHttpService } from "../../core/CommonHttpService";
|
|
2
2
|
import { type SubmitFeatureFlagRequest, type SubmitFeatureFlagsResponse, type FeatureFlagData } from "../models/featureFlags";
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
*
|
|
4
|
+
* APIs related to integrating feature flags with Jira Software.
|
|
5
|
+
*
|
|
6
|
+
* These APIs are available to Atlassian Connect apps. To use these APIs you must
|
|
7
|
+
* have the `jiraFeatureFlagInfoProvider` module in your Connect app's descriptor.
|
|
8
|
+
* See https://developer.atlassian.com/cloud/jira/software/modules/feature-flag/.
|
|
9
|
+
*
|
|
10
|
+
* These APIs are available to Forge apps with the
|
|
11
|
+
* `devops:featureFlagInfoProvider` module in the Forge app's manifest. See
|
|
12
|
+
* https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-software-feature-flag-info/.
|
|
9
13
|
*
|
|
10
14
|
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-feature-flags
|
|
11
15
|
* @category Services
|
|
@@ -17,10 +21,6 @@ export declare class FeatureFlagsService extends CommonHttpService {
|
|
|
17
21
|
* Deletion is performed asynchronously. The getFeatureFlagById operation can be
|
|
18
22
|
* used to confirm that data has been deleted successfully (if needed).
|
|
19
23
|
*
|
|
20
|
-
* Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can
|
|
21
|
-
* access this resource.
|
|
22
|
-
* This resource requires the 'DELETE' scope for Connect apps.
|
|
23
|
-
*
|
|
24
24
|
* @path DELETE `/rest/featureflags/0.1/flag/{featureFlagId}`
|
|
25
25
|
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-feature-flags#api-rest-featureflags-0-1-flag-featureflagid-delete
|
|
26
26
|
* @param params
|
|
@@ -67,10 +67,6 @@ export declare class FeatureFlagsService extends CommonHttpService {
|
|
|
67
67
|
* Deletion is performed asynchronously. The getFeatureFlagById operation can be
|
|
68
68
|
* used to confirm that data has been deleted successfully (if needed).
|
|
69
69
|
*
|
|
70
|
-
* Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can
|
|
71
|
-
* access this resource.
|
|
72
|
-
* This resource requires the 'DELETE' scope for Connect apps.
|
|
73
|
-
*
|
|
74
70
|
* @path DELETE `/rest/featureflags/0.1/bulkByProperties`
|
|
75
71
|
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-feature-flags#api-rest-featureflags-0-1-bulkbyproperties-delete
|
|
76
72
|
* @param params
|
|
@@ -109,10 +105,6 @@ export declare class FeatureFlagsService extends CommonHttpService {
|
|
|
109
105
|
* The result will be what is currently stored, ignoring any pending updates or
|
|
110
106
|
* deletes.
|
|
111
107
|
*
|
|
112
|
-
* Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can
|
|
113
|
-
* access this resource.
|
|
114
|
-
* This resource requires the 'READ' scope for Connect apps.
|
|
115
|
-
*
|
|
116
108
|
* @returns The Feature Flag data currently stored for the given ID.
|
|
117
109
|
* @path GET `/rest/featureflags/0.1/flag/{featureFlagId}`
|
|
118
110
|
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-feature-flags#api-rest-featureflags-0-1-flag-featureflagid-get
|
|
@@ -150,10 +142,6 @@ export declare class FeatureFlagsService extends CommonHttpService {
|
|
|
150
142
|
* validated individually prior to submission. Details of which Feature Flags
|
|
151
143
|
* failed submission (if any) are available in the response object.
|
|
152
144
|
*
|
|
153
|
-
* Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can
|
|
154
|
-
* access this resource.
|
|
155
|
-
* This resource requires the 'WRITE' scope for Connect apps.
|
|
156
|
-
*
|
|
157
145
|
* @returns Submission accepted. Each submitted Feature Flag that is of a valid format will be eventually available in Jira.
|
|
158
146
|
*
|
|
159
147
|
* Details of which Feature Flags were submitted and which failed submission (due to data format problems etc.) are available in the response object.
|
|
@@ -10,11 +10,15 @@ const featureFlags_1 = require("../models/featureFlags");
|
|
|
10
10
|
const validationSchemaStorage_1 = require("../validationSchemaStorage");
|
|
11
11
|
const zod_1 = require("zod");
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
13
|
+
* APIs related to integrating feature flags with Jira Software.
|
|
14
|
+
*
|
|
15
|
+
* These APIs are available to Atlassian Connect apps. To use these APIs you must
|
|
16
|
+
* have the `jiraFeatureFlagInfoProvider` module in your Connect app's descriptor.
|
|
17
|
+
* See https://developer.atlassian.com/cloud/jira/software/modules/feature-flag/.
|
|
18
|
+
*
|
|
19
|
+
* These APIs are available to Forge apps with the
|
|
20
|
+
* `devops:featureFlagInfoProvider` module in the Forge app's manifest. See
|
|
21
|
+
* https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-software-feature-flag-info/.
|
|
18
22
|
*
|
|
19
23
|
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-feature-flags
|
|
20
24
|
* @category Services
|
|
@@ -28,10 +32,6 @@ class FeatureFlagsService extends CommonHttpService_1.CommonHttpService {
|
|
|
28
32
|
* Deletion is performed asynchronously. The getFeatureFlagById operation can be
|
|
29
33
|
* used to confirm that data has been deleted successfully (if needed).
|
|
30
34
|
*
|
|
31
|
-
* Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can
|
|
32
|
-
* access this resource.
|
|
33
|
-
* This resource requires the 'DELETE' scope for Connect apps.
|
|
34
|
-
*
|
|
35
35
|
* @path DELETE `/rest/featureflags/0.1/flag/{featureFlagId}`
|
|
36
36
|
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-feature-flags#api-rest-featureflags-0-1-flag-featureflagid-delete
|
|
37
37
|
* @param params
|
|
@@ -65,10 +65,6 @@ class FeatureFlagsService extends CommonHttpService_1.CommonHttpService {
|
|
|
65
65
|
* Deletion is performed asynchronously. The getFeatureFlagById operation can be
|
|
66
66
|
* used to confirm that data has been deleted successfully (if needed).
|
|
67
67
|
*
|
|
68
|
-
* Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can
|
|
69
|
-
* access this resource.
|
|
70
|
-
* This resource requires the 'DELETE' scope for Connect apps.
|
|
71
|
-
*
|
|
72
68
|
* @path DELETE `/rest/featureflags/0.1/bulkByProperties`
|
|
73
69
|
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-feature-flags#api-rest-featureflags-0-1-bulkbyproperties-delete
|
|
74
70
|
* @param params
|
|
@@ -91,10 +87,6 @@ class FeatureFlagsService extends CommonHttpService_1.CommonHttpService {
|
|
|
91
87
|
* The result will be what is currently stored, ignoring any pending updates or
|
|
92
88
|
* deletes.
|
|
93
89
|
*
|
|
94
|
-
* Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can
|
|
95
|
-
* access this resource.
|
|
96
|
-
* This resource requires the 'READ' scope for Connect apps.
|
|
97
|
-
*
|
|
98
90
|
* @returns The Feature Flag data currently stored for the given ID.
|
|
99
91
|
* @path GET `/rest/featureflags/0.1/flag/{featureFlagId}`
|
|
100
92
|
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-feature-flags#api-rest-featureflags-0-1-flag-featureflagid-get
|
|
@@ -133,10 +125,6 @@ class FeatureFlagsService extends CommonHttpService_1.CommonHttpService {
|
|
|
133
125
|
* validated individually prior to submission. Details of which Feature Flags
|
|
134
126
|
* failed submission (if any) are available in the response object.
|
|
135
127
|
*
|
|
136
|
-
* Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can
|
|
137
|
-
* access this resource.
|
|
138
|
-
* This resource requires the 'WRITE' scope for Connect apps.
|
|
139
|
-
*
|
|
140
128
|
* @returns Submission accepted. Each submitted Feature Flag that is of a valid format will be eventually available in Jira.
|
|
141
129
|
*
|
|
142
130
|
* Details of which Feature Flags were submitted and which failed submission (due to data format problems etc.) are available in the response object.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FeatureFlagsService.js","sourceRoot":"","sources":["../../../../src/openapi/software/services/FeatureFlagsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,gEAAgE;AAChE,oEAAiE;AACjE,yDAAqK;AACrK,wEAAqE;AACrE,6BAAwB;AACxB
|
|
1
|
+
{"version":3,"file":"FeatureFlagsService.js","sourceRoot":"","sources":["../../../../src/openapi/software/services/FeatureFlagsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,gEAAgE;AAChE,oEAAiE;AACjE,yDAAqK;AACrK,wEAAqE;AACrE,6BAAwB;AACxB;;;;;;;;;;;;;GAaG;AACH,MAAa,mBAAoB,SAAQ,qCAAiB;IAA1D;;QACE;;;;;;;;;WASG;QACH,0BAAqB,GAAG,CAAC,EACvB,aAAa,EACb,gBAAgB,EAChB,aAAa,EA4Bd,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,6CAA6C;gBACnD,MAAM,EAAE,QAAQ;gBAChB,UAAU,EAAE;oBACV,aAAa;iBACd;gBACD,KAAK,EAAE;oBACL,iBAAiB,EAAE,gBAAgB;iBACpC;gBACD,OAAO,EAAE;oBACP,aAAa,EAAE,aAAa;iBAC7B;aACF,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;WAiBG;QACH,iCAA4B,GAAG,CAAC,EAC9B,gBAAgB,EAChB,aAAa,EA4Bd,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,yCAAyC;gBAC/C,MAAM,EAAE,QAAQ;gBAChB,KAAK,EAAE;oBACL,iBAAiB,EAAE,gBAAgB;iBACpC;gBACD,OAAO,EAAE;oBACP,aAAa,EAAE,aAAa;iBAC7B;aACF,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;WAUG;QACH,uBAAkB,GAAG,CAAC,EACpB,aAAa,EACb,aAAa,EAed,EAA4B,EAAE;YAC7B,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,6CAA6C;gBACnD,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,aAAa;iBACd;gBACD,OAAO,EAAE;oBACP,aAAa,EAAE,aAAa;iBAC7B;aACF,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,iDAAiD,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACvK,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;WAuBG;QACH,uBAAkB,GAAG,CAAC,EACpB,aAAa,EACb,wBAAwB,EAezB,EAAuC,EAAE;YACxC,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,6BAA6B;gBACnC,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,aAAa,EAAE,aAAa;oBAC5B,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,wBAAwB;aAC/B,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,iDAAiD,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACvK,CAAC,CAAC;IAcJ,CAAC;IAbW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CAAC,iDAAiD,EAAE,OAAC,CAAC,MAAM,CAAC;YACrG,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,4BAA4B,CAAC;SACjE,CAAC,CAAC,QAAQ,CAAC,iDAAiD,CAAC,CAAC,CAAC;QAChE,iDAAuB,CAAC,kBAAkB,CAAC,iDAAiD,EAAE,OAAC,CAAC,MAAM,CAAC;YACrG,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC;SACtD,CAAC,CAAC,QAAQ,CAAC,iDAAiD,CAAC,CAAC,CAAC;QAChE,iDAAuB,CAAC,YAAY,CAAC,CAAC,oDAAqC,CAAC,CAAC,CAAC;IAChF,CAAC;CACF;AA9OD,kDA8OC"}
|
|
@@ -2,106 +2,12 @@ import { CommonHttpService } from "../../core/CommonHttpService";
|
|
|
2
2
|
import { type SubmitIncidentsRequest, type SubmitIncidentsResponse, type OperationsWorkspaceIds, type SubmitOperationsWorkspacesRequest, type SubmitOperationsWorkspacesResponse } from "../models/operations";
|
|
3
3
|
/**
|
|
4
4
|
* APIs related to integrating Incident and Post-Incident Review (PIR) data with
|
|
5
|
-
* Jira Software.
|
|
6
|
-
* apps. To use these APIs you must have the Operations module in your app's
|
|
7
|
-
* descriptor. Read more about Jira Software modules
|
|
8
|
-
* [here](https://developer.atlassian.com/cloud/jira/software/about-jira-modules/).
|
|
5
|
+
* Jira Software.
|
|
9
6
|
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
* information
|
|
14
|
-
*
|
|
15
|
-
* Supplied incident information will be presented in the Incidents page in Jira
|
|
16
|
-
* Software, and as a link to any issues created via the Incidents Page.
|
|
17
|
-
*
|
|
18
|
-
* This module also provides actions, one which allows Jira to provide a direct
|
|
19
|
-
* link to the operations provider where the user can create a post-incident
|
|
20
|
-
* review and two which allow Jira to search for relevant workspaces and devops
|
|
21
|
-
* components.
|
|
22
|
-
*
|
|
23
|
-
* Note that the module key and name are not private and therefore should not
|
|
24
|
-
* contain any sensitive or personally identifiable information.
|
|
25
|
-
*
|
|
26
|
-
* ## Example Module
|
|
27
|
-
*
|
|
28
|
-
* An example can also be found at
|
|
29
|
-
* [jira-data-provider-sample-addon](https://bitbucket.org/atlassianlabs/jira-data-provider-sample-addon/src/master/),
|
|
30
|
-
* which has an `atlassian-connect.json`.
|
|
31
|
-
*
|
|
32
|
-
* ```
|
|
33
|
-
* {
|
|
34
|
-
* "modules": {
|
|
35
|
-
* "jiraOperationsInfoProvider": {
|
|
36
|
-
* "homeUrl": "https://my-operations-provider.com",
|
|
37
|
-
* "logoUrl": "https://my-operations-provider.com/images/logo.svg",
|
|
38
|
-
* "documentationUrl":
|
|
39
|
-
* "https://my-operations-provider.com/docs/jira-integration",
|
|
40
|
-
* "actions": {
|
|
41
|
-
* "fetchWorkspaces": {
|
|
42
|
-
* "templateUrl": "/workspaces/list"
|
|
43
|
-
* },
|
|
44
|
-
* "searchContainers": {
|
|
45
|
-
* "templateUrl": "/containers/search"
|
|
46
|
-
* },
|
|
47
|
-
* "createPostIncidentReview": {
|
|
48
|
-
* "url":
|
|
49
|
-
* "https://my-operations-provider.com/my-workspace/create-post-incident-review?affected-component={component-id}&incident={incident-id}
|
|
50
|
-
* }
|
|
51
|
-
* },
|
|
52
|
-
* "name": {
|
|
53
|
-
* "value": "My Operations Provider"
|
|
54
|
-
* },
|
|
55
|
-
* "key": "operations-integration"
|
|
56
|
-
* }
|
|
57
|
-
* }
|
|
58
|
-
* }
|
|
59
|
-
* ```
|
|
60
|
-
*
|
|
61
|
-
* ### Properties
|
|
62
|
-
*
|
|
63
|
-
* | Property | type | Description
|
|
64
|
-
*
|
|
65
|
-
* | Required |
|
|
66
|
-
* |------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------|----------|
|
|
67
|
-
* | key | string | A key to identify this module. Must match
|
|
68
|
-
* `^[a-zA-Z0-9-]+$` pattern, with a max length of 100
|
|
69
|
-
* | Yes |
|
|
70
|
-
* | name | object (i18N) | A human readable name. This object
|
|
71
|
-
* supports
|
|
72
|
-
* [internationalization](https://developer.atlassian.com/cloud/jira/software/internationalization/).
|
|
73
|
-
* | Yes |
|
|
74
|
-
* | homeUrl | string | URL to the provider’s homepage
|
|
75
|
-
*
|
|
76
|
-
* | Yes |
|
|
77
|
-
* | logoUrl | string | Optional URL to the provider’s logo, which
|
|
78
|
-
* will be displayed in the UI
|
|
79
|
-
* | |
|
|
80
|
-
* | documentationUrl | string | Optional URL to documentation about the
|
|
81
|
-
* provider’s Jira integration
|
|
82
|
-
* | |
|
|
83
|
-
* | actions | object | Actions the can be used by Jira to improve
|
|
84
|
-
* the integrated experience
|
|
85
|
-
* | Yes |
|
|
86
|
-
*
|
|
87
|
-
* ### Actions object
|
|
88
|
-
*
|
|
89
|
-
* | Property | type | Description
|
|
90
|
-
*
|
|
91
|
-
* | Required |
|
|
92
|
-
* |------------------------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
|
|
93
|
-
* | fetchWorkspaces | object | An action defined by the provider to allow Jira to
|
|
94
|
-
* retrieve details about operations workspaces via a post endpoint.
|
|
95
|
-
*
|
|
96
|
-
* | Yes |
|
|
97
|
-
* | searchContainers | object | An action defined by the provider to allow Jira
|
|
98
|
-
* to search using details about devops components via a get endpoint.
|
|
99
|
-
*
|
|
100
|
-
* | Yes |
|
|
101
|
-
* | createPostIncidentReview | object | An action defined by the provider to
|
|
102
|
-
* allow Jira to create a new Post-Incident Review object via a post endpoint.
|
|
103
|
-
*
|
|
104
|
-
* | |
|
|
7
|
+
* These APIs are available to Atlassian Connect apps. To use these APIs you must
|
|
8
|
+
* have the `jiraOperationsInfoProvider` module in your Connect app's descriptor.
|
|
9
|
+
* See
|
|
10
|
+
* https://developer.atlassian.com/cloud/jira/software/modules/operations-information/.
|
|
105
11
|
*
|
|
106
12
|
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-operations
|
|
107
13
|
* @category Services
|
|
@@ -11,106 +11,12 @@ const validationSchemaStorage_1 = require("../validationSchemaStorage");
|
|
|
11
11
|
const zod_1 = require("zod");
|
|
12
12
|
/**
|
|
13
13
|
* APIs related to integrating Incident and Post-Incident Review (PIR) data with
|
|
14
|
-
* Jira Software.
|
|
15
|
-
* apps. To use these APIs you must have the Operations module in your app's
|
|
16
|
-
* descriptor. Read more about Jira Software modules
|
|
17
|
-
* [here](https://developer.atlassian.com/cloud/jira/software/about-jira-modules/).
|
|
14
|
+
* Jira Software.
|
|
18
15
|
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
* information
|
|
23
|
-
*
|
|
24
|
-
* Supplied incident information will be presented in the Incidents page in Jira
|
|
25
|
-
* Software, and as a link to any issues created via the Incidents Page.
|
|
26
|
-
*
|
|
27
|
-
* This module also provides actions, one which allows Jira to provide a direct
|
|
28
|
-
* link to the operations provider where the user can create a post-incident
|
|
29
|
-
* review and two which allow Jira to search for relevant workspaces and devops
|
|
30
|
-
* components.
|
|
31
|
-
*
|
|
32
|
-
* Note that the module key and name are not private and therefore should not
|
|
33
|
-
* contain any sensitive or personally identifiable information.
|
|
34
|
-
*
|
|
35
|
-
* ## Example Module
|
|
36
|
-
*
|
|
37
|
-
* An example can also be found at
|
|
38
|
-
* [jira-data-provider-sample-addon](https://bitbucket.org/atlassianlabs/jira-data-provider-sample-addon/src/master/),
|
|
39
|
-
* which has an `atlassian-connect.json`.
|
|
40
|
-
*
|
|
41
|
-
* ```
|
|
42
|
-
* {
|
|
43
|
-
* "modules": {
|
|
44
|
-
* "jiraOperationsInfoProvider": {
|
|
45
|
-
* "homeUrl": "https://my-operations-provider.com",
|
|
46
|
-
* "logoUrl": "https://my-operations-provider.com/images/logo.svg",
|
|
47
|
-
* "documentationUrl":
|
|
48
|
-
* "https://my-operations-provider.com/docs/jira-integration",
|
|
49
|
-
* "actions": {
|
|
50
|
-
* "fetchWorkspaces": {
|
|
51
|
-
* "templateUrl": "/workspaces/list"
|
|
52
|
-
* },
|
|
53
|
-
* "searchContainers": {
|
|
54
|
-
* "templateUrl": "/containers/search"
|
|
55
|
-
* },
|
|
56
|
-
* "createPostIncidentReview": {
|
|
57
|
-
* "url":
|
|
58
|
-
* "https://my-operations-provider.com/my-workspace/create-post-incident-review?affected-component={component-id}&incident={incident-id}
|
|
59
|
-
* }
|
|
60
|
-
* },
|
|
61
|
-
* "name": {
|
|
62
|
-
* "value": "My Operations Provider"
|
|
63
|
-
* },
|
|
64
|
-
* "key": "operations-integration"
|
|
65
|
-
* }
|
|
66
|
-
* }
|
|
67
|
-
* }
|
|
68
|
-
* ```
|
|
69
|
-
*
|
|
70
|
-
* ### Properties
|
|
71
|
-
*
|
|
72
|
-
* | Property | type | Description
|
|
73
|
-
*
|
|
74
|
-
* | Required |
|
|
75
|
-
* |------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------|----------|
|
|
76
|
-
* | key | string | A key to identify this module. Must match
|
|
77
|
-
* `^[a-zA-Z0-9-]+$` pattern, with a max length of 100
|
|
78
|
-
* | Yes |
|
|
79
|
-
* | name | object (i18N) | A human readable name. This object
|
|
80
|
-
* supports
|
|
81
|
-
* [internationalization](https://developer.atlassian.com/cloud/jira/software/internationalization/).
|
|
82
|
-
* | Yes |
|
|
83
|
-
* | homeUrl | string | URL to the provider’s homepage
|
|
84
|
-
*
|
|
85
|
-
* | Yes |
|
|
86
|
-
* | logoUrl | string | Optional URL to the provider’s logo, which
|
|
87
|
-
* will be displayed in the UI
|
|
88
|
-
* | |
|
|
89
|
-
* | documentationUrl | string | Optional URL to documentation about the
|
|
90
|
-
* provider’s Jira integration
|
|
91
|
-
* | |
|
|
92
|
-
* | actions | object | Actions the can be used by Jira to improve
|
|
93
|
-
* the integrated experience
|
|
94
|
-
* | Yes |
|
|
95
|
-
*
|
|
96
|
-
* ### Actions object
|
|
97
|
-
*
|
|
98
|
-
* | Property | type | Description
|
|
99
|
-
*
|
|
100
|
-
* | Required |
|
|
101
|
-
* |------------------------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
|
|
102
|
-
* | fetchWorkspaces | object | An action defined by the provider to allow Jira to
|
|
103
|
-
* retrieve details about operations workspaces via a post endpoint.
|
|
104
|
-
*
|
|
105
|
-
* | Yes |
|
|
106
|
-
* | searchContainers | object | An action defined by the provider to allow Jira
|
|
107
|
-
* to search using details about devops components via a get endpoint.
|
|
108
|
-
*
|
|
109
|
-
* | Yes |
|
|
110
|
-
* | createPostIncidentReview | object | An action defined by the provider to
|
|
111
|
-
* allow Jira to create a new Post-Incident Review object via a post endpoint.
|
|
112
|
-
*
|
|
113
|
-
* | |
|
|
16
|
+
* These APIs are available to Atlassian Connect apps. To use these APIs you must
|
|
17
|
+
* have the `jiraOperationsInfoProvider` module in your Connect app's descriptor.
|
|
18
|
+
* See
|
|
19
|
+
* https://developer.atlassian.com/cloud/jira/software/modules/operations-information/.
|
|
114
20
|
*
|
|
115
21
|
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-operations
|
|
116
22
|
* @category Services
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OperationsService.js","sourceRoot":"","sources":["../../../../src/openapi/software/services/OperationsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,gEAAgE;AAChE,oEAAiE;AACjE,qDAAoP;AACpP,wEAAqE;AACrE,6BAAwB;AACxB
|
|
1
|
+
{"version":3,"file":"OperationsService.js","sourceRoot":"","sources":["../../../../src/openapi/software/services/OperationsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,gEAAgE;AAChE,oEAAiE;AACjE,qDAAoP;AACpP,wEAAqE;AACrE,6BAAwB;AACxB;;;;;;;;;;;GAWG;AACH,MAAa,iBAAkB,SAAQ,qCAAiB;IAAxD;;QACE;;;;;;;;;;;;;;;;;;;;WAoBG;QACH,2BAAsB,GAAG,CAAC,EACxB,aAAa,EAad,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,uCAAuC;gBAC7C,MAAM,EAAE,QAAQ;gBAChB,OAAO,EAAE;oBACP,aAAa,EAAE,aAAa;iBAC7B;aACF,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;;;WAaG;QACH,uBAAkB,GAAG,CAAC,EACpB,UAAU,EACV,aAAa,EAed,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,6CAA6C;gBACnD,MAAM,EAAE,QAAQ;gBAChB,UAAU,EAAE;oBACV,UAAU;iBACX;gBACD,OAAO,EAAE;oBACP,aAAa,EAAE,aAAa;iBAC7B;aACF,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;;;WAaG;QACH,qBAAgB,GAAG,CAAC,EAClB,QAAQ,EACR,aAAa,EAed,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,uDAAuD;gBAC7D,MAAM,EAAE,QAAQ;gBAChB,UAAU,EAAE;oBACV,QAAQ;iBACT;gBACD,OAAO,EAAE;oBACP,aAAa,EAAE,aAAa;iBAC7B;aACF,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;;WAYG;QACH,qBAAgB,GAAG,CAAC,EAClB,aAAa,EAad,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,4CAA4C;gBAClD,MAAM,EAAE,QAAQ;gBAChB,OAAO,EAAE;oBACP,aAAa,EAAE,aAAa;iBAC7B;aACF,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;;;;WAcG;QACH,oBAAe,GAAG,CAAC,EACjB,UAAU,EACV,aAAa,EAed,EA+HE,EAAE;YACH,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,6CAA6C;gBACnD,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,UAAU;iBACX;gBACD,OAAO,EAAE;oBACP,aAAa,EAAE,aAAa;iBAC7B;aACF,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAsBlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,4CAA4C,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAClK,CAAC,CAAC;QACF;;;;;;;;;;;;;;WAcG;QACH,kBAAa,GAAG,CAAC,EACf,QAAQ,EACR,aAAa,EAed,EAwHE,EAAE;YACH,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,uDAAuD;gBAC7D,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,QAAQ;iBACT;gBACD,OAAO,EAAE;oBACP,aAAa,EAAE,aAAa;iBAC7B;aACF,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAqBlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,0CAA0C,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAChK,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;WAiBG;QACH,kBAAa,GAAG,CAAC,EACf,aAAa,EAad,EAAmC,EAAE;YACpC,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,uCAAuC;gBAC7C,MAAM,EAAE,KAAK;gBACb,OAAO,EAAE;oBACP,aAAa,EAAE,aAAa;iBAC7B;aACF,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,0CAA0C,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAChK,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA6BG;QACH,iBAAY,GAAG,CAAC,EACd,aAAa,EACb,sBAAsB,EAevB,EAAoC,EAAE;YACrC,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,2BAA2B;gBACjC,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,aAAa,EAAE,aAAa;oBAC5B,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,sBAAsB;aAC7B,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,yCAAyC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC/J,CAAC,CAAC;QACF;;;;;;;;;;;;;;WAcG;QACH,+BAA0B,GAAG,CAAC,EAC5B,aAAa,EACb,iCAAiC,EAelC,EAA+C,EAAE;YAChD,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,4CAA4C;gBAClD,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,aAAa,EAAE,aAAa;oBAC5B,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,iCAAiC;aACxC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,uDAAuD,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC7K,CAAC,CAAC;IA4DJ,CAAC;IA3DW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CAAC,yCAAyC,EAAE,OAAC,CAAC,MAAM,CAAC;YAC7F,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,yBAAyB,CAAC;SAC9D,CAAC,CAAC,QAAQ,CAAC,yCAAyC,CAAC,CAAC,CAAC;QACxD,iDAAuB,CAAC,kBAAkB,CAAC,4CAA4C,EAAE,OAAC,CAAC,MAAM,CAAC;YAChG,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,MAAM,CAAC;gBACb,aAAa,EAAE,OAAC,CAAC,OAAO,CAAC,KAAK,CAAC;gBAC/B,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;gBACvB,oBAAoB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;gBACtC,kBAAkB,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;gBACvD,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;gBAC5B,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC;gBACjC,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC;gBACzB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;gBACvB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;gBACvB,QAAQ,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;gBAChC,MAAM,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;gBAC/C,YAAY,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,CAAC;oBAC7B,eAAe,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,eAAe,EAAE,iBAAiB,EAAE,gCAAgC,CAAC,CAAC,CAAC,QAAQ,EAAE;oBAC1G,MAAM,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;iBACvC,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;aACrD,CAAC,CAAC,MAAM,EAAE;SACZ,CAAC,CAAC,QAAQ,CAAC,4CAA4C,CAAC,CAAC,CAAC;QAC3D,iDAAuB,CAAC,kBAAkB,CAAC,0CAA0C,EAAE,OAAC,CAAC,MAAM,CAAC;YAC9F,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,wBAAwB,CAAC;SAC7D,CAAC,CAAC,QAAQ,CAAC,0CAA0C,CAAC,CAAC,CAAC;QACzD,iDAAuB,CAAC,kBAAkB,CAAC,uDAAuD,EAAE,OAAC,CAAC,MAAM,CAAC;YAC3G,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,oCAAoC,CAAC;SACzE,CAAC,CAAC,QAAQ,CAAC,uDAAuD,CAAC,CAAC,CAAC;QACtE,iDAAuB,CAAC,kBAAkB,CAAC,0CAA0C,EAAE,OAAC,CAAC,MAAM,CAAC;YAC9F,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,MAAM,CAAC;gBACb,aAAa,EAAE,OAAC,CAAC,OAAO,CAAC,KAAK,CAAC;gBAC/B,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;gBACvB,oBAAoB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;gBACtC,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;gBAC5C,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;gBAC5B,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC;gBACjC,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC;gBACzB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;gBACvB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;gBACvB,MAAM,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,qBAAqB,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;gBAC9E,YAAY,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,CAAC;oBAC7B,eAAe,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,eAAe,EAAE,iBAAiB,EAAE,gCAAgC,CAAC,CAAC,CAAC,QAAQ,EAAE;oBAC1G,MAAM,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;iBACvC,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;aACrD,CAAC,CAAC,MAAM,EAAE;SACZ,CAAC,CAAC,QAAQ,CAAC,0CAA0C,CAAC,CAAC,CAAC;QACzD,iDAAuB,CAAC,YAAY,CAAC,CAAC,gDAAmC,CAAC,CAAC,CAAC;IAC9E,CAAC;CACF;AA1wBD,8CA0wBC"}
|
|
@@ -1,113 +1,16 @@
|
|
|
1
1
|
import { CommonHttpService } from "../../core/CommonHttpService";
|
|
2
|
-
import { type
|
|
2
|
+
import { type IssueIdOrKeysAssociation, type ServiceIdOrKeysAssociation } from "../models/common";
|
|
3
|
+
import { type SubmitRemoteLinksRequest, type RemoteLinkData } from "../models/remoteLinks";
|
|
3
4
|
/**
|
|
4
|
-
* APIs related to integrating
|
|
5
|
-
* are available to Atlassian Connect
|
|
6
|
-
* apps. To use these APIs you must have the Remote Link module in your app's
|
|
7
|
-
* descriptor. Read more about Jira Software modules
|
|
8
|
-
* [here](https://developer.atlassian.com/cloud/jira/software/about-jira-modules/).
|
|
5
|
+
* APIs related to integrating remote link data with Jira Software.
|
|
9
6
|
*
|
|
10
|
-
*
|
|
7
|
+
* These APIs are available to Atlassian Connect apps. To use these APIs you must
|
|
8
|
+
* have the `jiraRemoteLinkInfoProvider` module in your Connect app's descriptor.
|
|
9
|
+
* See https://developer.atlassian.com/cloud/jira/software/modules/remote-link/.
|
|
11
10
|
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
* Supplied remote link information will be presented in the right sidebar of the
|
|
16
|
-
* new Jira issue view under Releases.
|
|
17
|
-
*
|
|
18
|
-
* This module also provides actions, which allows users to perform an action on
|
|
19
|
-
* the remote link.
|
|
20
|
-
*
|
|
21
|
-
* Note that the module key and name are not private and should therefore not
|
|
22
|
-
* contain any sensitive or personally identifiable information.
|
|
23
|
-
*
|
|
24
|
-
* ## Example Module
|
|
25
|
-
*
|
|
26
|
-
* An example can also be found at
|
|
27
|
-
* [jira-data-provider-sample-addon](https://bitbucket.org/atlassianlabs/jira-data-provider-sample-addon/src/master/),
|
|
28
|
-
* which has an `atlassian-connect.json`.
|
|
29
|
-
*
|
|
30
|
-
* ```
|
|
31
|
-
* {
|
|
32
|
-
* "modules": {
|
|
33
|
-
* "jiraRemoteLinkInfoProvider": {
|
|
34
|
-
* "homeUrl": "https://my-remotelink-provider.com",
|
|
35
|
-
* "logoUrl": "https://my-remotelink-provider.com/images/logo.svg",
|
|
36
|
-
* "documentationUrl":
|
|
37
|
-
* "https://my-remotelink-provider.com/docs/jira-integration",
|
|
38
|
-
* "actions": [
|
|
39
|
-
* {
|
|
40
|
-
* "actionId": "action-1",
|
|
41
|
-
* "actionLabel": {
|
|
42
|
-
* "value": {
|
|
43
|
-
* "value": "Acknowledge"
|
|
44
|
-
* }
|
|
45
|
-
* },
|
|
46
|
-
* "templateUrl": "https://my-remotelink-provider.com/ack/{ack-id}"
|
|
47
|
-
* }
|
|
48
|
-
* ],
|
|
49
|
-
* "name": {
|
|
50
|
-
* "value": "My Remote Link Provider"
|
|
51
|
-
* },
|
|
52
|
-
* "key": "remotelink-integration"
|
|
53
|
-
* }
|
|
54
|
-
* }
|
|
55
|
-
* }
|
|
56
|
-
* ```
|
|
57
|
-
*
|
|
58
|
-
* ### Properties
|
|
59
|
-
*
|
|
60
|
-
* | Property | type | Description
|
|
61
|
-
*
|
|
62
|
-
* | Required |
|
|
63
|
-
* |------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------|----------|
|
|
64
|
-
* | key | string | A key to identify this module. Must match
|
|
65
|
-
* `^[a-zA-Z0-9-]+$` pattern, with a max length of 100
|
|
66
|
-
* | Yes |
|
|
67
|
-
* | name | object (i18N) | A human readable name. This object
|
|
68
|
-
* supports
|
|
69
|
-
* [internationalization](https://developer.atlassian.com/cloud/jira/software/internationalization/).
|
|
70
|
-
* | Yes |
|
|
71
|
-
* | homeUrl | string | URL to the provider’s homepage
|
|
72
|
-
*
|
|
73
|
-
* | Yes |
|
|
74
|
-
* | logoUrl | string | Optional URL to the provider’s logo, which
|
|
75
|
-
* will be displayed in the UI
|
|
76
|
-
* | |
|
|
77
|
-
* | documentationUrl | string | Optional URL to documentation about the
|
|
78
|
-
* provider’s Jira integration
|
|
79
|
-
* | |
|
|
80
|
-
* | actions | object | Optional actions that can be performed by
|
|
81
|
-
* Jira users on the remote link
|
|
82
|
-
*
|
|
83
|
-
* ### Actions object
|
|
84
|
-
*
|
|
85
|
-
* | Property | type | Description
|
|
86
|
-
*
|
|
87
|
-
* | Required |
|
|
88
|
-
* |-------------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
|
|
89
|
-
* | actionId | string | A key to identify a specific action. Used for
|
|
90
|
-
* associating a specific Remote link to an action of this ID. <br> The actionId
|
|
91
|
-
* of an action must be unique across all actions.
|
|
92
|
-
* | Yes |
|
|
93
|
-
* | actionLabel | object | The actionLabel of an Action is shown visibly to the
|
|
94
|
-
* User alongside the Remote Link.
|
|
95
|
-
*
|
|
96
|
-
* | Yes |
|
|
97
|
-
* | templateUrl | string | The templateUrl of an Action is a template where
|
|
98
|
-
* strings can be substituted into the URL for a specific Remote Link. <br>
|
|
99
|
-
* Strings used in the templateUrl must be passed in via an attribute map when
|
|
100
|
-
* associating an action with a remote link. | Yes |
|
|
101
|
-
*
|
|
102
|
-
* ### ActionLabel Object
|
|
103
|
-
*
|
|
104
|
-
* | Property | type | Description
|
|
105
|
-
*
|
|
106
|
-
* | Required |
|
|
107
|
-
* |----------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|----------|
|
|
108
|
-
* | value | object (i18n) | The label shown on the UI. This object supports
|
|
109
|
-
* [internationalization](https://developer.atlassian.com/cloud/jira/software/internationalization/).
|
|
110
|
-
* | Yes |
|
|
11
|
+
* These APIs are available to Forge apps with the `devops:remoteLinkInfoProvider`
|
|
12
|
+
* module in the Forge app's manifest. See
|
|
13
|
+
* https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-software-remote-link-info/.
|
|
111
14
|
*
|
|
112
15
|
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-remote-links
|
|
113
16
|
* @category Services
|
|
@@ -120,10 +23,6 @@ export declare class RemoteLinksService extends CommonHttpService {
|
|
|
120
23
|
* used to confirm that data has been
|
|
121
24
|
* deleted successfully (if needed).
|
|
122
25
|
*
|
|
123
|
-
* Only Connect apps that define the `jiraRemoteLinkInfoProvider` module, and
|
|
124
|
-
* on-premise integrations, can access this resource.
|
|
125
|
-
* This resource requires the 'DELETE' scope for Connect apps.
|
|
126
|
-
*
|
|
127
26
|
* @path DELETE `/rest/remotelinks/1.0/remotelink/{remoteLinkId}`
|
|
128
27
|
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-remote-links#api-rest-remotelinks-1-0-remotelink-remotelinkid-delete
|
|
129
28
|
* @param params
|
|
@@ -177,10 +76,6 @@ export declare class RemoteLinksService extends CommonHttpService {
|
|
|
177
76
|
* used to confirm that data has been
|
|
178
77
|
* deleted successfully (if needed).
|
|
179
78
|
*
|
|
180
|
-
* Only Connect apps that define the `jiraRemoteLinkInfoProvider` module, and
|
|
181
|
-
* on-premise integrations, can access this resource.
|
|
182
|
-
* This resource requires the 'DELETE' scope for Connect apps.
|
|
183
|
-
*
|
|
184
79
|
* @path DELETE `/rest/remotelinks/1.0/bulkByProperties`
|
|
185
80
|
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-remote-links#api-rest-remotelinks-1-0-bulkbyproperties-delete
|
|
186
81
|
* @param params
|
|
@@ -242,10 +137,6 @@ export declare class RemoteLinksService extends CommonHttpService {
|
|
|
242
137
|
* The result will be what is currently stored, ignoring any pending updates or
|
|
243
138
|
* deletes.
|
|
244
139
|
*
|
|
245
|
-
* Only Connect apps that define the `jiraRemoteLinkInfoProvider` module, and
|
|
246
|
-
* on-premise integrations, can access this resource.
|
|
247
|
-
* This resource requires the 'READ' scope for Connect apps.
|
|
248
|
-
*
|
|
249
140
|
* @returns The Remote Link data currently stored for the given ID.
|
|
250
141
|
* @path GET `/rest/remotelinks/1.0/remotelink/{remoteLinkId}`
|
|
251
142
|
* @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-remote-links#api-rest-remotelinks-1-0-remotelink-remotelinkid-get
|
|
@@ -289,10 +180,6 @@ export declare class RemoteLinksService extends CommonHttpService {
|
|
|
289
180
|
* submission. Details of which Remote LInk failed submission (if any) are
|
|
290
181
|
* available in the response object.
|
|
291
182
|
*
|
|
292
|
-
* Only Connect apps that define the `jiraRemoteLinkInfoProvider` module can
|
|
293
|
-
* access this resource. This resource
|
|
294
|
-
* requires the 'WRITE' scope for Connect apps.
|
|
295
|
-
*
|
|
296
183
|
* @returns Submission accepted. Each submitted Remote Link that is of a valid format will be eventually available in
|
|
297
184
|
* Jira.
|
|
298
185
|
*
|
|
@@ -369,7 +256,7 @@ export declare class RemoteLinksService extends CommonHttpService {
|
|
|
369
256
|
* Issue keys or services IDs or keys that are not known on this Jira instance (if
|
|
370
257
|
* any).
|
|
371
258
|
*/
|
|
372
|
-
unknownAssociations?: (
|
|
259
|
+
unknownAssociations?: (IssueIdOrKeysAssociation | ServiceIdOrKeysAssociation)[] | undefined;
|
|
373
260
|
} & {
|
|
374
261
|
[key: string]: unknown;
|
|
375
262
|
}>;
|