@tapis/tapis-typescript-systems 0.0.2 → 0.0.4

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.
Files changed (189) hide show
  1. package/.openapi-generator/FILES +19 -3
  2. package/README.md +2 -2
  3. package/dist/apis/ChildSystemsApi.d.ts +54 -0
  4. package/dist/apis/ChildSystemsApi.js +224 -0
  5. package/dist/apis/CredentialsApi.d.ts +51 -15
  6. package/dist/apis/CredentialsApi.js +170 -16
  7. package/dist/apis/GeneralApi.d.ts +5 -5
  8. package/dist/apis/GeneralApi.js +5 -11
  9. package/dist/apis/PermissionsApi.d.ts +3 -11
  10. package/dist/apis/PermissionsApi.js +3 -11
  11. package/dist/apis/SchedulerProfilesApi.d.ts +5 -13
  12. package/dist/apis/SchedulerProfilesApi.js +6 -14
  13. package/dist/apis/SharingApi.d.ts +85 -0
  14. package/dist/apis/SharingApi.js +328 -0
  15. package/dist/apis/SystemsApi.d.ts +36 -46
  16. package/dist/apis/SystemsApi.js +89 -49
  17. package/dist/apis/index.d.ts +2 -0
  18. package/dist/apis/index.js +2 -0
  19. package/dist/models/AuthnEnum.d.ts +2 -1
  20. package/dist/models/AuthnEnum.js +2 -1
  21. package/dist/models/Capability.d.ts +1 -1
  22. package/dist/models/Capability.js +1 -1
  23. package/dist/models/CategoryEnum.d.ts +1 -1
  24. package/dist/models/CategoryEnum.js +1 -1
  25. package/dist/models/Credential.d.ts +19 -1
  26. package/dist/models/Credential.js +7 -1
  27. package/dist/models/DatatypeEnum.d.ts +1 -1
  28. package/dist/models/DatatypeEnum.js +1 -1
  29. package/dist/models/JobRuntime.d.ts +1 -1
  30. package/dist/models/JobRuntime.js +1 -1
  31. package/dist/models/KeyValueInputModeEnum.d.ts +25 -0
  32. package/dist/models/KeyValueInputModeEnum.js +39 -0
  33. package/dist/models/KeyValuePair.d.ts +20 -1
  34. package/dist/models/KeyValuePair.js +8 -1
  35. package/dist/models/ListTypeEnum.d.ts +24 -0
  36. package/dist/models/ListTypeEnum.js +38 -0
  37. package/dist/models/LogicalQueue.d.ts +1 -1
  38. package/dist/models/LogicalQueue.js +1 -1
  39. package/dist/models/ModuleLoadSpec.d.ts +33 -0
  40. package/dist/models/ModuleLoadSpec.js +43 -0
  41. package/dist/models/OperationTypeEnum.d.ts +35 -0
  42. package/dist/models/OperationTypeEnum.js +49 -0
  43. package/dist/models/ReqMatchConstraints.d.ts +1 -1
  44. package/dist/models/ReqMatchConstraints.js +1 -1
  45. package/dist/models/ReqPatchSystem.d.ts +18 -18
  46. package/dist/models/ReqPatchSystem.js +7 -7
  47. package/dist/models/ReqPerms.d.ts +1 -1
  48. package/dist/models/ReqPerms.js +1 -1
  49. package/dist/models/ReqPostChildSystem.d.ts +39 -0
  50. package/dist/models/ReqPostChildSystem.js +45 -0
  51. package/dist/models/ReqPostPutCredential.d.ts +69 -0
  52. package/dist/models/{ReqCreateCredential.js → ReqPostPutCredential.js} +12 -8
  53. package/dist/models/ReqPostSchedulerProfile.d.ts +52 -0
  54. package/dist/models/{ReqCreateSchedulerProfile.js → ReqPostSchedulerProfile.js} +10 -12
  55. package/dist/models/ReqPostSystem.d.ts +220 -0
  56. package/dist/models/{ReqCreateSystem.js → ReqPostSystem.js} +16 -18
  57. package/dist/models/ReqPutSystem.d.ts +21 -21
  58. package/dist/models/ReqPutSystem.js +9 -9
  59. package/dist/models/ReqSearchSystems.d.ts +1 -1
  60. package/dist/models/ReqSearchSystems.js +1 -1
  61. package/dist/models/ReqShareUpdate.d.ts +27 -0
  62. package/dist/models/ReqShareUpdate.js +40 -0
  63. package/dist/models/ReqUnlinkChildren.d.ts +27 -0
  64. package/dist/models/ReqUnlinkChildren.js +41 -0
  65. package/dist/models/ReqUpdateCredential.d.ts +75 -0
  66. package/dist/models/ReqUpdateCredential.js +57 -0
  67. package/dist/models/RespBasic.d.ts +13 -1
  68. package/dist/models/RespBasic.js +5 -1
  69. package/dist/models/RespBoolean.d.ts +13 -1
  70. package/dist/models/RespBoolean.js +5 -1
  71. package/dist/models/RespChangeCount.d.ts +13 -1
  72. package/dist/models/RespChangeCount.js +5 -1
  73. package/dist/models/RespCredential.d.ts +13 -1
  74. package/dist/models/RespCredential.js +5 -1
  75. package/dist/models/RespGlobusAuthUrl.d.ts +64 -0
  76. package/dist/models/RespGlobusAuthUrl.js +54 -0
  77. package/dist/models/RespNameArray.d.ts +13 -1
  78. package/dist/models/RespNameArray.js +5 -1
  79. package/dist/models/RespResourceUrl.d.ts +13 -1
  80. package/dist/models/RespResourceUrl.js +5 -1
  81. package/dist/models/RespSchedulerProfile.d.ts +13 -1
  82. package/dist/models/RespSchedulerProfile.js +5 -1
  83. package/dist/models/RespSchedulerProfiles.d.ts +13 -1
  84. package/dist/models/RespSchedulerProfiles.js +5 -1
  85. package/dist/models/RespShareInfo.d.ts +64 -0
  86. package/dist/models/RespShareInfo.js +54 -0
  87. package/dist/models/RespSystem.d.ts +13 -1
  88. package/dist/models/RespSystem.js +5 -1
  89. package/dist/models/RespSystemHistory.d.ts +64 -0
  90. package/dist/models/RespSystemHistory.js +54 -0
  91. package/dist/models/RespSystems.d.ts +13 -1
  92. package/dist/models/RespSystems.js +5 -1
  93. package/dist/models/RespSystemsMetadata.d.ts +1 -1
  94. package/dist/models/RespSystemsMetadata.js +1 -1
  95. package/dist/models/ResultBoolean.d.ts +1 -1
  96. package/dist/models/ResultBoolean.js +1 -1
  97. package/dist/models/ResultChangeCount.d.ts +1 -1
  98. package/dist/models/ResultChangeCount.js +1 -1
  99. package/dist/models/ResultGlobusAuthUrl.d.ts +39 -0
  100. package/dist/models/ResultGlobusAuthUrl.js +45 -0
  101. package/dist/models/ResultNameArray.d.ts +1 -1
  102. package/dist/models/ResultNameArray.js +1 -1
  103. package/dist/models/ResultResourceUrl.d.ts +1 -1
  104. package/dist/models/ResultResourceUrl.js +1 -1
  105. package/dist/models/RuntimeTypeEnum.d.ts +3 -2
  106. package/dist/models/RuntimeTypeEnum.js +2 -1
  107. package/dist/models/SchedulerHiddenOptionEnum.d.ts +1 -1
  108. package/dist/models/SchedulerHiddenOptionEnum.js +1 -1
  109. package/dist/models/SchedulerProfile.d.ts +5 -11
  110. package/dist/models/SchedulerProfile.js +3 -5
  111. package/dist/models/SchedulerTypeEnum.d.ts +1 -1
  112. package/dist/models/SchedulerTypeEnum.js +1 -1
  113. package/dist/models/ShareInfo.d.ts +33 -0
  114. package/dist/models/ShareInfo.js +42 -0
  115. package/dist/models/SystemHistory.d.ts +64 -0
  116. package/dist/models/SystemHistory.js +54 -0
  117. package/dist/models/SystemTypeEnum.d.ts +2 -2
  118. package/dist/models/SystemTypeEnum.js +2 -2
  119. package/dist/models/TapisSystem.d.ts +38 -26
  120. package/dist/models/TapisSystem.js +15 -11
  121. package/dist/models/index.d.ts +17 -3
  122. package/dist/models/index.js +17 -3
  123. package/dist/runtime.d.ts +1 -1
  124. package/dist/runtime.js +1 -1
  125. package/package.json +1 -1
  126. package/src/apis/ChildSystemsApi.ts +171 -0
  127. package/src/apis/CredentialsApi.ts +160 -20
  128. package/src/apis/GeneralApi.ts +5 -13
  129. package/src/apis/PermissionsApi.ts +3 -11
  130. package/src/apis/SchedulerProfilesApi.ts +10 -18
  131. package/src/apis/SharingApi.ts +250 -0
  132. package/src/apis/SystemsApi.ts +106 -55
  133. package/src/apis/index.ts +2 -0
  134. package/src/models/AuthnEnum.ts +2 -1
  135. package/src/models/Capability.ts +1 -1
  136. package/src/models/CategoryEnum.ts +1 -1
  137. package/src/models/Credential.ts +25 -1
  138. package/src/models/DatatypeEnum.ts +1 -1
  139. package/src/models/JobRuntime.ts +1 -1
  140. package/src/models/KeyValueInputModeEnum.ts +38 -0
  141. package/src/models/KeyValuePair.ts +32 -1
  142. package/src/models/ListTypeEnum.ts +37 -0
  143. package/src/models/LogicalQueue.ts +1 -1
  144. package/src/models/ModuleLoadSpec.ts +64 -0
  145. package/src/models/OperationTypeEnum.ts +48 -0
  146. package/src/models/ReqMatchConstraints.ts +1 -1
  147. package/src/models/ReqPatchSystem.ts +24 -24
  148. package/src/models/ReqPerms.ts +1 -1
  149. package/src/models/ReqPostChildSystem.ts +72 -0
  150. package/src/models/{ReqCreateCredential.ts → ReqPostPutCredential.ts} +29 -13
  151. package/src/models/{ReqCreateSchedulerProfile.ts → ReqPostSchedulerProfile.ts} +21 -25
  152. package/src/models/{ReqCreateSystem.ts → ReqPostSystem.ts} +77 -85
  153. package/src/models/ReqPutSystem.ts +32 -32
  154. package/src/models/ReqSearchSystems.ts +1 -1
  155. package/src/models/ReqShareUpdate.ts +56 -0
  156. package/src/models/ReqUnlinkChildren.ts +56 -0
  157. package/src/models/ReqUpdateCredential.ts +120 -0
  158. package/src/models/RespBasic.ts +17 -1
  159. package/src/models/RespBoolean.ts +17 -1
  160. package/src/models/RespChangeCount.ts +17 -1
  161. package/src/models/RespCredential.ts +17 -1
  162. package/src/models/RespGlobusAuthUrl.ts +111 -0
  163. package/src/models/RespNameArray.ts +17 -1
  164. package/src/models/RespResourceUrl.ts +17 -1
  165. package/src/models/RespSchedulerProfile.ts +17 -1
  166. package/src/models/RespSchedulerProfiles.ts +17 -1
  167. package/src/models/RespShareInfo.ts +111 -0
  168. package/src/models/RespSystem.ts +17 -1
  169. package/src/models/RespSystemHistory.ts +111 -0
  170. package/src/models/RespSystems.ts +17 -1
  171. package/src/models/RespSystemsMetadata.ts +1 -1
  172. package/src/models/ResultBoolean.ts +1 -1
  173. package/src/models/ResultChangeCount.ts +1 -1
  174. package/src/models/ResultGlobusAuthUrl.ts +72 -0
  175. package/src/models/ResultNameArray.ts +1 -1
  176. package/src/models/ResultResourceUrl.ts +1 -1
  177. package/src/models/RuntimeTypeEnum.ts +3 -2
  178. package/src/models/SchedulerHiddenOptionEnum.ts +1 -1
  179. package/src/models/SchedulerProfile.ts +10 -14
  180. package/src/models/SchedulerTypeEnum.ts +1 -1
  181. package/src/models/ShareInfo.ts +64 -0
  182. package/src/models/SystemHistory.ts +111 -0
  183. package/src/models/SystemTypeEnum.ts +2 -2
  184. package/src/models/TapisSystem.ts +52 -36
  185. package/src/models/index.ts +17 -3
  186. package/src/runtime.ts +1 -1
  187. package/dist/models/ReqCreateCredential.d.ts +0 -57
  188. package/dist/models/ReqCreateSchedulerProfile.d.ts +0 -58
  189. package/dist/models/ReqCreateSystem.d.ts +0 -226
@@ -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: 1.0.0-rc1
8
+ * The version of the OpenAPI document: 1.6.3
9
9
  * Contact: cicsupport@tacc.utexas.edu
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -69,8 +69,60 @@ var CredentialsApi = /** @class */ (function (_super) {
69
69
  return _super !== null && _super.apply(this, arguments) || this;
70
70
  }
71
71
  /**
72
- * Create or update credentials in the Security Kernel for given system and *target user* using a request body. Requester must be owner of the system. Credentials for multiple authentication methods may be provided. Note that user making the request and *target user* may be different and frequently are different. By default any credentials provided for LINUX type systems are verified. Use query parameter skipCredentialCheck=true to bypass initial verification of credentials. Note that the attribute authnMethod is allowed but ignored so that the JSON result returned by a GET may be modified and used when making a POST to update credentials.
73
- * Create or update user credentials for a system and target user
72
+ * Check user credentials by connecting to the system host. Not supported for all system types. Currently supported for LINUX and S3 type systems. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then *{userName}* is interpreted as a Tapis user and a search is made for credentials associated with *{userName}*. If the *effectiveUserId* for the system is static (i.e. not *${apiUserId}*) then *{userName}* is interpreted as the login user to be used when accessing the host. Note that this would typically be the current *effectiveUserId* defined for the system, but that is not a requirement. This allows for registering and checking credentials for a login user prior to updating the system definition. Operation is allowed if requester is the system owner or a tenant administrator. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then the operation is allowed if *{userName}* is the Tapis user making the request. Desired authentication method may be specified using query parameter *authnMethod*. If not specified, then credentials for the system\'s default authentication method are verified.
73
+ */
74
+ CredentialsApi.prototype.checkUserCredentialRaw = function (requestParameters, initOverrides) {
75
+ return __awaiter(this, void 0, void 0, function () {
76
+ var queryParameters, headerParameters, response;
77
+ return __generator(this, function (_a) {
78
+ switch (_a.label) {
79
+ case 0:
80
+ if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
81
+ throw new runtime.RequiredError('systemId', 'Required parameter requestParameters.systemId was null or undefined when calling checkUserCredential.');
82
+ }
83
+ if (requestParameters.userName === null || requestParameters.userName === undefined) {
84
+ throw new runtime.RequiredError('userName', 'Required parameter requestParameters.userName was null or undefined when calling checkUserCredential.');
85
+ }
86
+ queryParameters = {};
87
+ if (requestParameters.authnMethod !== undefined) {
88
+ queryParameters['authnMethod'] = requestParameters.authnMethod;
89
+ }
90
+ headerParameters = {};
91
+ if (this.configuration && this.configuration.apiKey) {
92
+ headerParameters["X-Tapis-Token"] = this.configuration.apiKey("X-Tapis-Token"); // TapisJWT authentication
93
+ }
94
+ return [4 /*yield*/, this.request({
95
+ path: "/v3/systems/credential/{systemId}/user/{userName}/check".replace("{" + "systemId" + "}", encodeURIComponent(String(requestParameters.systemId))).replace("{" + "userName" + "}", encodeURIComponent(String(requestParameters.userName))),
96
+ method: 'POST',
97
+ headers: headerParameters,
98
+ query: queryParameters,
99
+ }, initOverrides)];
100
+ case 1:
101
+ response = _a.sent();
102
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return models_1.RespBasicFromJSON(jsonValue); })];
103
+ }
104
+ });
105
+ });
106
+ };
107
+ /**
108
+ * Check user credentials by connecting to the system host. Not supported for all system types. Currently supported for LINUX and S3 type systems. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then *{userName}* is interpreted as a Tapis user and a search is made for credentials associated with *{userName}*. If the *effectiveUserId* for the system is static (i.e. not *${apiUserId}*) then *{userName}* is interpreted as the login user to be used when accessing the host. Note that this would typically be the current *effectiveUserId* defined for the system, but that is not a requirement. This allows for registering and checking credentials for a login user prior to updating the system definition. Operation is allowed if requester is the system owner or a tenant administrator. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then the operation is allowed if *{userName}* is the Tapis user making the request. Desired authentication method may be specified using query parameter *authnMethod*. If not specified, then credentials for the system\'s default authentication method are verified.
109
+ */
110
+ CredentialsApi.prototype.checkUserCredential = function (requestParameters, initOverrides) {
111
+ return __awaiter(this, void 0, void 0, function () {
112
+ var response;
113
+ return __generator(this, function (_a) {
114
+ switch (_a.label) {
115
+ case 0: return [4 /*yield*/, this.checkUserCredentialRaw(requestParameters, initOverrides)];
116
+ case 1:
117
+ response = _a.sent();
118
+ return [4 /*yield*/, response.value()];
119
+ case 2: return [2 /*return*/, _a.sent()];
120
+ }
121
+ });
122
+ });
123
+ };
124
+ /**
125
+ * Create or update credentials in the Security Kernel for given system and target *userName* using a request body. Credentials for multiple authentication methods may be provided. Note that there is support for only one set of credentials per user per system. Updating credentials overwrites previously registered data. The Systems service does not store the secrets in its database, they are persisted in the Security Kernel. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then *{userName}* is interpreted as a Tapis user and the request body may contain the optional attribute *loginUser* which will be used to map the Tapis user to a username to be used when accessing the system. If the login user is not provided then there is no mapping and the Tapis user is always used when accessing the system. If the *effectiveUserId* for the system is static (i.e. not *${apiUserId}*) then *{userName}* is interpreted as the login user to be used when accessing the host. Operation is allowed if requester is the system owner or a tenant administrator. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then the operation is allowed if *{userName}* is the Tapis user making the request. By default credentials for LINUX and S3 type systems are verified. Use query parameter *skipCredentialCheck=true* to bypass initial credential validation.
74
126
  */
75
127
  CredentialsApi.prototype.createUserCredentialRaw = function (requestParameters, initOverrides) {
76
128
  return __awaiter(this, void 0, void 0, function () {
@@ -84,8 +136,8 @@ var CredentialsApi = /** @class */ (function (_super) {
84
136
  if (requestParameters.userName === null || requestParameters.userName === undefined) {
85
137
  throw new runtime.RequiredError('userName', 'Required parameter requestParameters.userName was null or undefined when calling createUserCredential.');
86
138
  }
87
- if (requestParameters.reqCreateCredential === null || requestParameters.reqCreateCredential === undefined) {
88
- throw new runtime.RequiredError('reqCreateCredential', 'Required parameter requestParameters.reqCreateCredential was null or undefined when calling createUserCredential.');
139
+ if (requestParameters.reqUpdateCredential === null || requestParameters.reqUpdateCredential === undefined) {
140
+ throw new runtime.RequiredError('reqUpdateCredential', 'Required parameter requestParameters.reqUpdateCredential was null or undefined when calling createUserCredential.');
89
141
  }
90
142
  queryParameters = {};
91
143
  if (requestParameters.skipCredentialCheck !== undefined) {
@@ -101,7 +153,7 @@ var CredentialsApi = /** @class */ (function (_super) {
101
153
  method: 'POST',
102
154
  headers: headerParameters,
103
155
  query: queryParameters,
104
- body: models_1.ReqCreateCredentialToJSON(requestParameters.reqCreateCredential),
156
+ body: models_1.ReqUpdateCredentialToJSON(requestParameters.reqUpdateCredential),
105
157
  }, initOverrides)];
106
158
  case 1:
107
159
  response = _a.sent();
@@ -111,8 +163,7 @@ var CredentialsApi = /** @class */ (function (_super) {
111
163
  });
112
164
  };
113
165
  /**
114
- * Create or update credentials in the Security Kernel for given system and *target user* using a request body. Requester must be owner of the system. Credentials for multiple authentication methods may be provided. Note that user making the request and *target user* may be different and frequently are different. By default any credentials provided for LINUX type systems are verified. Use query parameter skipCredentialCheck=true to bypass initial verification of credentials. Note that the attribute authnMethod is allowed but ignored so that the JSON result returned by a GET may be modified and used when making a POST to update credentials.
115
- * Create or update user credentials for a system and target user
166
+ * Create or update credentials in the Security Kernel for given system and target *userName* using a request body. Credentials for multiple authentication methods may be provided. Note that there is support for only one set of credentials per user per system. Updating credentials overwrites previously registered data. The Systems service does not store the secrets in its database, they are persisted in the Security Kernel. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then *{userName}* is interpreted as a Tapis user and the request body may contain the optional attribute *loginUser* which will be used to map the Tapis user to a username to be used when accessing the system. If the login user is not provided then there is no mapping and the Tapis user is always used when accessing the system. If the *effectiveUserId* for the system is static (i.e. not *${apiUserId}*) then *{userName}* is interpreted as the login user to be used when accessing the host. Operation is allowed if requester is the system owner or a tenant administrator. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then the operation is allowed if *{userName}* is the Tapis user making the request. By default credentials for LINUX and S3 type systems are verified. Use query parameter *skipCredentialCheck=true* to bypass initial credential validation.
116
167
  */
117
168
  CredentialsApi.prototype.createUserCredential = function (requestParameters, initOverrides) {
118
169
  return __awaiter(this, void 0, void 0, function () {
@@ -129,8 +180,114 @@ var CredentialsApi = /** @class */ (function (_super) {
129
180
  });
130
181
  };
131
182
  /**
132
- * Highly restricted. Only certain Tapis services authorized. Retrieve credentials for given system, *target user* and authentication method. Note that user making the request and *target user* may be different and frequently are different. Desired authentication method may be specified using query parameter authnMethod=<method>. If desired authentication method not specified then credentials for the system\'s default authentication method are returned. The result includes the field authnMethod indicating the authentication method associated with the returned credentials.
133
- * Retrieve user credentials for a system and target user
183
+ * Use a Globus *Native App Authorization Code* and a Tapis session Id to generate a pair of access and refresh tokens. The Systems service will use the Tapis Security Kernel to store the tokens for the given system and user. The session Id is a Tapis Id that is used to track the oauth2 flow that is started when a call to the getGlobusAuthUrl endpoint is made. The authorization code, as per Globus documentation, is valid for 10 minutes. Please note that the Tapis installation for your site must be configured by the site administrator to support systems of type GLOBUS.
184
+ * Use a Globus authorization code + Tapis session Id to generate tokens
185
+ */
186
+ CredentialsApi.prototype.generateGlobusTokensRaw = function (requestParameters, initOverrides) {
187
+ return __awaiter(this, void 0, void 0, function () {
188
+ var queryParameters, headerParameters, response;
189
+ return __generator(this, function (_a) {
190
+ switch (_a.label) {
191
+ case 0:
192
+ if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
193
+ throw new runtime.RequiredError('systemId', 'Required parameter requestParameters.systemId was null or undefined when calling generateGlobusTokens.');
194
+ }
195
+ if (requestParameters.userName === null || requestParameters.userName === undefined) {
196
+ throw new runtime.RequiredError('userName', 'Required parameter requestParameters.userName was null or undefined when calling generateGlobusTokens.');
197
+ }
198
+ if (requestParameters.authCode === null || requestParameters.authCode === undefined) {
199
+ throw new runtime.RequiredError('authCode', 'Required parameter requestParameters.authCode was null or undefined when calling generateGlobusTokens.');
200
+ }
201
+ if (requestParameters.sessionId === null || requestParameters.sessionId === undefined) {
202
+ throw new runtime.RequiredError('sessionId', 'Required parameter requestParameters.sessionId was null or undefined when calling generateGlobusTokens.');
203
+ }
204
+ queryParameters = {};
205
+ headerParameters = {};
206
+ if (this.configuration && this.configuration.apiKey) {
207
+ headerParameters["X-Tapis-Token"] = this.configuration.apiKey("X-Tapis-Token"); // TapisJWT authentication
208
+ }
209
+ return [4 /*yield*/, this.request({
210
+ path: "/v3/systems/credential/{systemId}/user/{userName}/globus/tokens/{authCode}/{sessionId}".replace("{" + "systemId" + "}", encodeURIComponent(String(requestParameters.systemId))).replace("{" + "userName" + "}", encodeURIComponent(String(requestParameters.userName))).replace("{" + "authCode" + "}", encodeURIComponent(String(requestParameters.authCode))).replace("{" + "sessionId" + "}", encodeURIComponent(String(requestParameters.sessionId))),
211
+ method: 'POST',
212
+ headers: headerParameters,
213
+ query: queryParameters,
214
+ }, initOverrides)];
215
+ case 1:
216
+ response = _a.sent();
217
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return models_1.RespBasicFromJSON(jsonValue); })];
218
+ }
219
+ });
220
+ });
221
+ };
222
+ /**
223
+ * Use a Globus *Native App Authorization Code* and a Tapis session Id to generate a pair of access and refresh tokens. The Systems service will use the Tapis Security Kernel to store the tokens for the given system and user. The session Id is a Tapis Id that is used to track the oauth2 flow that is started when a call to the getGlobusAuthUrl endpoint is made. The authorization code, as per Globus documentation, is valid for 10 minutes. Please note that the Tapis installation for your site must be configured by the site administrator to support systems of type GLOBUS.
224
+ * Use a Globus authorization code + Tapis session Id to generate tokens
225
+ */
226
+ CredentialsApi.prototype.generateGlobusTokens = function (requestParameters, initOverrides) {
227
+ return __awaiter(this, void 0, void 0, function () {
228
+ var response;
229
+ return __generator(this, function (_a) {
230
+ switch (_a.label) {
231
+ case 0: return [4 /*yield*/, this.generateGlobusTokensRaw(requestParameters, initOverrides)];
232
+ case 1:
233
+ response = _a.sent();
234
+ return [4 /*yield*/, response.value()];
235
+ case 2: return [2 /*return*/, _a.sent()];
236
+ }
237
+ });
238
+ });
239
+ };
240
+ /**
241
+ * Retrieve a Globus URL + Session Id that can be used to generate an oauth2 authorization code associated with the given system. In Globus, the code is referred to as a *Native App Authorization Code*. The host property of the system is used as the Globus Endpoint Id or Globus Collection Id. Once a user has obtained an authorization code, the corresponding Systems endpoint for generating Globus tokens should be called to exchange the code + sessionId for a pair of access and refresh tokens. The session Id is a Tapis Id that is used to track the oauth2 flow that is started when this call is made. The authorization code, as per Globus documentation, is valid for 10 minutes. Please note that the Tapis installation for your site must be configured by the site administrator to support systems of type GLOBUS.
242
+ * Retrieve a Globus URL that can be used to generate an authorization code for an OAuth2 flow.
243
+ */
244
+ CredentialsApi.prototype.getGlobusAuthUrlRaw = function (requestParameters, initOverrides) {
245
+ return __awaiter(this, void 0, void 0, function () {
246
+ var queryParameters, headerParameters, response;
247
+ return __generator(this, function (_a) {
248
+ switch (_a.label) {
249
+ case 0:
250
+ if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
251
+ throw new runtime.RequiredError('systemId', 'Required parameter requestParameters.systemId was null or undefined when calling getGlobusAuthUrl.');
252
+ }
253
+ queryParameters = {};
254
+ headerParameters = {};
255
+ if (this.configuration && this.configuration.apiKey) {
256
+ headerParameters["X-Tapis-Token"] = this.configuration.apiKey("X-Tapis-Token"); // TapisJWT authentication
257
+ }
258
+ return [4 /*yield*/, this.request({
259
+ path: "/v3/systems/credential/{systemId}/globus/authUrl".replace("{" + "systemId" + "}", encodeURIComponent(String(requestParameters.systemId))),
260
+ method: 'GET',
261
+ headers: headerParameters,
262
+ query: queryParameters,
263
+ }, initOverrides)];
264
+ case 1:
265
+ response = _a.sent();
266
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return models_1.RespGlobusAuthUrlFromJSON(jsonValue); })];
267
+ }
268
+ });
269
+ });
270
+ };
271
+ /**
272
+ * Retrieve a Globus URL + Session Id that can be used to generate an oauth2 authorization code associated with the given system. In Globus, the code is referred to as a *Native App Authorization Code*. The host property of the system is used as the Globus Endpoint Id or Globus Collection Id. Once a user has obtained an authorization code, the corresponding Systems endpoint for generating Globus tokens should be called to exchange the code + sessionId for a pair of access and refresh tokens. The session Id is a Tapis Id that is used to track the oauth2 flow that is started when this call is made. The authorization code, as per Globus documentation, is valid for 10 minutes. Please note that the Tapis installation for your site must be configured by the site administrator to support systems of type GLOBUS.
273
+ * Retrieve a Globus URL that can be used to generate an authorization code for an OAuth2 flow.
274
+ */
275
+ CredentialsApi.prototype.getGlobusAuthUrl = function (requestParameters, initOverrides) {
276
+ return __awaiter(this, void 0, void 0, function () {
277
+ var response;
278
+ return __generator(this, function (_a) {
279
+ switch (_a.label) {
280
+ case 0: return [4 /*yield*/, this.getGlobusAuthUrlRaw(requestParameters, initOverrides)];
281
+ case 1:
282
+ response = _a.sent();
283
+ return [4 /*yield*/, response.value()];
284
+ case 2: return [2 /*return*/, _a.sent()];
285
+ }
286
+ });
287
+ });
288
+ };
289
+ /**
290
+ * Restricted. Only certain Tapis services authorized. Retrieve credentials for given system, target *userName* and authentication method. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then *{userName}* is interpreted as a Tapis user. Note that there may me a mapping of the Tapis user to a host *loginUser*. If the *effectiveUserId* for the system is static (i.e. not *${apiUserId}*) then *{userName}* is interpreted as the host *loginUser* that is used when accessing the host. Desired authentication method may be specified using query parameter *authnMethod*. If desired authentication method not specified then credentials for the system\'s default authentication method are returned. The result includes the attribute *authnMethod* indicating the authentication method associated with the returned credentials.
134
291
  */
135
292
  CredentialsApi.prototype.getUserCredentialRaw = function (requestParameters, initOverrides) {
136
293
  return __awaiter(this, void 0, void 0, function () {
@@ -166,8 +323,7 @@ var CredentialsApi = /** @class */ (function (_super) {
166
323
  });
167
324
  };
168
325
  /**
169
- * Highly restricted. Only certain Tapis services authorized. Retrieve credentials for given system, *target user* and authentication method. Note that user making the request and *target user* may be different and frequently are different. Desired authentication method may be specified using query parameter authnMethod=<method>. If desired authentication method not specified then credentials for the system\'s default authentication method are returned. The result includes the field authnMethod indicating the authentication method associated with the returned credentials.
170
- * Retrieve user credentials for a system and target user
326
+ * Restricted. Only certain Tapis services authorized. Retrieve credentials for given system, target *userName* and authentication method. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then *{userName}* is interpreted as a Tapis user. Note that there may me a mapping of the Tapis user to a host *loginUser*. If the *effectiveUserId* for the system is static (i.e. not *${apiUserId}*) then *{userName}* is interpreted as the host *loginUser* that is used when accessing the host. Desired authentication method may be specified using query parameter *authnMethod*. If desired authentication method not specified then credentials for the system\'s default authentication method are returned. The result includes the attribute *authnMethod* indicating the authentication method associated with the returned credentials.
171
327
  */
172
328
  CredentialsApi.prototype.getUserCredential = function (requestParameters, initOverrides) {
173
329
  return __awaiter(this, void 0, void 0, function () {
@@ -184,8 +340,7 @@ var CredentialsApi = /** @class */ (function (_super) {
184
340
  });
185
341
  };
186
342
  /**
187
- * Remove credentials from the Security Kernel for given system and *target user*. Requester must be owner of the system. Note that user making the request and *target user* may be different and frequently are different.
188
- * Remove user credentials for a system and target user
343
+ * Remove credentials from the Security Kernel for given system and *target user*. Requester must be owner of the system. Operation is allowed if requester is the system owner or a tenant administrator. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then the operation is allowed if *{userName}* is the Tapis user making the request.
189
344
  */
190
345
  CredentialsApi.prototype.removeUserCredentialRaw = function (requestParameters, initOverrides) {
191
346
  return __awaiter(this, void 0, void 0, function () {
@@ -218,8 +373,7 @@ var CredentialsApi = /** @class */ (function (_super) {
218
373
  });
219
374
  };
220
375
  /**
221
- * Remove credentials from the Security Kernel for given system and *target user*. Requester must be owner of the system. Note that user making the request and *target user* may be different and frequently are different.
222
- * Remove user credentials for a system and target user
376
+ * Remove credentials from the Security Kernel for given system and *target user*. Requester must be owner of the system. Operation is allowed if requester is the system owner or a tenant administrator. If the *effectiveUserId* for the system is dynamic (i.e. equal to *${apiUserId}*) then the operation is allowed if *{userName}* is the Tapis user making the request.
223
377
  */
224
378
  CredentialsApi.prototype.removeUserCredential = function (requestParameters, initOverrides) {
225
379
  return __awaiter(this, void 0, void 0, function () {
@@ -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: 1.0.0-rc1
5
+ * The version of the OpenAPI document: 1.6.3
6
6
  * Contact: cicsupport@tacc.utexas.edu
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,19 +16,19 @@ import { RespBasic } from '../models';
16
16
  */
17
17
  export declare class GeneralApi extends runtime.BaseAPI {
18
18
  /**
19
- * Health check.
19
+ * Health check. Lightweight non-authenticated check that service is alive.
20
20
  */
21
21
  healthCheckRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>>;
22
22
  /**
23
- * Health check.
23
+ * Health check. Lightweight non-authenticated check that service is alive.
24
24
  */
25
25
  healthCheck(initOverrides?: RequestInit): Promise<RespBasic>;
26
26
  /**
27
- * Ready check.
27
+ * Ready check. Non-authenticated check that service is ready to do work.
28
28
  */
29
29
  readyCheckRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>>;
30
30
  /**
31
- * Ready check.
31
+ * Ready check. Non-authenticated check that service is ready to do work.
32
32
  */
33
33
  readyCheck(initOverrides?: RequestInit): Promise<RespBasic>;
34
34
  }
@@ -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: 1.0.0-rc1
8
+ * The version of the OpenAPI document: 1.6.3
9
9
  * Contact: cicsupport@tacc.utexas.edu
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -69,7 +69,7 @@ var GeneralApi = /** @class */ (function (_super) {
69
69
  return _super !== null && _super.apply(this, arguments) || this;
70
70
  }
71
71
  /**
72
- * Health check.
72
+ * Health check. Lightweight non-authenticated check that service is alive.
73
73
  */
74
74
  GeneralApi.prototype.healthCheckRaw = function (initOverrides) {
75
75
  return __awaiter(this, void 0, void 0, function () {
@@ -79,9 +79,6 @@ var GeneralApi = /** @class */ (function (_super) {
79
79
  case 0:
80
80
  queryParameters = {};
81
81
  headerParameters = {};
82
- if (this.configuration && this.configuration.apiKey) {
83
- headerParameters["X-Tapis-Token"] = this.configuration.apiKey("X-Tapis-Token"); // TapisJWT authentication
84
- }
85
82
  return [4 /*yield*/, this.request({
86
83
  path: "/v3/systems/healthcheck",
87
84
  method: 'GET',
@@ -96,7 +93,7 @@ var GeneralApi = /** @class */ (function (_super) {
96
93
  });
97
94
  };
98
95
  /**
99
- * Health check.
96
+ * Health check. Lightweight non-authenticated check that service is alive.
100
97
  */
101
98
  GeneralApi.prototype.healthCheck = function (initOverrides) {
102
99
  return __awaiter(this, void 0, void 0, function () {
@@ -113,7 +110,7 @@ var GeneralApi = /** @class */ (function (_super) {
113
110
  });
114
111
  };
115
112
  /**
116
- * Ready check.
113
+ * Ready check. Non-authenticated check that service is ready to do work.
117
114
  */
118
115
  GeneralApi.prototype.readyCheckRaw = function (initOverrides) {
119
116
  return __awaiter(this, void 0, void 0, function () {
@@ -123,9 +120,6 @@ var GeneralApi = /** @class */ (function (_super) {
123
120
  case 0:
124
121
  queryParameters = {};
125
122
  headerParameters = {};
126
- if (this.configuration && this.configuration.apiKey) {
127
- headerParameters["X-Tapis-Token"] = this.configuration.apiKey("X-Tapis-Token"); // TapisJWT authentication
128
- }
129
123
  return [4 /*yield*/, this.request({
130
124
  path: "/v3/systems/readycheck",
131
125
  method: 'GET',
@@ -140,7 +134,7 @@ var GeneralApi = /** @class */ (function (_super) {
140
134
  });
141
135
  };
142
136
  /**
143
- * Ready check.
137
+ * Ready check. Non-authenticated check that service is ready to do work.
144
138
  */
145
139
  GeneralApi.prototype.readyCheck = function (initOverrides) {
146
140
  return __awaiter(this, void 0, void 0, function () {
@@ -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: 1.0.0-rc1
5
+ * The version of the OpenAPI document: 1.6.3
6
6
  * Contact: cicsupport@tacc.utexas.edu
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -36,42 +36,34 @@ export interface RevokeUserPermsRequest {
36
36
  export declare class PermissionsApi extends runtime.BaseAPI {
37
37
  /**
38
38
  * Retrieve all system related permissions for a given system and user.
39
- * Retrieve system user permissions
40
39
  */
41
40
  getUserPermsRaw(requestParameters: GetUserPermsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespNameArray>>;
42
41
  /**
43
42
  * Retrieve all system related permissions for a given system and user.
44
- * Retrieve system user permissions
45
43
  */
46
44
  getUserPerms(requestParameters: GetUserPermsRequest, initOverrides?: RequestInit): Promise<RespNameArray>;
47
45
  /**
48
- * Create permissions in the Security Kernel for a user. Requester must be owner of the system. Permissions are READ, MODIFY, EXECUTE.
49
- * Grant system user permissions
46
+ * Create permissions in the Security Kernel for a user. Requester must be owner of the system. Permissions are READ, MODIFY, EXECUTE. MODIFY implies READ.
50
47
  */
51
48
  grantUserPermsRaw(requestParameters: GrantUserPermsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>>;
52
49
  /**
53
- * Create permissions in the Security Kernel for a user. Requester must be owner of the system. Permissions are READ, MODIFY, EXECUTE.
54
- * Grant system user permissions
50
+ * Create permissions in the Security Kernel for a user. Requester must be owner of the system. Permissions are READ, MODIFY, EXECUTE. MODIFY implies READ.
55
51
  */
56
52
  grantUserPerms(requestParameters: GrantUserPermsRequest, initOverrides?: RequestInit): Promise<RespBasic>;
57
53
  /**
58
54
  * Remove system user permission from the Security Kernel. Requester must be owner of the system. Permissions are READ, MODIFY, EXECUTE.
59
- * Revoke system user permission
60
55
  */
61
56
  revokeUserPermRaw(requestParameters: RevokeUserPermRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>>;
62
57
  /**
63
58
  * Remove system user permission from the Security Kernel. Requester must be owner of the system. Permissions are READ, MODIFY, EXECUTE.
64
- * Revoke system user permission
65
59
  */
66
60
  revokeUserPerm(requestParameters: RevokeUserPermRequest, initOverrides?: RequestInit): Promise<RespBasic>;
67
61
  /**
68
62
  * Remove permissions from the Security Kernel for a user. Requester must be owner of the system. Permissions are READ, MODIFY, EXECUTE.
69
- * Revoke system user permissions
70
63
  */
71
64
  revokeUserPermsRaw(requestParameters: RevokeUserPermsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBasic>>;
72
65
  /**
73
66
  * Remove permissions from the Security Kernel for a user. Requester must be owner of the system. Permissions are READ, MODIFY, EXECUTE.
74
- * Revoke system user permissions
75
67
  */
76
68
  revokeUserPerms(requestParameters: RevokeUserPermsRequest, initOverrides?: RequestInit): Promise<RespBasic>;
77
69
  }
@@ -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: 1.0.0-rc1
8
+ * The version of the OpenAPI document: 1.6.3
9
9
  * Contact: cicsupport@tacc.utexas.edu
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -70,7 +70,6 @@ var PermissionsApi = /** @class */ (function (_super) {
70
70
  }
71
71
  /**
72
72
  * Retrieve all system related permissions for a given system and user.
73
- * Retrieve system user permissions
74
73
  */
75
74
  PermissionsApi.prototype.getUserPermsRaw = function (requestParameters, initOverrides) {
76
75
  return __awaiter(this, void 0, void 0, function () {
@@ -104,7 +103,6 @@ var PermissionsApi = /** @class */ (function (_super) {
104
103
  };
105
104
  /**
106
105
  * Retrieve all system related permissions for a given system and user.
107
- * Retrieve system user permissions
108
106
  */
109
107
  PermissionsApi.prototype.getUserPerms = function (requestParameters, initOverrides) {
110
108
  return __awaiter(this, void 0, void 0, function () {
@@ -121,8 +119,7 @@ var PermissionsApi = /** @class */ (function (_super) {
121
119
  });
122
120
  };
123
121
  /**
124
- * Create permissions in the Security Kernel for a user. Requester must be owner of the system. Permissions are READ, MODIFY, EXECUTE.
125
- * Grant system user permissions
122
+ * Create permissions in the Security Kernel for a user. Requester must be owner of the system. Permissions are READ, MODIFY, EXECUTE. MODIFY implies READ.
126
123
  */
127
124
  PermissionsApi.prototype.grantUserPermsRaw = function (requestParameters, initOverrides) {
128
125
  return __awaiter(this, void 0, void 0, function () {
@@ -160,8 +157,7 @@ var PermissionsApi = /** @class */ (function (_super) {
160
157
  });
161
158
  };
162
159
  /**
163
- * Create permissions in the Security Kernel for a user. Requester must be owner of the system. Permissions are READ, MODIFY, EXECUTE.
164
- * Grant system user permissions
160
+ * Create permissions in the Security Kernel for a user. Requester must be owner of the system. Permissions are READ, MODIFY, EXECUTE. MODIFY implies READ.
165
161
  */
166
162
  PermissionsApi.prototype.grantUserPerms = function (requestParameters, initOverrides) {
167
163
  return __awaiter(this, void 0, void 0, function () {
@@ -179,7 +175,6 @@ var PermissionsApi = /** @class */ (function (_super) {
179
175
  };
180
176
  /**
181
177
  * Remove system user permission from the Security Kernel. Requester must be owner of the system. Permissions are READ, MODIFY, EXECUTE.
182
- * Revoke system user permission
183
178
  */
184
179
  PermissionsApi.prototype.revokeUserPermRaw = function (requestParameters, initOverrides) {
185
180
  return __awaiter(this, void 0, void 0, function () {
@@ -216,7 +211,6 @@ var PermissionsApi = /** @class */ (function (_super) {
216
211
  };
217
212
  /**
218
213
  * Remove system user permission from the Security Kernel. Requester must be owner of the system. Permissions are READ, MODIFY, EXECUTE.
219
- * Revoke system user permission
220
214
  */
221
215
  PermissionsApi.prototype.revokeUserPerm = function (requestParameters, initOverrides) {
222
216
  return __awaiter(this, void 0, void 0, function () {
@@ -234,7 +228,6 @@ var PermissionsApi = /** @class */ (function (_super) {
234
228
  };
235
229
  /**
236
230
  * Remove permissions from the Security Kernel for a user. Requester must be owner of the system. Permissions are READ, MODIFY, EXECUTE.
237
- * Revoke system user permissions
238
231
  */
239
232
  PermissionsApi.prototype.revokeUserPermsRaw = function (requestParameters, initOverrides) {
240
233
  return __awaiter(this, void 0, void 0, function () {
@@ -273,7 +266,6 @@ var PermissionsApi = /** @class */ (function (_super) {
273
266
  };
274
267
  /**
275
268
  * Remove permissions from the Security Kernel for a user. Requester must be owner of the system. Permissions are READ, MODIFY, EXECUTE.
276
- * Revoke system user permissions
277
269
  */
278
270
  PermissionsApi.prototype.revokeUserPerms = function (requestParameters, initOverrides) {
279
271
  return __awaiter(this, void 0, void 0, function () {
@@ -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: 1.0.0-rc1
5
+ * The version of the OpenAPI document: 1.6.3
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,9 +10,9 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { ReqCreateSchedulerProfile, RespChangeCount, RespResourceUrl, RespSchedulerProfile, RespSchedulerProfiles } from '../models';
13
+ import { ReqPostSchedulerProfile, RespChangeCount, RespResourceUrl, RespSchedulerProfile, RespSchedulerProfiles } from '../models';
14
14
  export interface CreateSchedulerProfileRequest {
15
- reqCreateSchedulerProfile: ReqCreateSchedulerProfile;
15
+ reqPostSchedulerProfile: ReqPostSchedulerProfile;
16
16
  }
17
17
  export interface DeleteSchedulerProfileRequest {
18
18
  name: string;
@@ -25,43 +25,35 @@ export interface GetSchedulerProfileRequest {
25
25
  */
26
26
  export declare class SchedulerProfilesApi extends runtime.BaseAPI {
27
27
  /**
28
- * Create a scheduler profile using a request body. Name must be unique within a tenant and can be composed of alphanumeric characters and the following special characters [-._~]. Name must begin with an alphabetic character and can be no more than 80 characters in length. Description is optional with a maximum length of 2048 characters. Note that certain attributes (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 profile. The attributes that are allowed but ignored are - tenant - uuid - created - updated
29
- * Create a scheduler profile
28
+ * Create a scheduler profile using a request body. Name must be unique within a tenant and can be composed of alphanumeric characters and the following special characters [-._~]. Name must begin with an alphabetic character and can be no more than 80 characters in length. Description is optional with a maximum length of 2048 characters. Note that certain attributes (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 profile. The attributes that are allowed but ignored are - tenant - uuid - created - updated
30
29
  */
31
30
  createSchedulerProfileRaw(requestParameters: CreateSchedulerProfileRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespResourceUrl>>;
32
31
  /**
33
- * Create a scheduler profile using a request body. Name must be unique within a tenant and can be composed of alphanumeric characters and the following special characters [-._~]. Name must begin with an alphabetic character and can be no more than 80 characters in length. Description is optional with a maximum length of 2048 characters. Note that certain attributes (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 profile. The attributes that are allowed but ignored are - tenant - uuid - created - updated
34
- * Create a scheduler profile
32
+ * Create a scheduler profile using a request body. Name must be unique within a tenant and can be composed of alphanumeric characters and the following special characters [-._~]. Name must begin with an alphabetic character and can be no more than 80 characters in length. Description is optional with a maximum length of 2048 characters. Note that certain attributes (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 profile. The attributes that are allowed but ignored are - tenant - uuid - created - updated
35
33
  */
36
34
  createSchedulerProfile(requestParameters: CreateSchedulerProfileRequest, initOverrides?: RequestInit): Promise<RespResourceUrl>;
37
35
  /**
38
36
  * Remove a scheduler profile given the profile name. Requester must be owner of the profile.
39
- * Delete a scheduler profile
40
37
  */
41
38
  deleteSchedulerProfileRaw(requestParameters: DeleteSchedulerProfileRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>>;
42
39
  /**
43
40
  * Remove a scheduler profile given the profile name. Requester must be owner of the profile.
44
- * Delete a scheduler profile
45
41
  */
46
42
  deleteSchedulerProfile(requestParameters: DeleteSchedulerProfileRequest, initOverrides?: RequestInit): Promise<RespChangeCount>;
47
43
  /**
48
44
  * Retrieve information for a scheduler profile given the profile name.
49
- * Retrieve a scheduler profile
50
45
  */
51
46
  getSchedulerProfileRaw(requestParameters: GetSchedulerProfileRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSchedulerProfile>>;
52
47
  /**
53
48
  * Retrieve information for a scheduler profile given the profile name.
54
- * Retrieve a scheduler profile
55
49
  */
56
50
  getSchedulerProfile(requestParameters: GetSchedulerProfileRequest, initOverrides?: RequestInit): Promise<RespSchedulerProfile>;
57
51
  /**
58
52
  * Retrieve list of scheduler profiles.
59
- * Retrieve scheduler profiles
60
53
  */
61
54
  getSchedulerProfilesRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSchedulerProfiles>>;
62
55
  /**
63
56
  * Retrieve list of scheduler profiles.
64
- * Retrieve scheduler profiles
65
57
  */
66
58
  getSchedulerProfiles(initOverrides?: RequestInit): Promise<RespSchedulerProfiles>;
67
59
  }