@tapis/tapis-typescript-systems 0.0.2 → 0.0.3
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 +18 -3
- package/README.md +2 -2
- package/dist/apis/ChildSystemsApi.d.ts +54 -0
- package/dist/apis/ChildSystemsApi.js +224 -0
- package/dist/apis/CredentialsApi.d.ts +48 -15
- package/dist/apis/CredentialsApi.js +167 -16
- package/dist/apis/GeneralApi.d.ts +5 -5
- package/dist/apis/GeneralApi.js +5 -5
- package/dist/apis/PermissionsApi.d.ts +3 -11
- package/dist/apis/PermissionsApi.js +3 -11
- package/dist/apis/SchedulerProfilesApi.d.ts +5 -13
- package/dist/apis/SchedulerProfilesApi.js +6 -14
- package/dist/apis/SharingApi.d.ts +85 -0
- package/dist/apis/SharingApi.js +328 -0
- package/dist/apis/SystemsApi.d.ts +33 -44
- package/dist/apis/SystemsApi.js +84 -47
- package/dist/apis/index.d.ts +2 -0
- package/dist/apis/index.js +2 -0
- package/dist/models/AuthnEnum.d.ts +2 -1
- package/dist/models/AuthnEnum.js +2 -1
- package/dist/models/Capability.d.ts +1 -1
- package/dist/models/Capability.js +1 -1
- package/dist/models/CategoryEnum.d.ts +1 -1
- package/dist/models/CategoryEnum.js +1 -1
- package/dist/models/Credential.d.ts +19 -1
- package/dist/models/Credential.js +7 -1
- package/dist/models/DatatypeEnum.d.ts +1 -1
- package/dist/models/DatatypeEnum.js +1 -1
- package/dist/models/JobRuntime.d.ts +1 -1
- package/dist/models/JobRuntime.js +1 -1
- package/dist/models/KeyValuePair.d.ts +7 -1
- package/dist/models/KeyValuePair.js +3 -1
- package/dist/models/ListTypeEnum.d.ts +24 -0
- package/dist/models/ListTypeEnum.js +38 -0
- package/dist/models/LogicalQueue.d.ts +1 -1
- package/dist/models/LogicalQueue.js +1 -1
- package/dist/models/ModuleLoadSpec.d.ts +33 -0
- package/dist/models/ModuleLoadSpec.js +43 -0
- package/dist/models/OperationTypeEnum.d.ts +35 -0
- package/dist/models/OperationTypeEnum.js +49 -0
- package/dist/models/ReqMatchConstraints.d.ts +1 -1
- package/dist/models/ReqMatchConstraints.js +1 -1
- package/dist/models/ReqPatchSystem.d.ts +19 -1
- package/dist/models/ReqPatchSystem.js +7 -1
- package/dist/models/ReqPerms.d.ts +1 -1
- package/dist/models/ReqPerms.js +1 -1
- package/dist/models/ReqPostChildSystem.d.ts +39 -0
- package/dist/models/ReqPostChildSystem.js +45 -0
- package/dist/models/ReqPostPutCredential.d.ts +69 -0
- package/dist/models/{ReqCreateCredential.js → ReqPostPutCredential.js} +12 -8
- package/dist/models/ReqPostSchedulerProfile.d.ts +52 -0
- package/dist/models/{ReqCreateSchedulerProfile.js → ReqPostSchedulerProfile.js} +10 -12
- package/dist/models/{ReqCreateSystem.d.ts → ReqPostSystem.d.ts} +55 -43
- package/dist/models/{ReqCreateSystem.js → ReqPostSystem.js} +14 -10
- package/dist/models/ReqPutSystem.d.ts +16 -4
- package/dist/models/ReqPutSystem.js +7 -3
- package/dist/models/ReqSearchSystems.d.ts +1 -1
- package/dist/models/ReqSearchSystems.js +1 -1
- package/dist/models/ReqShareUpdate.d.ts +27 -0
- package/dist/models/ReqShareUpdate.js +40 -0
- package/dist/models/ReqUnlinkChildren.d.ts +27 -0
- package/dist/models/ReqUnlinkChildren.js +41 -0
- package/dist/models/ReqUpdateCredential.d.ts +75 -0
- package/dist/models/ReqUpdateCredential.js +57 -0
- package/dist/models/RespBasic.d.ts +13 -1
- package/dist/models/RespBasic.js +5 -1
- package/dist/models/RespBoolean.d.ts +13 -1
- package/dist/models/RespBoolean.js +5 -1
- package/dist/models/RespChangeCount.d.ts +13 -1
- package/dist/models/RespChangeCount.js +5 -1
- package/dist/models/RespCredential.d.ts +13 -1
- package/dist/models/RespCredential.js +5 -1
- package/dist/models/RespGlobusAuthUrl.d.ts +64 -0
- package/dist/models/RespGlobusAuthUrl.js +54 -0
- package/dist/models/RespNameArray.d.ts +13 -1
- package/dist/models/RespNameArray.js +5 -1
- package/dist/models/RespResourceUrl.d.ts +13 -1
- package/dist/models/RespResourceUrl.js +5 -1
- package/dist/models/RespSchedulerProfile.d.ts +13 -1
- package/dist/models/RespSchedulerProfile.js +5 -1
- package/dist/models/RespSchedulerProfiles.d.ts +13 -1
- package/dist/models/RespSchedulerProfiles.js +5 -1
- package/dist/models/RespShareInfo.d.ts +64 -0
- package/dist/models/RespShareInfo.js +54 -0
- package/dist/models/RespSystem.d.ts +13 -1
- package/dist/models/RespSystem.js +5 -1
- package/dist/models/RespSystemHistory.d.ts +64 -0
- package/dist/models/RespSystemHistory.js +54 -0
- package/dist/models/RespSystems.d.ts +13 -1
- package/dist/models/RespSystems.js +5 -1
- package/dist/models/RespSystemsMetadata.d.ts +1 -1
- package/dist/models/RespSystemsMetadata.js +1 -1
- package/dist/models/ResultBoolean.d.ts +1 -1
- package/dist/models/ResultBoolean.js +1 -1
- package/dist/models/ResultChangeCount.d.ts +1 -1
- package/dist/models/ResultChangeCount.js +1 -1
- package/dist/models/ResultGlobusAuthUrl.d.ts +33 -0
- package/dist/models/ResultGlobusAuthUrl.js +43 -0
- package/dist/models/ResultNameArray.d.ts +1 -1
- package/dist/models/ResultNameArray.js +1 -1
- package/dist/models/ResultResourceUrl.d.ts +1 -1
- package/dist/models/ResultResourceUrl.js +1 -1
- package/dist/models/RuntimeTypeEnum.d.ts +1 -1
- package/dist/models/RuntimeTypeEnum.js +1 -1
- package/dist/models/SchedulerHiddenOptionEnum.d.ts +1 -1
- package/dist/models/SchedulerHiddenOptionEnum.js +1 -1
- package/dist/models/SchedulerProfile.d.ts +4 -10
- package/dist/models/SchedulerProfile.js +3 -5
- package/dist/models/SchedulerTypeEnum.d.ts +1 -1
- package/dist/models/SchedulerTypeEnum.js +1 -1
- package/dist/models/ShareInfo.d.ts +33 -0
- package/dist/models/ShareInfo.js +42 -0
- package/dist/models/SystemHistory.d.ts +64 -0
- package/dist/models/SystemHistory.js +54 -0
- package/dist/models/SystemTypeEnum.d.ts +1 -1
- package/dist/models/SystemTypeEnum.js +1 -1
- package/dist/models/TapisSystem.d.ts +27 -3
- package/dist/models/TapisSystem.js +11 -3
- package/dist/models/index.d.ts +16 -3
- package/dist/models/index.js +16 -3
- package/dist/runtime.d.ts +1 -1
- package/dist/runtime.js +1 -1
- package/package.json +1 -1
- package/src/apis/ChildSystemsApi.ts +171 -0
- package/src/apis/CredentialsApi.ts +152 -20
- package/src/apis/GeneralApi.ts +5 -5
- package/src/apis/PermissionsApi.ts +3 -11
- package/src/apis/SchedulerProfilesApi.ts +10 -18
- package/src/apis/SharingApi.ts +250 -0
- package/src/apis/SystemsApi.ts +99 -53
- package/src/apis/index.ts +2 -0
- package/src/models/AuthnEnum.ts +2 -1
- package/src/models/Capability.ts +1 -1
- package/src/models/CategoryEnum.ts +1 -1
- package/src/models/Credential.ts +25 -1
- package/src/models/DatatypeEnum.ts +1 -1
- package/src/models/JobRuntime.ts +1 -1
- package/src/models/KeyValuePair.ts +9 -1
- package/src/models/ListTypeEnum.ts +37 -0
- package/src/models/LogicalQueue.ts +1 -1
- package/src/models/ModuleLoadSpec.ts +64 -0
- package/src/models/OperationTypeEnum.ts +48 -0
- package/src/models/ReqMatchConstraints.ts +1 -1
- package/src/models/ReqPatchSystem.ts +25 -1
- package/src/models/ReqPerms.ts +1 -1
- package/src/models/ReqPostChildSystem.ts +72 -0
- package/src/models/{ReqCreateCredential.ts → ReqPostPutCredential.ts} +29 -13
- package/src/models/{ReqCreateSchedulerProfile.ts → ReqPostSchedulerProfile.ts} +20 -24
- package/src/models/{ReqCreateSystem.ts → ReqPostSystem.ts} +65 -49
- package/src/models/ReqPutSystem.ts +25 -9
- package/src/models/ReqSearchSystems.ts +1 -1
- package/src/models/ReqShareUpdate.ts +56 -0
- package/src/models/ReqUnlinkChildren.ts +56 -0
- package/src/models/ReqUpdateCredential.ts +120 -0
- package/src/models/RespBasic.ts +17 -1
- package/src/models/RespBoolean.ts +17 -1
- package/src/models/RespChangeCount.ts +17 -1
- package/src/models/RespCredential.ts +17 -1
- package/src/models/RespGlobusAuthUrl.ts +111 -0
- package/src/models/RespNameArray.ts +17 -1
- package/src/models/RespResourceUrl.ts +17 -1
- package/src/models/RespSchedulerProfile.ts +17 -1
- package/src/models/RespSchedulerProfiles.ts +17 -1
- package/src/models/RespShareInfo.ts +111 -0
- package/src/models/RespSystem.ts +17 -1
- package/src/models/RespSystemHistory.ts +111 -0
- package/src/models/RespSystems.ts +17 -1
- package/src/models/RespSystemsMetadata.ts +1 -1
- package/src/models/ResultBoolean.ts +1 -1
- package/src/models/ResultChangeCount.ts +1 -1
- package/src/models/ResultGlobusAuthUrl.ts +64 -0
- package/src/models/ResultNameArray.ts +1 -1
- package/src/models/ResultResourceUrl.ts +1 -1
- package/src/models/RuntimeTypeEnum.ts +1 -1
- package/src/models/SchedulerHiddenOptionEnum.ts +1 -1
- package/src/models/SchedulerProfile.ts +9 -13
- package/src/models/SchedulerTypeEnum.ts +1 -1
- package/src/models/ShareInfo.ts +64 -0
- package/src/models/SystemHistory.ts +111 -0
- package/src/models/SystemTypeEnum.ts +1 -1
- package/src/models/TapisSystem.ts +37 -5
- package/src/models/index.ts +16 -3
- package/src/runtime.ts +1 -1
- package/dist/models/ReqCreateCredential.d.ts +0 -57
- package/dist/models/ReqCreateSchedulerProfile.d.ts +0 -58
|
@@ -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.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.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,13 +10,13 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import {
|
|
13
|
+
import { ListTypeEnum, ReqMatchConstraints, ReqPatchSystem, ReqPostSystem, ReqPutSystem, ReqSearchSystems, RespBoolean, RespChangeCount, RespResourceUrl, RespSystem, RespSystemHistory, RespSystems } from '../models';
|
|
14
14
|
export interface ChangeSystemOwnerRequest {
|
|
15
15
|
systemId: string;
|
|
16
16
|
userName: string;
|
|
17
17
|
}
|
|
18
18
|
export interface CreateSystemRequest {
|
|
19
|
-
|
|
19
|
+
reqPostSystem: ReqPostSystem;
|
|
20
20
|
skipCredentialCheck?: boolean;
|
|
21
21
|
}
|
|
22
22
|
export interface DeleteSystemRequest {
|
|
@@ -28,15 +28,22 @@ export interface DisableSystemRequest {
|
|
|
28
28
|
export interface EnableSystemRequest {
|
|
29
29
|
systemId: string;
|
|
30
30
|
}
|
|
31
|
+
export interface GetHistoryRequest {
|
|
32
|
+
systemId: string;
|
|
33
|
+
}
|
|
31
34
|
export interface GetSystemRequest {
|
|
32
35
|
systemId: string;
|
|
33
|
-
returnCredentials?: boolean;
|
|
34
36
|
authnMethod?: string;
|
|
35
37
|
requireExecPerm?: boolean;
|
|
36
38
|
select?: string;
|
|
39
|
+
returnCredentials?: boolean;
|
|
40
|
+
impersonationId?: string;
|
|
41
|
+
sharedAppCtx?: string;
|
|
42
|
+
resourceTenant?: string;
|
|
37
43
|
}
|
|
38
44
|
export interface GetSystemsRequest {
|
|
39
45
|
search?: string;
|
|
46
|
+
listType?: ListTypeEnum;
|
|
40
47
|
limit?: number;
|
|
41
48
|
orderBy?: string;
|
|
42
49
|
skip?: number;
|
|
@@ -64,6 +71,7 @@ export interface SearchSystemsQueryParametersRequest {
|
|
|
64
71
|
freeFormParameterName?: {
|
|
65
72
|
[key: string]: string;
|
|
66
73
|
};
|
|
74
|
+
listType?: ListTypeEnum;
|
|
67
75
|
limit?: number;
|
|
68
76
|
orderBy?: string;
|
|
69
77
|
skip?: number;
|
|
@@ -73,6 +81,7 @@ export interface SearchSystemsQueryParametersRequest {
|
|
|
73
81
|
}
|
|
74
82
|
export interface SearchSystemsRequestBodyRequest {
|
|
75
83
|
reqSearchSystems: ReqSearchSystems;
|
|
84
|
+
listType?: ListTypeEnum;
|
|
76
85
|
limit?: number;
|
|
77
86
|
orderBy?: string;
|
|
78
87
|
skip?: number;
|
|
@@ -89,142 +98,122 @@ export interface UndeleteSystemRequest {
|
|
|
89
98
|
export declare class SystemsApi extends runtime.BaseAPI {
|
|
90
99
|
/**
|
|
91
100
|
* Change owner of a system.
|
|
92
|
-
* Change system owner
|
|
93
101
|
*/
|
|
94
102
|
changeSystemOwnerRaw(requestParameters: ChangeSystemOwnerRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>>;
|
|
95
103
|
/**
|
|
96
104
|
* Change owner of a system.
|
|
97
|
-
* Change system owner
|
|
98
105
|
*/
|
|
99
106
|
changeSystemOwner(requestParameters: ChangeSystemOwnerRequest, initOverrides?: RequestInit): Promise<RespChangeCount>;
|
|
100
107
|
/**
|
|
101
|
-
* 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 alphabetic character and can be no more than 80 characters in length. Description is optional with a maximum length of 2048 characters.
|
|
102
|
-
* Create a system
|
|
108
|
+
* 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 alphabetic character and can be no more than 80 characters in length. Description is optional with a maximum length of 2048 characters. The attribute *effectiveUserId* determines the user that is 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). 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. When using Files to list, copy, move, mkdir, etc. all paths are relative to this directory. 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
|
|
103
109
|
*/
|
|
104
110
|
createSystemRaw(requestParameters: CreateSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespResourceUrl>>;
|
|
105
111
|
/**
|
|
106
|
-
* 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 alphabetic character and can be no more than 80 characters in length. Description is optional with a maximum length of 2048 characters.
|
|
107
|
-
* Create a system
|
|
112
|
+
* 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 alphabetic character and can be no more than 80 characters in length. Description is optional with a maximum length of 2048 characters. The attribute *effectiveUserId* determines the user that is 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). 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. When using Files to list, copy, move, mkdir, etc. all paths are relative to this directory. 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
|
|
108
113
|
*/
|
|
109
114
|
createSystem(requestParameters: CreateSystemRequest, initOverrides?: RequestInit): Promise<RespResourceUrl>;
|
|
110
115
|
/**
|
|
111
116
|
* Mark a system as deleted. System will not appear in queries unless explicitly requested.
|
|
112
|
-
* Mark a system as deleted
|
|
113
117
|
*/
|
|
114
118
|
deleteSystemRaw(requestParameters: DeleteSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>>;
|
|
115
119
|
/**
|
|
116
120
|
* Mark a system as deleted. System will not appear in queries unless explicitly requested.
|
|
117
|
-
* Mark a system as deleted
|
|
118
121
|
*/
|
|
119
122
|
deleteSystem(requestParameters: DeleteSystemRequest, initOverrides?: RequestInit): Promise<RespChangeCount>;
|
|
120
123
|
/**
|
|
121
124
|
* Mark a system unavailable for use.
|
|
122
|
-
* Mark a system unavailabe for use
|
|
123
125
|
*/
|
|
124
126
|
disableSystemRaw(requestParameters: DisableSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>>;
|
|
125
127
|
/**
|
|
126
128
|
* Mark a system unavailable for use.
|
|
127
|
-
* Mark a system unavailabe for use
|
|
128
129
|
*/
|
|
129
130
|
disableSystem(requestParameters: DisableSystemRequest, initOverrides?: RequestInit): Promise<RespChangeCount>;
|
|
130
131
|
/**
|
|
131
132
|
* Mark a system available for use.
|
|
132
|
-
* Mark a system availabe for use
|
|
133
133
|
*/
|
|
134
134
|
enableSystemRaw(requestParameters: EnableSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>>;
|
|
135
135
|
/**
|
|
136
136
|
* Mark a system available for use.
|
|
137
|
-
* Mark a system availabe for use
|
|
138
137
|
*/
|
|
139
138
|
enableSystem(requestParameters: EnableSystemRequest, initOverrides?: RequestInit): Promise<RespChangeCount>;
|
|
140
139
|
/**
|
|
141
|
-
* Retrieve
|
|
142
|
-
|
|
140
|
+
* Retrieve history of changes for a given systemId.
|
|
141
|
+
*/
|
|
142
|
+
getHistoryRaw(requestParameters: GetHistoryRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSystemHistory>>;
|
|
143
|
+
/**
|
|
144
|
+
* Retrieve history of changes for a given systemId.
|
|
145
|
+
*/
|
|
146
|
+
getHistory(requestParameters: GetHistoryRequest, initOverrides?: RequestInit): Promise<RespSystemHistory>;
|
|
147
|
+
/**
|
|
148
|
+
* Retrieve information for a system given the system Id. Use query parameter authnMethod=<method> to override the default authentication method. Certain services 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 services may use the query parameter *sharedAppCtx* to indicate that the request is in a shared application context. Tapis authorization will be bypassed.
|
|
143
149
|
*/
|
|
144
150
|
getSystemRaw(requestParameters: GetSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSystem>>;
|
|
145
151
|
/**
|
|
146
|
-
* Retrieve information for a system given the system
|
|
147
|
-
* Retrieve system details
|
|
152
|
+
* Retrieve information for a system given the system Id. Use query parameter authnMethod=<method> to override the default authentication method. Certain services 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 services may use the query parameter *sharedAppCtx* to indicate that the request is in a shared application context. Tapis authorization will be bypassed.
|
|
148
153
|
*/
|
|
149
154
|
getSystem(requestParameters: GetSystemRequest, initOverrides?: RequestInit): Promise<RespSystem>;
|
|
150
155
|
/**
|
|
151
|
-
* Retrieve list of systems. Use search and select query parameters to limit results.
|
|
152
|
-
* Retrieve systems
|
|
156
|
+
* Retrieve list of systems. Use *listType*, *search* 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.
|
|
153
157
|
*/
|
|
154
158
|
getSystemsRaw(requestParameters: GetSystemsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSystems>>;
|
|
155
159
|
/**
|
|
156
|
-
* Retrieve list of systems. Use search and select query parameters to limit results.
|
|
157
|
-
* Retrieve systems
|
|
160
|
+
* Retrieve list of systems. Use *listType*, *search* 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.
|
|
158
161
|
*/
|
|
159
162
|
getSystems(requestParameters: GetSystemsRequest, initOverrides?: RequestInit): Promise<RespSystems>;
|
|
160
163
|
/**
|
|
161
164
|
* Check if a system is currently enabled, i.e. available for use.
|
|
162
|
-
* Check if system is currently enabled
|
|
163
165
|
*/
|
|
164
166
|
isEnabledRaw(requestParameters: IsEnabledRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBoolean>>;
|
|
165
167
|
/**
|
|
166
168
|
* Check if a system is currently enabled, i.e. available for use.
|
|
167
|
-
* Check if system is currently enabled
|
|
168
169
|
*/
|
|
169
170
|
isEnabled(requestParameters: IsEnabledRequest, initOverrides?: RequestInit): Promise<RespBoolean>;
|
|
170
171
|
/**
|
|
171
172
|
* *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.
|
|
172
|
-
* Retrieve systems satisfying specified constraint conditions (WARNING - not yet supported)
|
|
173
173
|
*/
|
|
174
174
|
matchConstraintsRaw(requestParameters: MatchConstraintsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSystems>>;
|
|
175
175
|
/**
|
|
176
176
|
* *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.
|
|
177
|
-
* Retrieve systems satisfying specified constraint conditions (WARNING - not yet supported)
|
|
178
177
|
*/
|
|
179
178
|
matchConstraints(requestParameters: MatchConstraintsRequest, initOverrides?: RequestInit): Promise<RespSystems>;
|
|
180
179
|
/**
|
|
181
180
|
* 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 - isDtn - canExec Note that the attributes owner and enabled may be modified using other endpoints.
|
|
182
|
-
* Update selected attributes of a system
|
|
183
181
|
*/
|
|
184
182
|
patchSystemRaw(requestParameters: PatchSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespResourceUrl>>;
|
|
185
183
|
/**
|
|
186
184
|
* 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 - isDtn - canExec Note that the attributes owner and enabled may be modified using other endpoints.
|
|
187
|
-
* Update selected attributes of a system
|
|
188
185
|
*/
|
|
189
186
|
patchSystem(requestParameters: PatchSystemRequest, initOverrides?: RequestInit): Promise<RespResourceUrl>;
|
|
190
187
|
/**
|
|
191
|
-
* Update all updatable attributes of a system using a request body identical to POST. System must exist.
|
|
192
|
-
* Update all updatable attributes of a system
|
|
188
|
+
* Update all updatable attributes of a system using a request body identical to POST. System must exist. 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. 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 - enabled - bucketName - rootDir - isDtn - canExec Note that the attributes owner and enabled may be modified using other endpoints.
|
|
193
189
|
*/
|
|
194
190
|
putSystemRaw(requestParameters: PutSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespResourceUrl>>;
|
|
195
191
|
/**
|
|
196
|
-
* Update all updatable attributes of a system using a request body identical to POST. System must exist.
|
|
197
|
-
* Update all updatable attributes of a system
|
|
192
|
+
* Update all updatable attributes of a system using a request body identical to POST. System must exist. 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. 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 - enabled - bucketName - rootDir - isDtn - canExec Note that the attributes owner and enabled may be modified using other endpoints.
|
|
198
193
|
*/
|
|
199
194
|
putSystem(requestParameters: PutSystemRequest, initOverrides?: RequestInit): Promise<RespResourceUrl>;
|
|
200
195
|
/**
|
|
201
|
-
* Retrieve details for systems. Use query parameters to specify search conditions. For example owner.eq=jdoe&port.gt=1024
|
|
202
|
-
* Retrieve list of systems matching search conditions specified as query parameters
|
|
196
|
+
* 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.
|
|
203
197
|
*/
|
|
204
198
|
searchSystemsQueryParametersRaw(requestParameters: SearchSystemsQueryParametersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSystems>>;
|
|
205
199
|
/**
|
|
206
|
-
* Retrieve details for systems. Use query parameters to specify search conditions. For example owner.eq=jdoe&port.gt=1024
|
|
207
|
-
* Retrieve list of systems matching search conditions specified as query parameters
|
|
200
|
+
* 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.
|
|
208
201
|
*/
|
|
209
202
|
searchSystemsQueryParameters(requestParameters: SearchSystemsQueryParametersRequest, initOverrides?: RequestInit): Promise<RespSystems>;
|
|
210
203
|
/**
|
|
211
|
-
* Retrieve details for systems. Use request body to specify SQL-like search conditions.
|
|
212
|
-
* Retrieve list of systems matching search conditions
|
|
204
|
+
* 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.
|
|
213
205
|
*/
|
|
214
206
|
searchSystemsRequestBodyRaw(requestParameters: SearchSystemsRequestBodyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSystems>>;
|
|
215
207
|
/**
|
|
216
|
-
* Retrieve details for systems. Use request body to specify SQL-like search conditions.
|
|
217
|
-
* Retrieve list of systems matching search conditions
|
|
208
|
+
* 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.
|
|
218
209
|
*/
|
|
219
210
|
searchSystemsRequestBody(requestParameters: SearchSystemsRequestBodyRequest, initOverrides?: RequestInit): Promise<RespSystems>;
|
|
220
211
|
/**
|
|
221
212
|
* Mark a system as not deleted. System will appear in queries.
|
|
222
|
-
* Mark a system as not deleted
|
|
223
213
|
*/
|
|
224
214
|
undeleteSystemRaw(requestParameters: UndeleteSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>>;
|
|
225
215
|
/**
|
|
226
216
|
* Mark a system as not deleted. System will appear in queries.
|
|
227
|
-
* Mark a system as not deleted
|
|
228
217
|
*/
|
|
229
218
|
undeleteSystem(requestParameters: UndeleteSystemRequest, initOverrides?: RequestInit): Promise<RespChangeCount>;
|
|
230
219
|
}
|
package/dist/apis/SystemsApi.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: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.3.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 SystemsApi = /** @class */ (function (_super) {
|
|
|
70
70
|
}
|
|
71
71
|
/**
|
|
72
72
|
* Change owner of a system.
|
|
73
|
-
* Change system owner
|
|
74
73
|
*/
|
|
75
74
|
SystemsApi.prototype.changeSystemOwnerRaw = function (requestParameters, initOverrides) {
|
|
76
75
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -104,7 +103,6 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
104
103
|
};
|
|
105
104
|
/**
|
|
106
105
|
* Change owner of a system.
|
|
107
|
-
* Change system owner
|
|
108
106
|
*/
|
|
109
107
|
SystemsApi.prototype.changeSystemOwner = function (requestParameters, initOverrides) {
|
|
110
108
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -121,8 +119,7 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
121
119
|
});
|
|
122
120
|
};
|
|
123
121
|
/**
|
|
124
|
-
* 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 alphabetic character and can be no more than 80 characters in length. Description is optional with a maximum length of 2048 characters.
|
|
125
|
-
* Create a system
|
|
122
|
+
* 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 alphabetic character and can be no more than 80 characters in length. Description is optional with a maximum length of 2048 characters. The attribute *effectiveUserId* determines the user that is 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). 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. When using Files to list, copy, move, mkdir, etc. all paths are relative to this directory. 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
|
|
126
123
|
*/
|
|
127
124
|
SystemsApi.prototype.createSystemRaw = function (requestParameters, initOverrides) {
|
|
128
125
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -130,8 +127,8 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
130
127
|
return __generator(this, function (_a) {
|
|
131
128
|
switch (_a.label) {
|
|
132
129
|
case 0:
|
|
133
|
-
if (requestParameters.
|
|
134
|
-
throw new runtime.RequiredError('
|
|
130
|
+
if (requestParameters.reqPostSystem === null || requestParameters.reqPostSystem === undefined) {
|
|
131
|
+
throw new runtime.RequiredError('reqPostSystem', 'Required parameter requestParameters.reqPostSystem was null or undefined when calling createSystem.');
|
|
135
132
|
}
|
|
136
133
|
queryParameters = {};
|
|
137
134
|
if (requestParameters.skipCredentialCheck !== undefined) {
|
|
@@ -147,7 +144,7 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
147
144
|
method: 'POST',
|
|
148
145
|
headers: headerParameters,
|
|
149
146
|
query: queryParameters,
|
|
150
|
-
body: models_1.
|
|
147
|
+
body: models_1.ReqPostSystemToJSON(requestParameters.reqPostSystem),
|
|
151
148
|
}, initOverrides)];
|
|
152
149
|
case 1:
|
|
153
150
|
response = _a.sent();
|
|
@@ -157,8 +154,7 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
157
154
|
});
|
|
158
155
|
};
|
|
159
156
|
/**
|
|
160
|
-
* 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 alphabetic character and can be no more than 80 characters in length. Description is optional with a maximum length of 2048 characters.
|
|
161
|
-
* Create a system
|
|
157
|
+
* 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 alphabetic character and can be no more than 80 characters in length. Description is optional with a maximum length of 2048 characters. The attribute *effectiveUserId* determines the user that is 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). 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. When using Files to list, copy, move, mkdir, etc. all paths are relative to this directory. 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
|
|
162
158
|
*/
|
|
163
159
|
SystemsApi.prototype.createSystem = function (requestParameters, initOverrides) {
|
|
164
160
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -176,7 +172,6 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
176
172
|
};
|
|
177
173
|
/**
|
|
178
174
|
* Mark a system as deleted. System will not appear in queries unless explicitly requested.
|
|
179
|
-
* Mark a system as deleted
|
|
180
175
|
*/
|
|
181
176
|
SystemsApi.prototype.deleteSystemRaw = function (requestParameters, initOverrides) {
|
|
182
177
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -207,7 +202,6 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
207
202
|
};
|
|
208
203
|
/**
|
|
209
204
|
* Mark a system as deleted. System will not appear in queries unless explicitly requested.
|
|
210
|
-
* Mark a system as deleted
|
|
211
205
|
*/
|
|
212
206
|
SystemsApi.prototype.deleteSystem = function (requestParameters, initOverrides) {
|
|
213
207
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -225,7 +219,6 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
225
219
|
};
|
|
226
220
|
/**
|
|
227
221
|
* Mark a system unavailable for use.
|
|
228
|
-
* Mark a system unavailabe for use
|
|
229
222
|
*/
|
|
230
223
|
SystemsApi.prototype.disableSystemRaw = function (requestParameters, initOverrides) {
|
|
231
224
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -256,7 +249,6 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
256
249
|
};
|
|
257
250
|
/**
|
|
258
251
|
* Mark a system unavailable for use.
|
|
259
|
-
* Mark a system unavailabe for use
|
|
260
252
|
*/
|
|
261
253
|
SystemsApi.prototype.disableSystem = function (requestParameters, initOverrides) {
|
|
262
254
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -274,7 +266,6 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
274
266
|
};
|
|
275
267
|
/**
|
|
276
268
|
* Mark a system available for use.
|
|
277
|
-
* Mark a system availabe for use
|
|
278
269
|
*/
|
|
279
270
|
SystemsApi.prototype.enableSystemRaw = function (requestParameters, initOverrides) {
|
|
280
271
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -305,7 +296,6 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
305
296
|
};
|
|
306
297
|
/**
|
|
307
298
|
* Mark a system available for use.
|
|
308
|
-
* Mark a system availabe for use
|
|
309
299
|
*/
|
|
310
300
|
SystemsApi.prototype.enableSystem = function (requestParameters, initOverrides) {
|
|
311
301
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -322,8 +312,54 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
322
312
|
});
|
|
323
313
|
};
|
|
324
314
|
/**
|
|
325
|
-
* Retrieve
|
|
326
|
-
|
|
315
|
+
* Retrieve history of changes for a given systemId.
|
|
316
|
+
*/
|
|
317
|
+
SystemsApi.prototype.getHistoryRaw = function (requestParameters, initOverrides) {
|
|
318
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
319
|
+
var queryParameters, headerParameters, response;
|
|
320
|
+
return __generator(this, function (_a) {
|
|
321
|
+
switch (_a.label) {
|
|
322
|
+
case 0:
|
|
323
|
+
if (requestParameters.systemId === null || requestParameters.systemId === undefined) {
|
|
324
|
+
throw new runtime.RequiredError('systemId', 'Required parameter requestParameters.systemId was null or undefined when calling getHistory.');
|
|
325
|
+
}
|
|
326
|
+
queryParameters = {};
|
|
327
|
+
headerParameters = {};
|
|
328
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
329
|
+
headerParameters["X-Tapis-Token"] = this.configuration.apiKey("X-Tapis-Token"); // TapisJWT authentication
|
|
330
|
+
}
|
|
331
|
+
return [4 /*yield*/, this.request({
|
|
332
|
+
path: "/v3/systems/{systemId}/history".replace("{" + "systemId" + "}", encodeURIComponent(String(requestParameters.systemId))),
|
|
333
|
+
method: 'GET',
|
|
334
|
+
headers: headerParameters,
|
|
335
|
+
query: queryParameters,
|
|
336
|
+
}, initOverrides)];
|
|
337
|
+
case 1:
|
|
338
|
+
response = _a.sent();
|
|
339
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return models_1.RespSystemHistoryFromJSON(jsonValue); })];
|
|
340
|
+
}
|
|
341
|
+
});
|
|
342
|
+
});
|
|
343
|
+
};
|
|
344
|
+
/**
|
|
345
|
+
* Retrieve history of changes for a given systemId.
|
|
346
|
+
*/
|
|
347
|
+
SystemsApi.prototype.getHistory = function (requestParameters, initOverrides) {
|
|
348
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
349
|
+
var response;
|
|
350
|
+
return __generator(this, function (_a) {
|
|
351
|
+
switch (_a.label) {
|
|
352
|
+
case 0: return [4 /*yield*/, this.getHistoryRaw(requestParameters, initOverrides)];
|
|
353
|
+
case 1:
|
|
354
|
+
response = _a.sent();
|
|
355
|
+
return [4 /*yield*/, response.value()];
|
|
356
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
357
|
+
}
|
|
358
|
+
});
|
|
359
|
+
});
|
|
360
|
+
};
|
|
361
|
+
/**
|
|
362
|
+
* Retrieve information for a system given the system Id. Use query parameter authnMethod=<method> to override the default authentication method. Certain services 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 services may use the query parameter *sharedAppCtx* to indicate that the request is in a shared application context. Tapis authorization will be bypassed.
|
|
327
363
|
*/
|
|
328
364
|
SystemsApi.prototype.getSystemRaw = function (requestParameters, initOverrides) {
|
|
329
365
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -335,9 +371,6 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
335
371
|
throw new runtime.RequiredError('systemId', 'Required parameter requestParameters.systemId was null or undefined when calling getSystem.');
|
|
336
372
|
}
|
|
337
373
|
queryParameters = {};
|
|
338
|
-
if (requestParameters.returnCredentials !== undefined) {
|
|
339
|
-
queryParameters['returnCredentials'] = requestParameters.returnCredentials;
|
|
340
|
-
}
|
|
341
374
|
if (requestParameters.authnMethod !== undefined) {
|
|
342
375
|
queryParameters['authnMethod'] = requestParameters.authnMethod;
|
|
343
376
|
}
|
|
@@ -347,6 +380,18 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
347
380
|
if (requestParameters.select !== undefined) {
|
|
348
381
|
queryParameters['select'] = requestParameters.select;
|
|
349
382
|
}
|
|
383
|
+
if (requestParameters.returnCredentials !== undefined) {
|
|
384
|
+
queryParameters['returnCredentials'] = requestParameters.returnCredentials;
|
|
385
|
+
}
|
|
386
|
+
if (requestParameters.impersonationId !== undefined) {
|
|
387
|
+
queryParameters['impersonationId'] = requestParameters.impersonationId;
|
|
388
|
+
}
|
|
389
|
+
if (requestParameters.sharedAppCtx !== undefined) {
|
|
390
|
+
queryParameters['sharedAppCtx'] = requestParameters.sharedAppCtx;
|
|
391
|
+
}
|
|
392
|
+
if (requestParameters.resourceTenant !== undefined) {
|
|
393
|
+
queryParameters['resourceTenant'] = requestParameters.resourceTenant;
|
|
394
|
+
}
|
|
350
395
|
headerParameters = {};
|
|
351
396
|
if (this.configuration && this.configuration.apiKey) {
|
|
352
397
|
headerParameters["X-Tapis-Token"] = this.configuration.apiKey("X-Tapis-Token"); // TapisJWT authentication
|
|
@@ -365,8 +410,7 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
365
410
|
});
|
|
366
411
|
};
|
|
367
412
|
/**
|
|
368
|
-
* Retrieve information for a system given the system
|
|
369
|
-
* Retrieve system details
|
|
413
|
+
* Retrieve information for a system given the system Id. Use query parameter authnMethod=<method> to override the default authentication method. Certain services 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 services may use the query parameter *sharedAppCtx* to indicate that the request is in a shared application context. Tapis authorization will be bypassed.
|
|
370
414
|
*/
|
|
371
415
|
SystemsApi.prototype.getSystem = function (requestParameters, initOverrides) {
|
|
372
416
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -383,8 +427,7 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
383
427
|
});
|
|
384
428
|
};
|
|
385
429
|
/**
|
|
386
|
-
* Retrieve list of systems. Use search and select query parameters to limit results.
|
|
387
|
-
* Retrieve systems
|
|
430
|
+
* Retrieve list of systems. Use *listType*, *search* 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.
|
|
388
431
|
*/
|
|
389
432
|
SystemsApi.prototype.getSystemsRaw = function (requestParameters, initOverrides) {
|
|
390
433
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -396,6 +439,9 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
396
439
|
if (requestParameters.search !== undefined) {
|
|
397
440
|
queryParameters['search'] = requestParameters.search;
|
|
398
441
|
}
|
|
442
|
+
if (requestParameters.listType !== undefined) {
|
|
443
|
+
queryParameters['listType'] = requestParameters.listType;
|
|
444
|
+
}
|
|
399
445
|
if (requestParameters.limit !== undefined) {
|
|
400
446
|
queryParameters['limit'] = requestParameters.limit;
|
|
401
447
|
}
|
|
@@ -435,8 +481,7 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
435
481
|
});
|
|
436
482
|
};
|
|
437
483
|
/**
|
|
438
|
-
* Retrieve list of systems. Use search and select query parameters to limit results.
|
|
439
|
-
* Retrieve systems
|
|
484
|
+
* Retrieve list of systems. Use *listType*, *search* 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.
|
|
440
485
|
*/
|
|
441
486
|
SystemsApi.prototype.getSystems = function (requestParameters, initOverrides) {
|
|
442
487
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -454,7 +499,6 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
454
499
|
};
|
|
455
500
|
/**
|
|
456
501
|
* Check if a system is currently enabled, i.e. available for use.
|
|
457
|
-
* Check if system is currently enabled
|
|
458
502
|
*/
|
|
459
503
|
SystemsApi.prototype.isEnabledRaw = function (requestParameters, initOverrides) {
|
|
460
504
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -485,7 +529,6 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
485
529
|
};
|
|
486
530
|
/**
|
|
487
531
|
* Check if a system is currently enabled, i.e. available for use.
|
|
488
|
-
* Check if system is currently enabled
|
|
489
532
|
*/
|
|
490
533
|
SystemsApi.prototype.isEnabled = function (requestParameters, initOverrides) {
|
|
491
534
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -503,7 +546,6 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
503
546
|
};
|
|
504
547
|
/**
|
|
505
548
|
* *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.
|
|
506
|
-
* Retrieve systems satisfying specified constraint conditions (WARNING - not yet supported)
|
|
507
549
|
*/
|
|
508
550
|
SystemsApi.prototype.matchConstraintsRaw = function (requestParameters, initOverrides) {
|
|
509
551
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -536,7 +578,6 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
536
578
|
};
|
|
537
579
|
/**
|
|
538
580
|
* *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.
|
|
539
|
-
* Retrieve systems satisfying specified constraint conditions (WARNING - not yet supported)
|
|
540
581
|
*/
|
|
541
582
|
SystemsApi.prototype.matchConstraints = function (requestParameters, initOverrides) {
|
|
542
583
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -554,7 +595,6 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
554
595
|
};
|
|
555
596
|
/**
|
|
556
597
|
* 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 - isDtn - canExec Note that the attributes owner and enabled may be modified using other endpoints.
|
|
557
|
-
* Update selected attributes of a system
|
|
558
598
|
*/
|
|
559
599
|
SystemsApi.prototype.patchSystemRaw = function (requestParameters, initOverrides) {
|
|
560
600
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -590,7 +630,6 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
590
630
|
};
|
|
591
631
|
/**
|
|
592
632
|
* 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 - isDtn - canExec Note that the attributes owner and enabled may be modified using other endpoints.
|
|
593
|
-
* Update selected attributes of a system
|
|
594
633
|
*/
|
|
595
634
|
SystemsApi.prototype.patchSystem = function (requestParameters, initOverrides) {
|
|
596
635
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -607,8 +646,7 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
607
646
|
});
|
|
608
647
|
};
|
|
609
648
|
/**
|
|
610
|
-
* Update all updatable attributes of a system using a request body identical to POST. System must exist.
|
|
611
|
-
* Update all updatable attributes of a system
|
|
649
|
+
* Update all updatable attributes of a system using a request body identical to POST. System must exist. 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. 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 - enabled - bucketName - rootDir - isDtn - canExec Note that the attributes owner and enabled may be modified using other endpoints.
|
|
612
650
|
*/
|
|
613
651
|
SystemsApi.prototype.putSystemRaw = function (requestParameters, initOverrides) {
|
|
614
652
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -646,8 +684,7 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
646
684
|
});
|
|
647
685
|
};
|
|
648
686
|
/**
|
|
649
|
-
* Update all updatable attributes of a system using a request body identical to POST. System must exist.
|
|
650
|
-
* Update all updatable attributes of a system
|
|
687
|
+
* Update all updatable attributes of a system using a request body identical to POST. System must exist. 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. 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 - enabled - bucketName - rootDir - isDtn - canExec Note that the attributes owner and enabled may be modified using other endpoints.
|
|
651
688
|
*/
|
|
652
689
|
SystemsApi.prototype.putSystem = function (requestParameters, initOverrides) {
|
|
653
690
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -664,8 +701,7 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
664
701
|
});
|
|
665
702
|
};
|
|
666
703
|
/**
|
|
667
|
-
* Retrieve details for systems. Use query parameters to specify search conditions. For example owner.eq=jdoe&port.gt=1024
|
|
668
|
-
* Retrieve list of systems matching search conditions specified as query parameters
|
|
704
|
+
* 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.
|
|
669
705
|
*/
|
|
670
706
|
SystemsApi.prototype.searchSystemsQueryParametersRaw = function (requestParameters, initOverrides) {
|
|
671
707
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -677,6 +713,9 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
677
713
|
if (requestParameters.freeFormParameterName !== undefined) {
|
|
678
714
|
queryParameters['freeFormParameterName'] = requestParameters.freeFormParameterName;
|
|
679
715
|
}
|
|
716
|
+
if (requestParameters.listType !== undefined) {
|
|
717
|
+
queryParameters['listType'] = requestParameters.listType;
|
|
718
|
+
}
|
|
680
719
|
if (requestParameters.limit !== undefined) {
|
|
681
720
|
queryParameters['limit'] = requestParameters.limit;
|
|
682
721
|
}
|
|
@@ -713,8 +752,7 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
713
752
|
});
|
|
714
753
|
};
|
|
715
754
|
/**
|
|
716
|
-
* Retrieve details for systems. Use query parameters to specify search conditions. For example owner.eq=jdoe&port.gt=1024
|
|
717
|
-
* Retrieve list of systems matching search conditions specified as query parameters
|
|
755
|
+
* 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.
|
|
718
756
|
*/
|
|
719
757
|
SystemsApi.prototype.searchSystemsQueryParameters = function (requestParameters, initOverrides) {
|
|
720
758
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -731,8 +769,7 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
731
769
|
});
|
|
732
770
|
};
|
|
733
771
|
/**
|
|
734
|
-
* Retrieve details for systems. Use request body to specify SQL-like search conditions.
|
|
735
|
-
* Retrieve list of systems matching search conditions
|
|
772
|
+
* 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.
|
|
736
773
|
*/
|
|
737
774
|
SystemsApi.prototype.searchSystemsRequestBodyRaw = function (requestParameters, initOverrides) {
|
|
738
775
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -744,6 +781,9 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
744
781
|
throw new runtime.RequiredError('reqSearchSystems', 'Required parameter requestParameters.reqSearchSystems was null or undefined when calling searchSystemsRequestBody.');
|
|
745
782
|
}
|
|
746
783
|
queryParameters = {};
|
|
784
|
+
if (requestParameters.listType !== undefined) {
|
|
785
|
+
queryParameters['listType'] = requestParameters.listType;
|
|
786
|
+
}
|
|
747
787
|
if (requestParameters.limit !== undefined) {
|
|
748
788
|
queryParameters['limit'] = requestParameters.limit;
|
|
749
789
|
}
|
|
@@ -782,8 +822,7 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
782
822
|
});
|
|
783
823
|
};
|
|
784
824
|
/**
|
|
785
|
-
* Retrieve details for systems. Use request body to specify SQL-like search conditions.
|
|
786
|
-
* Retrieve list of systems matching search conditions
|
|
825
|
+
* 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.
|
|
787
826
|
*/
|
|
788
827
|
SystemsApi.prototype.searchSystemsRequestBody = function (requestParameters, initOverrides) {
|
|
789
828
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -801,7 +840,6 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
801
840
|
};
|
|
802
841
|
/**
|
|
803
842
|
* Mark a system as not deleted. System will appear in queries.
|
|
804
|
-
* Mark a system as not deleted
|
|
805
843
|
*/
|
|
806
844
|
SystemsApi.prototype.undeleteSystemRaw = function (requestParameters, initOverrides) {
|
|
807
845
|
return __awaiter(this, void 0, void 0, function () {
|
|
@@ -832,7 +870,6 @@ var SystemsApi = /** @class */ (function (_super) {
|
|
|
832
870
|
};
|
|
833
871
|
/**
|
|
834
872
|
* Mark a system as not deleted. System will appear in queries.
|
|
835
|
-
* Mark a system as not deleted
|
|
836
873
|
*/
|
|
837
874
|
SystemsApi.prototype.undeleteSystem = function (requestParameters, initOverrides) {
|
|
838
875
|
return __awaiter(this, void 0, void 0, function () {
|