@tapis/tapis-typescript-systems 0.0.6 → 0.0.7
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 +3 -0
- package/.openapi-generator/VERSION +1 -1
- package/README.md +5 -4
- package/dist/apis/ChildSystemsApi.d.ts +10 -10
- package/dist/apis/ChildSystemsApi.js +84 -65
- package/dist/apis/CredentialsApi.d.ts +25 -24
- package/dist/apis/CredentialsApi.js +172 -138
- package/dist/apis/GeneralApi.d.ts +6 -6
- package/dist/apis/GeneralApi.js +18 -11
- package/dist/apis/PermissionsApi.d.ts +10 -10
- package/dist/apis/PermissionsApi.js +112 -89
- package/dist/apis/SchedulerProfilesApi.d.ts +10 -10
- package/dist/apis/SchedulerProfilesApi.js +95 -72
- package/dist/apis/SharingApi.d.ts +12 -12
- package/dist/apis/SharingApi.js +122 -95
- package/dist/apis/SystemsApi.d.ts +61 -46
- package/dist/apis/SystemsApi.js +473 -341
- package/dist/apis/index.js +21 -10
- package/dist/index.d.ts +2 -2
- package/dist/index.js +17 -6
- package/dist/models/AuthnEnum.d.ts +12 -9
- package/dist/models/AuthnEnum.js +28 -13
- package/dist/models/Capability.d.ts +9 -3
- package/dist/models/Capability.js +37 -22
- package/dist/models/CategoryEnum.d.ts +14 -12
- package/dist/models/CategoryEnum.js +30 -16
- package/dist/models/Credential.d.ts +26 -3
- package/dist/models/Credential.js +47 -33
- package/dist/models/DatatypeEnum.d.ts +11 -9
- package/dist/models/DatatypeEnum.js +27 -13
- package/dist/models/JobRuntime.d.ts +8 -3
- package/dist/models/JobRuntime.js +27 -17
- package/dist/models/KeyValueInputModeEnum.d.ts +10 -8
- package/dist/models/KeyValueInputModeEnum.js +26 -12
- package/dist/models/KeyValuePair.d.ts +8 -3
- package/dist/models/KeyValuePair.js +32 -22
- package/dist/models/ListTypeEnum.d.ts +9 -7
- package/dist/models/ListTypeEnum.js +25 -11
- package/dist/models/LogicalQueue.d.ts +13 -2
- package/dist/models/LogicalQueue.js +48 -34
- package/dist/models/ModuleLoadSpec.d.ts +7 -2
- package/dist/models/ModuleLoadSpec.js +25 -15
- package/dist/models/OperationTypeEnum.d.ts +20 -18
- package/dist/models/OperationTypeEnum.js +36 -22
- package/dist/models/ReqMatchConstraints.d.ts +7 -2
- package/dist/models/ReqMatchConstraints.js +23 -12
- package/dist/models/ReqPatchSystem.d.ts +13 -3
- package/dist/models/ReqPatchSystem.js +76 -63
- package/dist/models/ReqPerms.d.ts +7 -2
- package/dist/models/ReqPerms.js +23 -12
- package/dist/models/ReqPostChildSystem.d.ts +7 -2
- package/dist/models/ReqPostChildSystem.js +28 -16
- package/dist/models/ReqPostPutCredential.d.ts +7 -2
- package/dist/models/ReqPostPutCredential.js +36 -28
- package/dist/models/ReqPostSchedulerProfile.d.ts +9 -3
- package/dist/models/ReqPostSchedulerProfile.js +33 -22
- package/dist/models/ReqPostSystem.d.ts +15 -3
- package/dist/models/ReqPostSystem.js +101 -76
- package/dist/models/ReqPutSystem.d.ts +13 -3
- package/dist/models/ReqPutSystem.js +74 -61
- package/dist/models/ReqSearchSystems.d.ts +7 -2
- package/dist/models/ReqSearchSystems.js +23 -12
- package/dist/models/ReqShareUpdate.d.ts +7 -2
- package/dist/models/ReqShareUpdate.js +23 -12
- package/dist/models/ReqUnlinkChildren.d.ts +7 -2
- package/dist/models/ReqUnlinkChildren.js +22 -14
- package/dist/models/ReqUpdateCredential.d.ts +7 -2
- package/dist/models/ReqUpdateCredential.js +38 -30
- package/dist/models/RespBasic.d.ts +7 -2
- package/dist/models/RespBasic.js +34 -26
- package/dist/models/RespBoolean.d.ts +8 -3
- package/dist/models/RespBoolean.js +35 -27
- package/dist/models/RespChangeCount.d.ts +8 -3
- package/dist/models/RespChangeCount.js +35 -27
- package/dist/models/RespCredential.d.ts +8 -3
- package/dist/models/RespCredential.js +35 -27
- package/dist/models/RespGlobusAuthUrl.d.ts +8 -3
- package/dist/models/RespGlobusAuthUrl.js +35 -27
- package/dist/models/RespName.d.ts +69 -0
- package/dist/models/RespName.js +62 -0
- package/dist/models/RespNameArray.d.ts +8 -3
- package/dist/models/RespNameArray.js +35 -27
- package/dist/models/RespResourceUrl.d.ts +8 -3
- package/dist/models/RespResourceUrl.js +35 -27
- package/dist/models/RespSchedulerProfile.d.ts +8 -3
- package/dist/models/RespSchedulerProfile.js +35 -27
- package/dist/models/RespSchedulerProfiles.d.ts +8 -3
- package/dist/models/RespSchedulerProfiles.js +35 -27
- package/dist/models/RespShareInfo.d.ts +8 -3
- package/dist/models/RespShareInfo.js +35 -27
- package/dist/models/RespSystem.d.ts +8 -3
- package/dist/models/RespSystem.js +35 -27
- package/dist/models/RespSystemHistory.d.ts +8 -3
- package/dist/models/RespSystemHistory.js +35 -27
- package/dist/models/RespSystems.d.ts +9 -3
- package/dist/models/RespSystems.js +36 -27
- package/dist/models/RespSystemsMetadata.d.ts +7 -2
- package/dist/models/RespSystemsMetadata.js +32 -24
- package/dist/models/ResultBoolean.d.ts +7 -2
- package/dist/models/ResultBoolean.js +22 -14
- package/dist/models/ResultChangeCount.d.ts +7 -2
- package/dist/models/ResultChangeCount.js +22 -14
- package/dist/models/ResultGlobusAuthUrl.d.ts +7 -2
- package/dist/models/ResultGlobusAuthUrl.js +26 -18
- package/dist/models/ResultName.d.ts +32 -0
- package/dist/models/ResultName.js +49 -0
- package/dist/models/ResultNameArray.d.ts +7 -2
- package/dist/models/ResultNameArray.js +22 -14
- package/dist/models/ResultResourceUrl.d.ts +7 -2
- package/dist/models/ResultResourceUrl.js +22 -14
- package/dist/models/RuntimeTypeEnum.d.ts +9 -7
- package/dist/models/RuntimeTypeEnum.js +25 -11
- package/dist/models/SchedulerHiddenOptionEnum.d.ts +8 -5
- package/dist/models/SchedulerHiddenOptionEnum.js +24 -9
- package/dist/models/SchedulerProfile.d.ts +9 -3
- package/dist/models/SchedulerProfile.js +35 -24
- package/dist/models/SchedulerTypeEnum.d.ts +12 -10
- package/dist/models/SchedulerTypeEnum.js +28 -14
- package/dist/models/ShareInfo.d.ts +14 -2
- package/dist/models/ShareInfo.js +29 -13
- package/dist/models/SkShareRecord.d.ts +86 -0
- package/dist/models/SkShareRecord.js +67 -0
- package/dist/models/SystemHistory.d.ts +8 -3
- package/dist/models/SystemHistory.js +35 -27
- package/dist/models/SystemTypeEnum.d.ts +10 -8
- package/dist/models/SystemTypeEnum.js +26 -12
- package/dist/models/TapisSystem.d.ts +39 -21
- package/dist/models/TapisSystem.js +114 -97
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +68 -54
- package/dist/runtime.d.ts +79 -37
- package/dist/runtime.js +311 -169
- package/package.json +6 -2
- package/src/apis/ChildSystemsApi.ts +47 -33
- package/src/apis/CredentialsApi.ts +124 -75
- package/src/apis/GeneralApi.ts +9 -7
- package/src/apis/PermissionsApi.ts +80 -45
- package/src/apis/SchedulerProfilesApi.ts +40 -29
- package/src/apis/SharingApi.ts +64 -41
- package/src/apis/SystemsApi.ts +306 -189
- package/src/index.ts +2 -2
- package/src/models/AuthnEnum.ts +26 -8
- package/src/models/Capability.ts +37 -19
- package/src/models/CategoryEnum.ts +28 -11
- package/src/models/Credential.ts +67 -31
- package/src/models/DatatypeEnum.ts +25 -8
- package/src/models/JobRuntime.ts +27 -14
- package/src/models/KeyValueInputModeEnum.ts +24 -7
- package/src/models/KeyValuePair.ts +33 -20
- package/src/models/ListTypeEnum.ts +23 -6
- package/src/models/LogicalQueue.ts +50 -31
- package/src/models/ModuleLoadSpec.ts +22 -12
- package/src/models/OperationTypeEnum.ts +34 -17
- package/src/models/ReqMatchConstraints.ts +20 -10
- package/src/models/ReqPatchSystem.ts +96 -69
- package/src/models/ReqPerms.ts +20 -10
- package/src/models/ReqPostChildSystem.ts +24 -13
- package/src/models/ReqPostPutCredential.ts +34 -25
- package/src/models/ReqPostSchedulerProfile.ts +38 -24
- package/src/models/ReqPostSystem.ts +123 -85
- package/src/models/ReqPutSystem.ts +94 -67
- package/src/models/ReqSearchSystems.ts +20 -10
- package/src/models/ReqShareUpdate.ts +20 -10
- package/src/models/ReqUnlinkChildren.ts +20 -11
- package/src/models/ReqUpdateCredential.ts +36 -27
- package/src/models/RespBasic.ts +32 -23
- package/src/models/RespBoolean.ts +35 -25
- package/src/models/RespChangeCount.ts +35 -25
- package/src/models/RespCredential.ts +35 -25
- package/src/models/RespGlobusAuthUrl.ts +35 -25
- package/src/models/RespName.ts +121 -0
- package/src/models/RespNameArray.ts +35 -25
- package/src/models/RespResourceUrl.ts +35 -25
- package/src/models/RespSchedulerProfile.ts +35 -25
- package/src/models/RespSchedulerProfiles.ts +35 -25
- package/src/models/RespShareInfo.ts +35 -25
- package/src/models/RespSystem.ts +35 -25
- package/src/models/RespSystemHistory.ts +35 -25
- package/src/models/RespSystems.ts +42 -29
- package/src/models/RespSystemsMetadata.ts +30 -21
- package/src/models/ResultBoolean.ts +20 -11
- package/src/models/ResultChangeCount.ts +20 -11
- package/src/models/ResultGlobusAuthUrl.ts +24 -15
- package/src/models/ResultName.ts +65 -0
- package/src/models/ResultNameArray.ts +20 -11
- package/src/models/ResultResourceUrl.ts +20 -11
- package/src/models/RuntimeTypeEnum.ts +23 -6
- package/src/models/SchedulerHiddenOptionEnum.ts +22 -4
- package/src/models/SchedulerProfile.ts +40 -26
- package/src/models/SchedulerTypeEnum.ts +26 -9
- package/src/models/ShareInfo.ts +38 -11
- package/src/models/SkShareRecord.ts +137 -0
- package/src/models/SystemHistory.ts +37 -25
- package/src/models/SystemTypeEnum.ts +24 -7
- package/src/models/TapisSystem.ts +167 -126
- package/src/models/index.ts +3 -0
- package/src/runtime.ts +217 -106
package/dist/apis/SharingApi.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Tapis Systems API
|
|
6
6
|
* The Tapis Systems API provides for management of Tapis Systems including permissions, credentials and Scheduler Profiles.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document:
|
|
8
|
+
* The version of the OpenAPI document: 25Q4.2
|
|
9
9
|
* Contact: cicsupport@tacc.utexas.edu
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -13,30 +13,36 @@
|
|
|
13
13
|
* Do not edit the class manually.
|
|
14
14
|
*/
|
|
15
15
|
var __extends = (this && this.__extends) || (function () {
|
|
16
|
-
var extendStatics =
|
|
17
|
-
|
|
18
|
-
|
|
16
|
+
var extendStatics = function (d, b) {
|
|
17
|
+
extendStatics = Object.setPrototypeOf ||
|
|
18
|
+
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
19
|
+
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
20
|
+
return extendStatics(d, b);
|
|
21
|
+
};
|
|
19
22
|
return function (d, b) {
|
|
23
|
+
if (typeof b !== "function" && b !== null)
|
|
24
|
+
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
20
25
|
extendStatics(d, b);
|
|
21
26
|
function __() { this.constructor = d; }
|
|
22
27
|
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
23
28
|
};
|
|
24
29
|
})();
|
|
25
30
|
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
31
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
26
32
|
return new (P || (P = Promise))(function (resolve, reject) {
|
|
27
33
|
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
28
34
|
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
29
|
-
function step(result) { result.done ? resolve(result.value) :
|
|
35
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
30
36
|
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
31
37
|
});
|
|
32
38
|
};
|
|
33
39
|
var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
34
|
-
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
|
|
35
|
-
return g =
|
|
40
|
+
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
|
|
41
|
+
return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
|
|
36
42
|
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
37
43
|
function step(op) {
|
|
38
44
|
if (f) throw new TypeError("Generator is already executing.");
|
|
39
|
-
while (_) try {
|
|
45
|
+
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
40
46
|
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
|
|
41
47
|
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
42
48
|
switch (op[0]) {
|
|
@@ -58,8 +64,9 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
|
58
64
|
}
|
|
59
65
|
};
|
|
60
66
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
67
|
+
exports.SharingApi = void 0;
|
|
61
68
|
var runtime = require("../runtime");
|
|
62
|
-
var
|
|
69
|
+
var index_1 = require("../models/index");
|
|
63
70
|
/**
|
|
64
71
|
*
|
|
65
72
|
*/
|
|
@@ -74,27 +81,31 @@ var SharingApi = /** @class */ (function (_super) {
|
|
|
74
81
|
*/
|
|
75
82
|
SharingApi.prototype.getShareInfoRaw = function (requestParameters, initOverrides) {
|
|
76
83
|
return __awaiter(this, void 0, void 0, function () {
|
|
77
|
-
var queryParameters, headerParameters, response;
|
|
78
|
-
return __generator(this, function (
|
|
79
|
-
switch (
|
|
84
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
85
|
+
return __generator(this, function (_c) {
|
|
86
|
+
switch (_c.label) {
|
|
80
87
|
case 0:
|
|
81
|
-
if (requestParameters
|
|
82
|
-
throw new runtime.RequiredError('systemId', 'Required parameter
|
|
88
|
+
if (requestParameters['systemId'] == null) {
|
|
89
|
+
throw new runtime.RequiredError('systemId', 'Required parameter "systemId" was null or undefined when calling getShareInfo().');
|
|
83
90
|
}
|
|
84
91
|
queryParameters = {};
|
|
85
92
|
headerParameters = {};
|
|
86
|
-
if (this.configuration && this.configuration.apiKey)
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
return [4 /*yield*/, this.
|
|
90
|
-
path: "/v3/systems/share/{systemId}".replace("{" + "systemId" + "}", encodeURIComponent(String(requestParameters.systemId))),
|
|
91
|
-
method: 'GET',
|
|
92
|
-
headers: headerParameters,
|
|
93
|
-
query: queryParameters,
|
|
94
|
-
}, initOverrides)];
|
|
93
|
+
if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
|
|
94
|
+
_a = headerParameters;
|
|
95
|
+
_b = "X-Tapis-Token";
|
|
96
|
+
return [4 /*yield*/, this.configuration.apiKey("X-Tapis-Token")];
|
|
95
97
|
case 1:
|
|
96
|
-
|
|
97
|
-
|
|
98
|
+
_a[_b] = _c.sent(); // TapisJWT authentication
|
|
99
|
+
_c.label = 2;
|
|
100
|
+
case 2: return [4 /*yield*/, this.request({
|
|
101
|
+
path: "/v3/systems/share/{systemId}".replace("{".concat("systemId", "}"), encodeURIComponent(String(requestParameters['systemId']))),
|
|
102
|
+
method: 'GET',
|
|
103
|
+
headers: headerParameters,
|
|
104
|
+
query: queryParameters,
|
|
105
|
+
}, initOverrides)];
|
|
106
|
+
case 3:
|
|
107
|
+
response = _c.sent();
|
|
108
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.RespShareInfoFromJSON)(jsonValue); })];
|
|
98
109
|
}
|
|
99
110
|
});
|
|
100
111
|
});
|
|
@@ -123,32 +134,36 @@ var SharingApi = /** @class */ (function (_super) {
|
|
|
123
134
|
*/
|
|
124
135
|
SharingApi.prototype.shareSystemRaw = function (requestParameters, initOverrides) {
|
|
125
136
|
return __awaiter(this, void 0, void 0, function () {
|
|
126
|
-
var queryParameters, headerParameters, response;
|
|
127
|
-
return __generator(this, function (
|
|
128
|
-
switch (
|
|
137
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
138
|
+
return __generator(this, function (_c) {
|
|
139
|
+
switch (_c.label) {
|
|
129
140
|
case 0:
|
|
130
|
-
if (requestParameters
|
|
131
|
-
throw new runtime.RequiredError('systemId', 'Required parameter
|
|
141
|
+
if (requestParameters['systemId'] == null) {
|
|
142
|
+
throw new runtime.RequiredError('systemId', 'Required parameter "systemId" was null or undefined when calling shareSystem().');
|
|
132
143
|
}
|
|
133
|
-
if (requestParameters
|
|
134
|
-
throw new runtime.RequiredError('reqShareUpdate', 'Required parameter
|
|
144
|
+
if (requestParameters['reqShareUpdate'] == null) {
|
|
145
|
+
throw new runtime.RequiredError('reqShareUpdate', 'Required parameter "reqShareUpdate" was null or undefined when calling shareSystem().');
|
|
135
146
|
}
|
|
136
147
|
queryParameters = {};
|
|
137
148
|
headerParameters = {};
|
|
138
149
|
headerParameters['Content-Type'] = 'application/json';
|
|
139
|
-
if (this.configuration && this.configuration.apiKey)
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
return [4 /*yield*/, this.
|
|
143
|
-
path: "/v3/systems/share/{systemId}".replace("{" + "systemId" + "}", encodeURIComponent(String(requestParameters.systemId))),
|
|
144
|
-
method: 'POST',
|
|
145
|
-
headers: headerParameters,
|
|
146
|
-
query: queryParameters,
|
|
147
|
-
body: models_1.ReqShareUpdateToJSON(requestParameters.reqShareUpdate),
|
|
148
|
-
}, initOverrides)];
|
|
150
|
+
if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
|
|
151
|
+
_a = headerParameters;
|
|
152
|
+
_b = "X-Tapis-Token";
|
|
153
|
+
return [4 /*yield*/, this.configuration.apiKey("X-Tapis-Token")];
|
|
149
154
|
case 1:
|
|
150
|
-
|
|
151
|
-
|
|
155
|
+
_a[_b] = _c.sent(); // TapisJWT authentication
|
|
156
|
+
_c.label = 2;
|
|
157
|
+
case 2: return [4 /*yield*/, this.request({
|
|
158
|
+
path: "/v3/systems/share/{systemId}".replace("{".concat("systemId", "}"), encodeURIComponent(String(requestParameters['systemId']))),
|
|
159
|
+
method: 'POST',
|
|
160
|
+
headers: headerParameters,
|
|
161
|
+
query: queryParameters,
|
|
162
|
+
body: (0, index_1.ReqShareUpdateToJSON)(requestParameters['reqShareUpdate']),
|
|
163
|
+
}, initOverrides)];
|
|
164
|
+
case 3:
|
|
165
|
+
response = _c.sent();
|
|
166
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.RespBasicFromJSON)(jsonValue); })];
|
|
152
167
|
}
|
|
153
168
|
});
|
|
154
169
|
});
|
|
@@ -177,27 +192,31 @@ var SharingApi = /** @class */ (function (_super) {
|
|
|
177
192
|
*/
|
|
178
193
|
SharingApi.prototype.shareSystemPublicRaw = function (requestParameters, initOverrides) {
|
|
179
194
|
return __awaiter(this, void 0, void 0, function () {
|
|
180
|
-
var queryParameters, headerParameters, response;
|
|
181
|
-
return __generator(this, function (
|
|
182
|
-
switch (
|
|
195
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
196
|
+
return __generator(this, function (_c) {
|
|
197
|
+
switch (_c.label) {
|
|
183
198
|
case 0:
|
|
184
|
-
if (requestParameters
|
|
185
|
-
throw new runtime.RequiredError('systemId', 'Required parameter
|
|
199
|
+
if (requestParameters['systemId'] == null) {
|
|
200
|
+
throw new runtime.RequiredError('systemId', 'Required parameter "systemId" was null or undefined when calling shareSystemPublic().');
|
|
186
201
|
}
|
|
187
202
|
queryParameters = {};
|
|
188
203
|
headerParameters = {};
|
|
189
|
-
if (this.configuration && this.configuration.apiKey)
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
return [4 /*yield*/, this.
|
|
193
|
-
path: "/v3/systems/share_public/{systemId}".replace("{" + "systemId" + "}", encodeURIComponent(String(requestParameters.systemId))),
|
|
194
|
-
method: 'POST',
|
|
195
|
-
headers: headerParameters,
|
|
196
|
-
query: queryParameters,
|
|
197
|
-
}, initOverrides)];
|
|
204
|
+
if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
|
|
205
|
+
_a = headerParameters;
|
|
206
|
+
_b = "X-Tapis-Token";
|
|
207
|
+
return [4 /*yield*/, this.configuration.apiKey("X-Tapis-Token")];
|
|
198
208
|
case 1:
|
|
199
|
-
|
|
200
|
-
|
|
209
|
+
_a[_b] = _c.sent(); // TapisJWT authentication
|
|
210
|
+
_c.label = 2;
|
|
211
|
+
case 2: return [4 /*yield*/, this.request({
|
|
212
|
+
path: "/v3/systems/share_public/{systemId}".replace("{".concat("systemId", "}"), encodeURIComponent(String(requestParameters['systemId']))),
|
|
213
|
+
method: 'POST',
|
|
214
|
+
headers: headerParameters,
|
|
215
|
+
query: queryParameters,
|
|
216
|
+
}, initOverrides)];
|
|
217
|
+
case 3:
|
|
218
|
+
response = _c.sent();
|
|
219
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.RespBasicFromJSON)(jsonValue); })];
|
|
201
220
|
}
|
|
202
221
|
});
|
|
203
222
|
});
|
|
@@ -226,32 +245,36 @@ var SharingApi = /** @class */ (function (_super) {
|
|
|
226
245
|
*/
|
|
227
246
|
SharingApi.prototype.unShareSystemRaw = function (requestParameters, initOverrides) {
|
|
228
247
|
return __awaiter(this, void 0, void 0, function () {
|
|
229
|
-
var queryParameters, headerParameters, response;
|
|
230
|
-
return __generator(this, function (
|
|
231
|
-
switch (
|
|
248
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
249
|
+
return __generator(this, function (_c) {
|
|
250
|
+
switch (_c.label) {
|
|
232
251
|
case 0:
|
|
233
|
-
if (requestParameters
|
|
234
|
-
throw new runtime.RequiredError('systemId', 'Required parameter
|
|
252
|
+
if (requestParameters['systemId'] == null) {
|
|
253
|
+
throw new runtime.RequiredError('systemId', 'Required parameter "systemId" was null or undefined when calling unShareSystem().');
|
|
235
254
|
}
|
|
236
|
-
if (requestParameters
|
|
237
|
-
throw new runtime.RequiredError('reqShareUpdate', 'Required parameter
|
|
255
|
+
if (requestParameters['reqShareUpdate'] == null) {
|
|
256
|
+
throw new runtime.RequiredError('reqShareUpdate', 'Required parameter "reqShareUpdate" was null or undefined when calling unShareSystem().');
|
|
238
257
|
}
|
|
239
258
|
queryParameters = {};
|
|
240
259
|
headerParameters = {};
|
|
241
260
|
headerParameters['Content-Type'] = 'application/json';
|
|
242
|
-
if (this.configuration && this.configuration.apiKey)
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
return [4 /*yield*/, this.
|
|
246
|
-
path: "/v3/systems/unshare/{systemId}".replace("{" + "systemId" + "}", encodeURIComponent(String(requestParameters.systemId))),
|
|
247
|
-
method: 'POST',
|
|
248
|
-
headers: headerParameters,
|
|
249
|
-
query: queryParameters,
|
|
250
|
-
body: models_1.ReqShareUpdateToJSON(requestParameters.reqShareUpdate),
|
|
251
|
-
}, initOverrides)];
|
|
261
|
+
if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
|
|
262
|
+
_a = headerParameters;
|
|
263
|
+
_b = "X-Tapis-Token";
|
|
264
|
+
return [4 /*yield*/, this.configuration.apiKey("X-Tapis-Token")];
|
|
252
265
|
case 1:
|
|
253
|
-
|
|
254
|
-
|
|
266
|
+
_a[_b] = _c.sent(); // TapisJWT authentication
|
|
267
|
+
_c.label = 2;
|
|
268
|
+
case 2: return [4 /*yield*/, this.request({
|
|
269
|
+
path: "/v3/systems/unshare/{systemId}".replace("{".concat("systemId", "}"), encodeURIComponent(String(requestParameters['systemId']))),
|
|
270
|
+
method: 'POST',
|
|
271
|
+
headers: headerParameters,
|
|
272
|
+
query: queryParameters,
|
|
273
|
+
body: (0, index_1.ReqShareUpdateToJSON)(requestParameters['reqShareUpdate']),
|
|
274
|
+
}, initOverrides)];
|
|
275
|
+
case 3:
|
|
276
|
+
response = _c.sent();
|
|
277
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.RespBasicFromJSON)(jsonValue); })];
|
|
255
278
|
}
|
|
256
279
|
});
|
|
257
280
|
});
|
|
@@ -280,27 +303,31 @@ var SharingApi = /** @class */ (function (_super) {
|
|
|
280
303
|
*/
|
|
281
304
|
SharingApi.prototype.unShareSystemPublicRaw = function (requestParameters, initOverrides) {
|
|
282
305
|
return __awaiter(this, void 0, void 0, function () {
|
|
283
|
-
var queryParameters, headerParameters, response;
|
|
284
|
-
return __generator(this, function (
|
|
285
|
-
switch (
|
|
306
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
307
|
+
return __generator(this, function (_c) {
|
|
308
|
+
switch (_c.label) {
|
|
286
309
|
case 0:
|
|
287
|
-
if (requestParameters
|
|
288
|
-
throw new runtime.RequiredError('systemId', 'Required parameter
|
|
310
|
+
if (requestParameters['systemId'] == null) {
|
|
311
|
+
throw new runtime.RequiredError('systemId', 'Required parameter "systemId" was null or undefined when calling unShareSystemPublic().');
|
|
289
312
|
}
|
|
290
313
|
queryParameters = {};
|
|
291
314
|
headerParameters = {};
|
|
292
|
-
if (this.configuration && this.configuration.apiKey)
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
return [4 /*yield*/, this.
|
|
296
|
-
path: "/v3/systems/unshare_public/{systemId}".replace("{" + "systemId" + "}", encodeURIComponent(String(requestParameters.systemId))),
|
|
297
|
-
method: 'POST',
|
|
298
|
-
headers: headerParameters,
|
|
299
|
-
query: queryParameters,
|
|
300
|
-
}, initOverrides)];
|
|
315
|
+
if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
|
|
316
|
+
_a = headerParameters;
|
|
317
|
+
_b = "X-Tapis-Token";
|
|
318
|
+
return [4 /*yield*/, this.configuration.apiKey("X-Tapis-Token")];
|
|
301
319
|
case 1:
|
|
302
|
-
|
|
303
|
-
|
|
320
|
+
_a[_b] = _c.sent(); // TapisJWT authentication
|
|
321
|
+
_c.label = 2;
|
|
322
|
+
case 2: return [4 /*yield*/, this.request({
|
|
323
|
+
path: "/v3/systems/unshare_public/{systemId}".replace("{".concat("systemId", "}"), encodeURIComponent(String(requestParameters['systemId']))),
|
|
324
|
+
method: 'POST',
|
|
325
|
+
headers: headerParameters,
|
|
326
|
+
query: queryParameters,
|
|
327
|
+
}, initOverrides)];
|
|
328
|
+
case 3:
|
|
329
|
+
response = _c.sent();
|
|
330
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.RespBasicFromJSON)(jsonValue); })];
|
|
304
331
|
}
|
|
305
332
|
});
|
|
306
333
|
});
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Tapis Systems API
|
|
3
3
|
* The Tapis Systems API provides for management of Tapis Systems including permissions, credentials and Scheduler Profiles.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 25Q4.2
|
|
6
6
|
* Contact: cicsupport@tacc.utexas.edu
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { ListTypeEnum, ReqMatchConstraints, ReqPatchSystem, ReqPostSystem, ReqPutSystem, ReqSearchSystems, RespBoolean, RespChangeCount, RespResourceUrl, RespSystem, RespSystemHistory, RespSystems } from '../models';
|
|
13
|
+
import type { ListTypeEnum, ReqMatchConstraints, ReqPatchSystem, ReqPostSystem, ReqPutSystem, ReqSearchSystems, RespBoolean, RespChangeCount, RespName, RespResourceUrl, RespSystem, RespSystemHistory, RespSystems } from '../models/index';
|
|
14
14
|
export interface ChangeSystemOwnerRequest {
|
|
15
15
|
systemId: string;
|
|
16
16
|
userName: string;
|
|
@@ -52,6 +52,11 @@ export interface GetSystemsRequest {
|
|
|
52
52
|
select?: string;
|
|
53
53
|
showDeleted?: boolean;
|
|
54
54
|
impersonationId?: string;
|
|
55
|
+
hasCredentials?: boolean;
|
|
56
|
+
}
|
|
57
|
+
export interface HostEvalRequest {
|
|
58
|
+
systemId: string;
|
|
59
|
+
envVarName: string;
|
|
55
60
|
}
|
|
56
61
|
export interface IsEnabledRequest {
|
|
57
62
|
systemId: string;
|
|
@@ -79,6 +84,7 @@ export interface SearchSystemsQueryParametersRequest {
|
|
|
79
84
|
startAfter?: string;
|
|
80
85
|
computeTotal?: boolean;
|
|
81
86
|
select?: string;
|
|
87
|
+
hasCredentials?: boolean;
|
|
82
88
|
}
|
|
83
89
|
export interface SearchSystemsRequestBodyRequest {
|
|
84
90
|
reqSearchSystems: ReqSearchSystems;
|
|
@@ -89,6 +95,7 @@ export interface SearchSystemsRequestBodyRequest {
|
|
|
89
95
|
startAfter?: string;
|
|
90
96
|
computeTotal?: boolean;
|
|
91
97
|
select?: string;
|
|
98
|
+
hasCredentials?: boolean;
|
|
92
99
|
}
|
|
93
100
|
export interface UndeleteSystemRequest {
|
|
94
101
|
systemId: string;
|
|
@@ -98,123 +105,131 @@ export interface UndeleteSystemRequest {
|
|
|
98
105
|
*/
|
|
99
106
|
export declare class SystemsApi extends runtime.BaseAPI {
|
|
100
107
|
/**
|
|
101
|
-
* Change owner of a system.
|
|
108
|
+
* Change owner of a system. Please note that existing permission grants and shares will remain. **WARNING** Note also that no credentials are deleted during this process. So, for example, after the change a system with a static *effectiveUserId* will retain the credentials and host access of the static *effectiveUser*.
|
|
102
109
|
*/
|
|
103
|
-
changeSystemOwnerRaw(requestParameters: ChangeSystemOwnerRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>>;
|
|
110
|
+
changeSystemOwnerRaw(requestParameters: ChangeSystemOwnerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespChangeCount>>;
|
|
104
111
|
/**
|
|
105
|
-
* Change owner of a system.
|
|
112
|
+
* Change owner of a system. Please note that existing permission grants and shares will remain. **WARNING** Note also that no credentials are deleted during this process. So, for example, after the change a system with a static *effectiveUserId* will retain the credentials and host access of the static *effectiveUser*.
|
|
106
113
|
*/
|
|
107
|
-
changeSystemOwner(requestParameters: ChangeSystemOwnerRequest, initOverrides?: RequestInit): Promise<RespChangeCount>;
|
|
114
|
+
changeSystemOwner(requestParameters: ChangeSystemOwnerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespChangeCount>;
|
|
108
115
|
/**
|
|
109
|
-
* Create a system using a request body. System name must be unique within a tenant and can be composed of alphanumeric characters and the following special characters [-._~]. Name must begin with an alphanumeric character and can be no more than 80 characters in length. Description is optional with a maximum length of 2048 characters. The attribute *host* represents a host name, IP address, Globus Endpoint Id or Globus Collection Id. The attribute *effectiveUserId* determines the host login user, the user used to access the underlying host. The attribute can be set to a static string indicating a specific user (such as a service account) or dynamically specified as *${apiUserId}*. For the case of *${apiUserId}*, the service resolves the variable by extracting the identity from the request to the service (i.e. the JWT) and applying a mapping to a host login user if such a mapping has been provided. If no mapping is provided, then the extracted identity is taken to be the host login user. If the *effectiveUserId* is static (i.e. not *${apiUserId}*) then credentials may optionally be provided in the *authnCredential* attribute of the request body. The Systems service does not store the secrets in its database, they are persisted in the Security Kernel. By default for LINUX and S3 type systems credentials provided are verified. Use query parameter skipCredentialCheck=true to bypass initial verification of credentials. The attribute *rootDir* serves as an effective root directory when operating on files through the Tapis Files service. All paths are relative to this directory when using Files to list, copy, move, mkdir, etc. Required for systems of type LINUX or IRODS. Supports the following variables which are resolved at create time: *${apiUserId}*, *${tenant}* and *${owner}*. May not be updated. Contact support to request a change. There is also a special macro available for *rootDir* that may be used under certain conditions when a system is first created. The macro name is HOST_EVAL. The syntax for the macro is HOST_EVAL($var), where *var* is the environment variable to be evaluated on the system host when the create request is made. Note that the $ character preceding the environment variable name is optional. If after resolution the final path does not have the required leading slash (/) to make it an absolute path, then one will be prepended. The following conditions must be met in order to use the macro
|
|
116
|
+
* Create a system using a request body. System name must be unique within a tenant and can be composed of alphanumeric characters and the following special characters [-._~]. Name must begin with an alphanumeric character and can be no more than 80 characters in length. Description is optional with a maximum length of 2048 characters. The attribute *host* represents a host name, IP address, Globus Endpoint Id or Globus Collection Id. The attribute *effectiveUserId* determines the host login user, the user used to access the underlying host. The attribute can be set to a static string indicating a specific user (such as a service account) or dynamically specified as *${apiUserId}*. For the case of *${apiUserId}*, the service resolves the variable by extracting the identity from the request to the service (i.e. the JWT) and applying a mapping to a host login user if such a mapping has been provided. If no mapping is provided, then the extracted identity is taken to be the host login user. If the *effectiveUserId* is static (i.e. not *${apiUserId}*) then credentials may optionally be provided in the *authnCredential* attribute of the request body. Please note that if there is a *loginUser* field in the credential request body, TAPIS will reject the request because the static effective user is always the login user. The Systems service does not store the secrets in its database, they are persisted in the Security Kernel. By default for LINUX and S3 type systems credentials provided are verified. Use query parameter skipCredentialCheck=true to bypass initial verification of credentials. The attribute *rootDir* serves as an effective root directory when operating on files through the Tapis Files service. All paths are relative to this directory when using Files to list, copy, move, mkdir, etc. Required for systems of type LINUX or IRODS. Supports the following variables which are resolved at create time: *${apiUserId}*, *${tenant}* and *${owner}*. May not be updated. Contact support to request a change. There is also a special macro available for *rootDir* that may be used under certain conditions when a system is first created. The macro name is HOST_EVAL. The syntax for the macro is HOST_EVAL($var), where *var* is the environment variable to be evaluated on the system host when the create request is made. Note that the $ character preceding the environment variable name is optional. If after resolution the final path does not have the required leading slash (/) to make it an absolute path, then one will be prepended. The following conditions must be met in order to use the macro - System must be of type LINUX - Credentials must be provided when system is created. - Macro HOST_EVAL() must only appear once and must be the first element of the path. Including a leading slash is optional. - The *effectiveUserId* for the system must be static. Note that *effectiveUserId* may be set to *${owner}*. Here are some examples - HOST_EVAL($SCRATCH) - HOST_EVAL($HOME) - /HOST_EVAL(MY_ROOT_DIR)/scratch - /HOST_EVAL($PROJECT_HOME)/projects/${tenant}/${owner} Note that certain attributes in the request body (such as tenant) are allowed but ignored so that the JSON result returned by a GET may be modified and used when making a POST request to create a system. The attributes that are allowed but ignored are - tenant - uuid - deleted - created - updated
|
|
110
117
|
*/
|
|
111
|
-
createSystemRaw(requestParameters: CreateSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespResourceUrl>>;
|
|
118
|
+
createSystemRaw(requestParameters: CreateSystemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespResourceUrl>>;
|
|
112
119
|
/**
|
|
113
|
-
* Create a system using a request body. System name must be unique within a tenant and can be composed of alphanumeric characters and the following special characters [-._~]. Name must begin with an alphanumeric character and can be no more than 80 characters in length. Description is optional with a maximum length of 2048 characters. The attribute *host* represents a host name, IP address, Globus Endpoint Id or Globus Collection Id. The attribute *effectiveUserId* determines the host login user, the user used to access the underlying host. The attribute can be set to a static string indicating a specific user (such as a service account) or dynamically specified as *${apiUserId}*. For the case of *${apiUserId}*, the service resolves the variable by extracting the identity from the request to the service (i.e. the JWT) and applying a mapping to a host login user if such a mapping has been provided. If no mapping is provided, then the extracted identity is taken to be the host login user. If the *effectiveUserId* is static (i.e. not *${apiUserId}*) then credentials may optionally be provided in the *authnCredential* attribute of the request body. The Systems service does not store the secrets in its database, they are persisted in the Security Kernel. By default for LINUX and S3 type systems credentials provided are verified. Use query parameter skipCredentialCheck=true to bypass initial verification of credentials. The attribute *rootDir* serves as an effective root directory when operating on files through the Tapis Files service. All paths are relative to this directory when using Files to list, copy, move, mkdir, etc. Required for systems of type LINUX or IRODS. Supports the following variables which are resolved at create time: *${apiUserId}*, *${tenant}* and *${owner}*. May not be updated. Contact support to request a change. There is also a special macro available for *rootDir* that may be used under certain conditions when a system is first created. The macro name is HOST_EVAL. The syntax for the macro is HOST_EVAL($var), where *var* is the environment variable to be evaluated on the system host when the create request is made. Note that the $ character preceding the environment variable name is optional. If after resolution the final path does not have the required leading slash (/) to make it an absolute path, then one will be prepended. The following conditions must be met in order to use the macro
|
|
120
|
+
* Create a system using a request body. System name must be unique within a tenant and can be composed of alphanumeric characters and the following special characters [-._~]. Name must begin with an alphanumeric character and can be no more than 80 characters in length. Description is optional with a maximum length of 2048 characters. The attribute *host* represents a host name, IP address, Globus Endpoint Id or Globus Collection Id. The attribute *effectiveUserId* determines the host login user, the user used to access the underlying host. The attribute can be set to a static string indicating a specific user (such as a service account) or dynamically specified as *${apiUserId}*. For the case of *${apiUserId}*, the service resolves the variable by extracting the identity from the request to the service (i.e. the JWT) and applying a mapping to a host login user if such a mapping has been provided. If no mapping is provided, then the extracted identity is taken to be the host login user. If the *effectiveUserId* is static (i.e. not *${apiUserId}*) then credentials may optionally be provided in the *authnCredential* attribute of the request body. Please note that if there is a *loginUser* field in the credential request body, TAPIS will reject the request because the static effective user is always the login user. The Systems service does not store the secrets in its database, they are persisted in the Security Kernel. By default for LINUX and S3 type systems credentials provided are verified. Use query parameter skipCredentialCheck=true to bypass initial verification of credentials. The attribute *rootDir* serves as an effective root directory when operating on files through the Tapis Files service. All paths are relative to this directory when using Files to list, copy, move, mkdir, etc. Required for systems of type LINUX or IRODS. Supports the following variables which are resolved at create time: *${apiUserId}*, *${tenant}* and *${owner}*. May not be updated. Contact support to request a change. There is also a special macro available for *rootDir* that may be used under certain conditions when a system is first created. The macro name is HOST_EVAL. The syntax for the macro is HOST_EVAL($var), where *var* is the environment variable to be evaluated on the system host when the create request is made. Note that the $ character preceding the environment variable name is optional. If after resolution the final path does not have the required leading slash (/) to make it an absolute path, then one will be prepended. The following conditions must be met in order to use the macro - System must be of type LINUX - Credentials must be provided when system is created. - Macro HOST_EVAL() must only appear once and must be the first element of the path. Including a leading slash is optional. - The *effectiveUserId* for the system must be static. Note that *effectiveUserId* may be set to *${owner}*. Here are some examples - HOST_EVAL($SCRATCH) - HOST_EVAL($HOME) - /HOST_EVAL(MY_ROOT_DIR)/scratch - /HOST_EVAL($PROJECT_HOME)/projects/${tenant}/${owner} Note that certain attributes in the request body (such as tenant) are allowed but ignored so that the JSON result returned by a GET may be modified and used when making a POST request to create a system. The attributes that are allowed but ignored are - tenant - uuid - deleted - created - updated
|
|
114
121
|
*/
|
|
115
|
-
createSystem(requestParameters: CreateSystemRequest, initOverrides?: RequestInit): Promise<RespResourceUrl>;
|
|
122
|
+
createSystem(requestParameters: CreateSystemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespResourceUrl>;
|
|
116
123
|
/**
|
|
117
124
|
* Mark a system as deleted. System will not appear in queries unless explicitly requested.
|
|
118
125
|
*/
|
|
119
|
-
deleteSystemRaw(requestParameters: DeleteSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>>;
|
|
126
|
+
deleteSystemRaw(requestParameters: DeleteSystemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespChangeCount>>;
|
|
120
127
|
/**
|
|
121
128
|
* Mark a system as deleted. System will not appear in queries unless explicitly requested.
|
|
122
129
|
*/
|
|
123
|
-
deleteSystem(requestParameters: DeleteSystemRequest, initOverrides?: RequestInit): Promise<RespChangeCount>;
|
|
130
|
+
deleteSystem(requestParameters: DeleteSystemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespChangeCount>;
|
|
124
131
|
/**
|
|
125
132
|
* Mark a system unavailable for use.
|
|
126
133
|
*/
|
|
127
|
-
disableSystemRaw(requestParameters: DisableSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>>;
|
|
134
|
+
disableSystemRaw(requestParameters: DisableSystemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespChangeCount>>;
|
|
128
135
|
/**
|
|
129
136
|
* Mark a system unavailable for use.
|
|
130
137
|
*/
|
|
131
|
-
disableSystem(requestParameters: DisableSystemRequest, initOverrides?: RequestInit): Promise<RespChangeCount>;
|
|
138
|
+
disableSystem(requestParameters: DisableSystemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespChangeCount>;
|
|
132
139
|
/**
|
|
133
140
|
* Mark a system available for use.
|
|
134
141
|
*/
|
|
135
|
-
enableSystemRaw(requestParameters: EnableSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>>;
|
|
142
|
+
enableSystemRaw(requestParameters: EnableSystemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespChangeCount>>;
|
|
136
143
|
/**
|
|
137
144
|
* Mark a system available for use.
|
|
138
145
|
*/
|
|
139
|
-
enableSystem(requestParameters: EnableSystemRequest, initOverrides?: RequestInit): Promise<RespChangeCount>;
|
|
146
|
+
enableSystem(requestParameters: EnableSystemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespChangeCount>;
|
|
140
147
|
/**
|
|
141
148
|
* Retrieve history of changes for a given systemId.
|
|
142
149
|
*/
|
|
143
|
-
getHistoryRaw(requestParameters: GetHistoryRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSystemHistory>>;
|
|
150
|
+
getHistoryRaw(requestParameters: GetHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespSystemHistory>>;
|
|
144
151
|
/**
|
|
145
152
|
* Retrieve history of changes for a given systemId.
|
|
146
153
|
*/
|
|
147
|
-
getHistory(requestParameters: GetHistoryRequest, initOverrides?: RequestInit): Promise<RespSystemHistory>;
|
|
154
|
+
getHistory(requestParameters: GetHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespSystemHistory>;
|
|
148
155
|
/**
|
|
149
156
|
* Retrieve information for a system given the system Id. Use query parameter *authnMethod* to override the default authentication method. Certain Tapis services or a tenant administrator may use the query parameter *impersonationId* to be used in place of the requesting Tapis user. Tapis will use this user Id when performing authorization and resolving the *effectiveUserId*. Certain Tapis services may use the query parameter *sharedAppCtx* to indicate that the request is in a shared application context.
|
|
150
157
|
*/
|
|
151
|
-
getSystemRaw(requestParameters: GetSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSystem>>;
|
|
158
|
+
getSystemRaw(requestParameters: GetSystemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespSystem>>;
|
|
152
159
|
/**
|
|
153
160
|
* Retrieve information for a system given the system Id. Use query parameter *authnMethod* to override the default authentication method. Certain Tapis services or a tenant administrator may use the query parameter *impersonationId* to be used in place of the requesting Tapis user. Tapis will use this user Id when performing authorization and resolving the *effectiveUserId*. Certain Tapis services may use the query parameter *sharedAppCtx* to indicate that the request is in a shared application context.
|
|
154
161
|
*/
|
|
155
|
-
getSystem(requestParameters: GetSystemRequest, initOverrides?: RequestInit): Promise<RespSystem>;
|
|
162
|
+
getSystem(requestParameters: GetSystemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespSystem>;
|
|
163
|
+
/**
|
|
164
|
+
* Retrieve list of systems. Use *listType*, *search* and *select* query parameters to limit results. Query parameter *listType* allows for filtering results based on authorization. Please note that using *ALL* may have a significant negative impact on performance. Options for *listType* are - *OWNED* Include only items owned by requester (Default). - *SHARED_PUBLIC* Include only items shared publicly. - *ALL* Include all items requester is authorized to view. Includes check for READ or MODIFY permission. May impact performance. Use *hasCredentials* boolean query parameter to limit results based on the presence or absence of registered credentials for a system. Filtering is based on registered credentials for the current *defaultAuthnMethod* of a system. Credentials for other authentication method types are ignored. For a dynamic *effectiveUserId* filtering is based on the Tapis user making the request. If the query parameter is absent then no filtering is done. Certain Tapis services or a tenant administrator may use the query parameter *impersonationId* to be used in place of the requesting Tapis user. Tapis will use this user Id when performing authorization and resolving the *effectiveUserId*.
|
|
165
|
+
*/
|
|
166
|
+
getSystemsRaw(requestParameters: GetSystemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespSystems>>;
|
|
167
|
+
/**
|
|
168
|
+
* Retrieve list of systems. Use *listType*, *search* and *select* query parameters to limit results. Query parameter *listType* allows for filtering results based on authorization. Please note that using *ALL* may have a significant negative impact on performance. Options for *listType* are - *OWNED* Include only items owned by requester (Default). - *SHARED_PUBLIC* Include only items shared publicly. - *ALL* Include all items requester is authorized to view. Includes check for READ or MODIFY permission. May impact performance. Use *hasCredentials* boolean query parameter to limit results based on the presence or absence of registered credentials for a system. Filtering is based on registered credentials for the current *defaultAuthnMethod* of a system. Credentials for other authentication method types are ignored. For a dynamic *effectiveUserId* filtering is based on the Tapis user making the request. If the query parameter is absent then no filtering is done. Certain Tapis services or a tenant administrator may use the query parameter *impersonationId* to be used in place of the requesting Tapis user. Tapis will use this user Id when performing authorization and resolving the *effectiveUserId*.
|
|
169
|
+
*/
|
|
170
|
+
getSystems(requestParameters?: GetSystemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespSystems>;
|
|
156
171
|
/**
|
|
157
|
-
*
|
|
172
|
+
* Resolve environment variable by connecting to host associated with system. Note that this is done for the current *effectiveUserId*. Appropriate valid credentials must have already been registered. The system must be of type LINUX. The provided *{envVarName}* must start with an alphabetic character or underscore followed by 0 or more alphanumeric characters or underscores.
|
|
158
173
|
*/
|
|
159
|
-
|
|
174
|
+
hostEvalRaw(requestParameters: HostEvalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespName>>;
|
|
160
175
|
/**
|
|
161
|
-
*
|
|
176
|
+
* Resolve environment variable by connecting to host associated with system. Note that this is done for the current *effectiveUserId*. Appropriate valid credentials must have already been registered. The system must be of type LINUX. The provided *{envVarName}* must start with an alphabetic character or underscore followed by 0 or more alphanumeric characters or underscores.
|
|
162
177
|
*/
|
|
163
|
-
|
|
178
|
+
hostEval(requestParameters: HostEvalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespName>;
|
|
164
179
|
/**
|
|
165
180
|
* Check if a system is currently enabled, i.e. available for use.
|
|
166
181
|
*/
|
|
167
|
-
isEnabledRaw(requestParameters: IsEnabledRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBoolean>>;
|
|
182
|
+
isEnabledRaw(requestParameters: IsEnabledRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespBoolean>>;
|
|
168
183
|
/**
|
|
169
184
|
* Check if a system is currently enabled, i.e. available for use.
|
|
170
185
|
*/
|
|
171
|
-
isEnabled(requestParameters: IsEnabledRequest, initOverrides?: RequestInit): Promise<RespBoolean>;
|
|
186
|
+
isEnabled(requestParameters: IsEnabledRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespBoolean>;
|
|
172
187
|
/**
|
|
173
|
-
*
|
|
188
|
+
* **WARNING** *Capability constraint matching is not yet supported.* Retrieve details for systems. Use request body to specify constraint conditions as an SQL-like WHERE clause.
|
|
174
189
|
*/
|
|
175
|
-
matchConstraintsRaw(requestParameters: MatchConstraintsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSystems>>;
|
|
190
|
+
matchConstraintsRaw(requestParameters: MatchConstraintsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespSystems>>;
|
|
176
191
|
/**
|
|
177
|
-
*
|
|
192
|
+
* **WARNING** *Capability constraint matching is not yet supported.* Retrieve details for systems. Use request body to specify constraint conditions as an SQL-like WHERE clause.
|
|
178
193
|
*/
|
|
179
|
-
matchConstraints(requestParameters: MatchConstraintsRequest, initOverrides?: RequestInit): Promise<RespSystems>;
|
|
194
|
+
matchConstraints(requestParameters: MatchConstraintsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespSystems>;
|
|
180
195
|
/**
|
|
181
196
|
* Update selected attributes of a system. Request body may only contain updatable attributes. System must exist. Attributes that may not be updated via PATCH are - id - systemType - owner - enabled - bucketName - rootDir - canExec Note that the attributes owner and enabled may be modified using other endpoints.
|
|
182
197
|
*/
|
|
183
|
-
patchSystemRaw(requestParameters: PatchSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespResourceUrl>>;
|
|
198
|
+
patchSystemRaw(requestParameters: PatchSystemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespResourceUrl>>;
|
|
184
199
|
/**
|
|
185
200
|
* Update selected attributes of a system. Request body may only contain updatable attributes. System must exist. Attributes that may not be updated via PATCH are - id - systemType - owner - enabled - bucketName - rootDir - canExec Note that the attributes owner and enabled may be modified using other endpoints.
|
|
186
201
|
*/
|
|
187
|
-
patchSystem(requestParameters: PatchSystemRequest, initOverrides?: RequestInit): Promise<RespResourceUrl>;
|
|
202
|
+
patchSystem(requestParameters: PatchSystemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespResourceUrl>;
|
|
188
203
|
/**
|
|
189
|
-
* Update all updatable attributes of a system using a request body identical to POST. System must exist. Note that certain attributes in the request body (such as tenant) are allowed but ignored so that the JSON result returned by a GET may be modified and used when making a PUT request to update a system. The attributes that are allowed but ignored for both PUT and POST are
|
|
204
|
+
* Update all updatable attributes of a system using a request body identical to POST. System must exist. Note that certain attributes in the request body (such as tenant) are allowed but ignored so that the JSON result returned by a GET may be modified and used when making a PUT request to update a system. The attributes that are allowed but ignored for both PUT and POST are - tenant - uuid - deleted - created - updated In addition for a PUT operation the following non-updatable attributes are allowed but ignored - id - systemType - owner - effectiveUserId - authnCredential - enabled - bucketName - rootDir - canExec Note that the attributes *owner*, *enabled* and *authnCredential* may be modified using other endpoints. Attribute *effectiveUserId* may be updated using the endpoint **patchSystem**.
|
|
190
205
|
*/
|
|
191
|
-
putSystemRaw(requestParameters: PutSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespResourceUrl>>;
|
|
206
|
+
putSystemRaw(requestParameters: PutSystemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespResourceUrl>>;
|
|
192
207
|
/**
|
|
193
|
-
* Update all updatable attributes of a system using a request body identical to POST. System must exist. Note that certain attributes in the request body (such as tenant) are allowed but ignored so that the JSON result returned by a GET may be modified and used when making a PUT request to update a system. The attributes that are allowed but ignored for both PUT and POST are
|
|
208
|
+
* Update all updatable attributes of a system using a request body identical to POST. System must exist. Note that certain attributes in the request body (such as tenant) are allowed but ignored so that the JSON result returned by a GET may be modified and used when making a PUT request to update a system. The attributes that are allowed but ignored for both PUT and POST are - tenant - uuid - deleted - created - updated In addition for a PUT operation the following non-updatable attributes are allowed but ignored - id - systemType - owner - effectiveUserId - authnCredential - enabled - bucketName - rootDir - canExec Note that the attributes *owner*, *enabled* and *authnCredential* may be modified using other endpoints. Attribute *effectiveUserId* may be updated using the endpoint **patchSystem**.
|
|
194
209
|
*/
|
|
195
|
-
putSystem(requestParameters: PutSystemRequest, initOverrides?: RequestInit): Promise<RespResourceUrl>;
|
|
210
|
+
putSystem(requestParameters: PutSystemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespResourceUrl>;
|
|
196
211
|
/**
|
|
197
|
-
* Retrieve details for systems. Use query parameters to specify search conditions. For example owner.eq=jdoe&port.gt=1024 Use *listType* and *select* query parameters to limit results. Query parameter *listType* allows for filtering results based on authorization. Options for *listType* are - *OWNED* Include only items owned by requester (Default) - *SHARED_PUBLIC* Include only items shared publicly - *ALL* Include all items requester is authorized to view. Includes check for READ or MODIFY permission.
|
|
212
|
+
* Retrieve details for systems. Use query parameters to specify search conditions. For example owner.eq=jdoe&port.gt=1024 Use *listType* and *select* query parameters to limit results. Query parameter *listType* allows for filtering results based on authorization. Please note that using *ALL* may have a significant negative impact on performance. Options for *listType* are - *OWNED* Include only items owned by requester (Default) - *SHARED_PUBLIC* Include only items shared publicly - *ALL* Include all items requester is authorized to view. Includes check for READ or MODIFY permission. May impact performance. Use *hasCredentials* boolean query parameter to limit results based on the presence or absence of registered credentials for a system. Filtering is based on registered credentials for the current *defaultAuthnMethod* of a system. Credentials for other authentication method types are ignored. For a dynamic *effectiveUserId* filtering is based on the Tapis user making the request. If the query parameter is absent then no filtering is done.
|
|
198
213
|
*/
|
|
199
|
-
searchSystemsQueryParametersRaw(requestParameters: SearchSystemsQueryParametersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSystems>>;
|
|
214
|
+
searchSystemsQueryParametersRaw(requestParameters: SearchSystemsQueryParametersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespSystems>>;
|
|
200
215
|
/**
|
|
201
|
-
* Retrieve details for systems. Use query parameters to specify search conditions. For example owner.eq=jdoe&port.gt=1024 Use *listType* and *select* query parameters to limit results. Query parameter *listType* allows for filtering results based on authorization. Options for *listType* are - *OWNED* Include only items owned by requester (Default) - *SHARED_PUBLIC* Include only items shared publicly - *ALL* Include all items requester is authorized to view. Includes check for READ or MODIFY permission.
|
|
216
|
+
* Retrieve details for systems. Use query parameters to specify search conditions. For example owner.eq=jdoe&port.gt=1024 Use *listType* and *select* query parameters to limit results. Query parameter *listType* allows for filtering results based on authorization. Please note that using *ALL* may have a significant negative impact on performance. Options for *listType* are - *OWNED* Include only items owned by requester (Default) - *SHARED_PUBLIC* Include only items shared publicly - *ALL* Include all items requester is authorized to view. Includes check for READ or MODIFY permission. May impact performance. Use *hasCredentials* boolean query parameter to limit results based on the presence or absence of registered credentials for a system. Filtering is based on registered credentials for the current *defaultAuthnMethod* of a system. Credentials for other authentication method types are ignored. For a dynamic *effectiveUserId* filtering is based on the Tapis user making the request. If the query parameter is absent then no filtering is done.
|
|
202
217
|
*/
|
|
203
|
-
searchSystemsQueryParameters(requestParameters
|
|
218
|
+
searchSystemsQueryParameters(requestParameters?: SearchSystemsQueryParametersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespSystems>;
|
|
204
219
|
/**
|
|
205
|
-
* Retrieve details for systems. Use request body to specify SQL-like search conditions. Use *listType* and *select* query parameters to limit results. Query parameter *listType* allows for filtering results based on authorization. Options for *listType* are - *OWNED* Include only items owned by requester (Default) - *SHARED_PUBLIC* Include only items shared publicly - *ALL* Include all items requester is authorized to view. Includes check for READ or MODIFY permission.
|
|
220
|
+
* Retrieve details for systems. Use request body to specify SQL-like search conditions. Use *listType* and *select* query parameters to limit results. Query parameter *listType* allows for filtering results based on authorization. Please note that using *ALL* may have a significant negative impact on performance. Options for *listType* are - *OWNED* Include only items owned by requester (Default) - *SHARED_PUBLIC* Include only items shared publicly - *ALL* Include all items requester is authorized to view. Includes check for READ or MODIFY permission. May impact performance. Use *hasCredentials* boolean query parameter to limit results based on the presence or absence of registered credentials for a system. Filtering is based on registered credentials for the current *defaultAuthnMethod* of a system. Credentials for other authentication method types are ignored. For a dynamic *effectiveUserId* filtering is based on the Tapis user making the request. If the query parameter is absent then no filtering is done.
|
|
206
221
|
*/
|
|
207
|
-
searchSystemsRequestBodyRaw(requestParameters: SearchSystemsRequestBodyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSystems>>;
|
|
222
|
+
searchSystemsRequestBodyRaw(requestParameters: SearchSystemsRequestBodyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespSystems>>;
|
|
208
223
|
/**
|
|
209
|
-
* Retrieve details for systems. Use request body to specify SQL-like search conditions. Use *listType* and *select* query parameters to limit results. Query parameter *listType* allows for filtering results based on authorization. Options for *listType* are - *OWNED* Include only items owned by requester (Default) - *SHARED_PUBLIC* Include only items shared publicly - *ALL* Include all items requester is authorized to view. Includes check for READ or MODIFY permission.
|
|
224
|
+
* Retrieve details for systems. Use request body to specify SQL-like search conditions. Use *listType* and *select* query parameters to limit results. Query parameter *listType* allows for filtering results based on authorization. Please note that using *ALL* may have a significant negative impact on performance. Options for *listType* are - *OWNED* Include only items owned by requester (Default) - *SHARED_PUBLIC* Include only items shared publicly - *ALL* Include all items requester is authorized to view. Includes check for READ or MODIFY permission. May impact performance. Use *hasCredentials* boolean query parameter to limit results based on the presence or absence of registered credentials for a system. Filtering is based on registered credentials for the current *defaultAuthnMethod* of a system. Credentials for other authentication method types are ignored. For a dynamic *effectiveUserId* filtering is based on the Tapis user making the request. If the query parameter is absent then no filtering is done.
|
|
210
225
|
*/
|
|
211
|
-
searchSystemsRequestBody(requestParameters: SearchSystemsRequestBodyRequest, initOverrides?: RequestInit): Promise<RespSystems>;
|
|
226
|
+
searchSystemsRequestBody(requestParameters: SearchSystemsRequestBodyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespSystems>;
|
|
212
227
|
/**
|
|
213
228
|
* Mark a system as not deleted. System will appear in queries.
|
|
214
229
|
*/
|
|
215
|
-
undeleteSystemRaw(requestParameters: UndeleteSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>>;
|
|
230
|
+
undeleteSystemRaw(requestParameters: UndeleteSystemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RespChangeCount>>;
|
|
216
231
|
/**
|
|
217
232
|
* Mark a system as not deleted. System will appear in queries.
|
|
218
233
|
*/
|
|
219
|
-
undeleteSystem(requestParameters: UndeleteSystemRequest, initOverrides?: RequestInit): Promise<RespChangeCount>;
|
|
234
|
+
undeleteSystem(requestParameters: UndeleteSystemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RespChangeCount>;
|
|
220
235
|
}
|