@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.
- package/.openapi-generator/FILES +19 -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 +51 -15
- package/dist/apis/CredentialsApi.js +170 -16
- package/dist/apis/GeneralApi.d.ts +5 -5
- package/dist/apis/GeneralApi.js +5 -11
- 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 +36 -46
- package/dist/apis/SystemsApi.js +89 -49
- 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/KeyValueInputModeEnum.d.ts +25 -0
- package/dist/models/KeyValueInputModeEnum.js +39 -0
- package/dist/models/KeyValuePair.d.ts +20 -1
- package/dist/models/KeyValuePair.js +8 -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 +18 -18
- package/dist/models/ReqPatchSystem.js +7 -7
- 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/ReqPostSystem.d.ts +220 -0
- package/dist/models/{ReqCreateSystem.js → ReqPostSystem.js} +16 -18
- package/dist/models/ReqPutSystem.d.ts +21 -21
- package/dist/models/ReqPutSystem.js +9 -9
- 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 +39 -0
- package/dist/models/ResultGlobusAuthUrl.js +45 -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 +3 -2
- package/dist/models/RuntimeTypeEnum.js +2 -1
- package/dist/models/SchedulerHiddenOptionEnum.d.ts +1 -1
- package/dist/models/SchedulerHiddenOptionEnum.js +1 -1
- package/dist/models/SchedulerProfile.d.ts +5 -11
- 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 +2 -2
- package/dist/models/SystemTypeEnum.js +2 -2
- package/dist/models/TapisSystem.d.ts +38 -26
- package/dist/models/TapisSystem.js +15 -11
- package/dist/models/index.d.ts +17 -3
- package/dist/models/index.js +17 -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 +160 -20
- package/src/apis/GeneralApi.ts +5 -13
- 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 +106 -55
- 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/KeyValueInputModeEnum.ts +38 -0
- package/src/models/KeyValuePair.ts +32 -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 +24 -24
- 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} +21 -25
- package/src/models/{ReqCreateSystem.ts → ReqPostSystem.ts} +77 -85
- package/src/models/ReqPutSystem.ts +32 -32
- 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 +72 -0
- package/src/models/ResultNameArray.ts +1 -1
- package/src/models/ResultResourceUrl.ts +1 -1
- package/src/models/RuntimeTypeEnum.ts +3 -2
- package/src/models/SchedulerHiddenOptionEnum.ts +1 -1
- package/src/models/SchedulerProfile.ts +10 -14
- 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 +2 -2
- package/src/models/TapisSystem.ts +52 -36
- package/src/models/index.ts +17 -3
- package/src/runtime.ts +1 -1
- package/dist/models/ReqCreateCredential.d.ts +0 -57
- package/dist/models/ReqCreateSchedulerProfile.d.ts +0 -58
- package/dist/models/ReqCreateSystem.d.ts +0 -226
|
@@ -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.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,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;
|
|
@@ -44,6 +51,7 @@ export interface GetSystemsRequest {
|
|
|
44
51
|
computeTotal?: boolean;
|
|
45
52
|
select?: string;
|
|
46
53
|
showDeleted?: boolean;
|
|
54
|
+
impersonationId?: string;
|
|
47
55
|
}
|
|
48
56
|
export interface IsEnabledRequest {
|
|
49
57
|
systemId: string;
|
|
@@ -64,6 +72,7 @@ export interface SearchSystemsQueryParametersRequest {
|
|
|
64
72
|
freeFormParameterName?: {
|
|
65
73
|
[key: string]: string;
|
|
66
74
|
};
|
|
75
|
+
listType?: ListTypeEnum;
|
|
67
76
|
limit?: number;
|
|
68
77
|
orderBy?: string;
|
|
69
78
|
skip?: number;
|
|
@@ -73,6 +82,7 @@ export interface SearchSystemsQueryParametersRequest {
|
|
|
73
82
|
}
|
|
74
83
|
export interface SearchSystemsRequestBodyRequest {
|
|
75
84
|
reqSearchSystems: ReqSearchSystems;
|
|
85
|
+
listType?: ListTypeEnum;
|
|
76
86
|
limit?: number;
|
|
77
87
|
orderBy?: string;
|
|
78
88
|
skip?: number;
|
|
@@ -89,142 +99,122 @@ export interface UndeleteSystemRequest {
|
|
|
89
99
|
export declare class SystemsApi extends runtime.BaseAPI {
|
|
90
100
|
/**
|
|
91
101
|
* Change owner of a system.
|
|
92
|
-
* Change system owner
|
|
93
102
|
*/
|
|
94
103
|
changeSystemOwnerRaw(requestParameters: ChangeSystemOwnerRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>>;
|
|
95
104
|
/**
|
|
96
105
|
* Change owner of a system.
|
|
97
|
-
* Change system owner
|
|
98
106
|
*/
|
|
99
107
|
changeSystemOwner(requestParameters: ChangeSystemOwnerRequest, initOverrides?: RequestInit): Promise<RespChangeCount>;
|
|
100
108
|
/**
|
|
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
|
|
102
|
-
* Create a system
|
|
109
|
+
* Create a system using a request body. System name must be unique within a tenant and can be composed of alphanumeric characters and the following special characters [-._~]. Name must begin with an alphanumeric character and can be no more than 80 characters in length. Description is optional with a maximum length of 2048 characters. The attribute *host* represents a host name, IP address, Globus Endpoint Id or Globus Collection Id. The attribute *effectiveUserId* determines the host login user, the user used to access the underlying host. The attribute can be set to a static string indicating a specific user (such as a service account) or dynamically specified as *${apiUserId}*. For the case of *${apiUserId}*, the service resolves the variable by extracting the identity from the request to the service (i.e. the JWT) and applying a mapping to a host login user if such a mapping has been provided. If no mapping is provided, then the extracted identity is taken to be the host login user. If the *effectiveUserId* is static (i.e. not *${apiUserId}*) then credentials may optionally be provided in the *authnCredential* attribute of the request body. The Systems service does not store the secrets in its database, they are persisted in the Security Kernel. By default for LINUX and S3 type systems credentials provided are verified. Use query parameter skipCredentialCheck=true to bypass initial verification of credentials. The attribute *rootDir* serves as an effective root directory when operating on files through the Tapis Files service. All paths are relative to this directory when using Files to list, copy, move, mkdir, etc. Required for systems of type LINUX or IRODS. Supports the following variables which are resolved at create time: *${apiUserId}*, *${tenant}* and *${owner}*. May not be updated. Contact support to request a change. There is also a special macro available for *rootDir* that may be used under certain conditions when a system is first created. The macro name is HOST_EVAL. The syntax for the macro is HOST_EVAL($var), where *var* is the environment variable to be evaluated on the system host when the create request is made. Note that the $ character preceding the environment variable name is optional. If after resolution the final path does not have the required leading slash (/) to make it an absolute path, then one will be prepended. The following conditions must be met in order to use the macro - System must be of type LINUX - Credentials must be provided when system is created. - Macro HOST_EVAL() must only appear once and must be the first element of the path. Including a leading slash is optional. - The *effectiveUserId* for the system must be static. Note that *effectiveUserId* may be set to *${owner}*. Here are some examples - HOST_EVAL($SCRATCH) - HOST_EVAL($HOME) - /HOST_EVAL(MY_ROOT_DIR)/scratch - /HOST_EVAL($PROJECT_HOME)/projects/${tenant}/${owner} Note that certain attributes in the request body (such as tenant) are allowed but ignored so that the JSON result returned by a GET may be modified and used when making a POST request to create a system. The attributes that are allowed but ignored are - tenant - uuid - deleted - created - updated
|
|
103
110
|
*/
|
|
104
111
|
createSystemRaw(requestParameters: CreateSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespResourceUrl>>;
|
|
105
112
|
/**
|
|
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
|
|
107
|
-
* Create a system
|
|
113
|
+
* Create a system using a request body. System name must be unique within a tenant and can be composed of alphanumeric characters and the following special characters [-._~]. Name must begin with an alphanumeric character and can be no more than 80 characters in length. Description is optional with a maximum length of 2048 characters. The attribute *host* represents a host name, IP address, Globus Endpoint Id or Globus Collection Id. The attribute *effectiveUserId* determines the host login user, the user used to access the underlying host. The attribute can be set to a static string indicating a specific user (such as a service account) or dynamically specified as *${apiUserId}*. For the case of *${apiUserId}*, the service resolves the variable by extracting the identity from the request to the service (i.e. the JWT) and applying a mapping to a host login user if such a mapping has been provided. If no mapping is provided, then the extracted identity is taken to be the host login user. If the *effectiveUserId* is static (i.e. not *${apiUserId}*) then credentials may optionally be provided in the *authnCredential* attribute of the request body. The Systems service does not store the secrets in its database, they are persisted in the Security Kernel. By default for LINUX and S3 type systems credentials provided are verified. Use query parameter skipCredentialCheck=true to bypass initial verification of credentials. The attribute *rootDir* serves as an effective root directory when operating on files through the Tapis Files service. All paths are relative to this directory when using Files to list, copy, move, mkdir, etc. Required for systems of type LINUX or IRODS. Supports the following variables which are resolved at create time: *${apiUserId}*, *${tenant}* and *${owner}*. May not be updated. Contact support to request a change. There is also a special macro available for *rootDir* that may be used under certain conditions when a system is first created. The macro name is HOST_EVAL. The syntax for the macro is HOST_EVAL($var), where *var* is the environment variable to be evaluated on the system host when the create request is made. Note that the $ character preceding the environment variable name is optional. If after resolution the final path does not have the required leading slash (/) to make it an absolute path, then one will be prepended. The following conditions must be met in order to use the macro - System must be of type LINUX - Credentials must be provided when system is created. - Macro HOST_EVAL() must only appear once and must be the first element of the path. Including a leading slash is optional. - The *effectiveUserId* for the system must be static. Note that *effectiveUserId* may be set to *${owner}*. Here are some examples - HOST_EVAL($SCRATCH) - HOST_EVAL($HOME) - /HOST_EVAL(MY_ROOT_DIR)/scratch - /HOST_EVAL($PROJECT_HOME)/projects/${tenant}/${owner} Note that certain attributes in the request body (such as tenant) are allowed but ignored so that the JSON result returned by a GET may be modified and used when making a POST request to create a system. The attributes that are allowed but ignored are - tenant - uuid - deleted - created - updated
|
|
108
114
|
*/
|
|
109
115
|
createSystem(requestParameters: CreateSystemRequest, initOverrides?: RequestInit): Promise<RespResourceUrl>;
|
|
110
116
|
/**
|
|
111
117
|
* Mark a system as deleted. System will not appear in queries unless explicitly requested.
|
|
112
|
-
* Mark a system as deleted
|
|
113
118
|
*/
|
|
114
119
|
deleteSystemRaw(requestParameters: DeleteSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>>;
|
|
115
120
|
/**
|
|
116
121
|
* Mark a system as deleted. System will not appear in queries unless explicitly requested.
|
|
117
|
-
* Mark a system as deleted
|
|
118
122
|
*/
|
|
119
123
|
deleteSystem(requestParameters: DeleteSystemRequest, initOverrides?: RequestInit): Promise<RespChangeCount>;
|
|
120
124
|
/**
|
|
121
125
|
* Mark a system unavailable for use.
|
|
122
|
-
* Mark a system unavailabe for use
|
|
123
126
|
*/
|
|
124
127
|
disableSystemRaw(requestParameters: DisableSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>>;
|
|
125
128
|
/**
|
|
126
129
|
* Mark a system unavailable for use.
|
|
127
|
-
* Mark a system unavailabe for use
|
|
128
130
|
*/
|
|
129
131
|
disableSystem(requestParameters: DisableSystemRequest, initOverrides?: RequestInit): Promise<RespChangeCount>;
|
|
130
132
|
/**
|
|
131
133
|
* Mark a system available for use.
|
|
132
|
-
* Mark a system availabe for use
|
|
133
134
|
*/
|
|
134
135
|
enableSystemRaw(requestParameters: EnableSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>>;
|
|
135
136
|
/**
|
|
136
137
|
* Mark a system available for use.
|
|
137
|
-
* Mark a system availabe for use
|
|
138
138
|
*/
|
|
139
139
|
enableSystem(requestParameters: EnableSystemRequest, initOverrides?: RequestInit): Promise<RespChangeCount>;
|
|
140
140
|
/**
|
|
141
|
-
* Retrieve
|
|
142
|
-
|
|
141
|
+
* Retrieve history of changes for a given systemId.
|
|
142
|
+
*/
|
|
143
|
+
getHistoryRaw(requestParameters: GetHistoryRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSystemHistory>>;
|
|
144
|
+
/**
|
|
145
|
+
* Retrieve history of changes for a given systemId.
|
|
146
|
+
*/
|
|
147
|
+
getHistory(requestParameters: GetHistoryRequest, initOverrides?: RequestInit): Promise<RespSystemHistory>;
|
|
148
|
+
/**
|
|
149
|
+
* Retrieve information for a system given the system Id. Use query parameter *authnMethod* to override the default authentication method. Certain Tapis services or a tenant administrator may use the query parameter *impersonationId* to be used in place of the requesting Tapis user. Tapis will use this user Id when performing authorization and resolving the *effectiveUserId*. Certain Tapis services may use the query parameter *sharedAppCtx* to indicate that the request is in a shared application context.
|
|
143
150
|
*/
|
|
144
151
|
getSystemRaw(requestParameters: GetSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSystem>>;
|
|
145
152
|
/**
|
|
146
|
-
* Retrieve information for a system given the system
|
|
147
|
-
* Retrieve system details
|
|
153
|
+
* Retrieve information for a system given the system Id. Use query parameter *authnMethod* to override the default authentication method. Certain Tapis services or a tenant administrator may use the query parameter *impersonationId* to be used in place of the requesting Tapis user. Tapis will use this user Id when performing authorization and resolving the *effectiveUserId*. Certain Tapis services may use the query parameter *sharedAppCtx* to indicate that the request is in a shared application context.
|
|
148
154
|
*/
|
|
149
155
|
getSystem(requestParameters: GetSystemRequest, initOverrides?: RequestInit): Promise<RespSystem>;
|
|
150
156
|
/**
|
|
151
|
-
* Retrieve list of systems.
|
|
152
|
-
* Retrieve systems
|
|
157
|
+
* 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. Certain Tapis services or a tenant administrator may use the query parameter *impersonationId* to be used in place of the requesting Tapis user. Tapis will use this user Id when performing authorization and resolving the *effectiveUserId*.
|
|
153
158
|
*/
|
|
154
159
|
getSystemsRaw(requestParameters: GetSystemsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSystems>>;
|
|
155
160
|
/**
|
|
156
|
-
* Retrieve list of systems.
|
|
157
|
-
* Retrieve systems
|
|
161
|
+
* 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. Certain Tapis services or a tenant administrator may use the query parameter *impersonationId* to be used in place of the requesting Tapis user. Tapis will use this user Id when performing authorization and resolving the *effectiveUserId*.
|
|
158
162
|
*/
|
|
159
163
|
getSystems(requestParameters: GetSystemsRequest, initOverrides?: RequestInit): Promise<RespSystems>;
|
|
160
164
|
/**
|
|
161
165
|
* Check if a system is currently enabled, i.e. available for use.
|
|
162
|
-
* Check if system is currently enabled
|
|
163
166
|
*/
|
|
164
167
|
isEnabledRaw(requestParameters: IsEnabledRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespBoolean>>;
|
|
165
168
|
/**
|
|
166
169
|
* Check if a system is currently enabled, i.e. available for use.
|
|
167
|
-
* Check if system is currently enabled
|
|
168
170
|
*/
|
|
169
171
|
isEnabled(requestParameters: IsEnabledRequest, initOverrides?: RequestInit): Promise<RespBoolean>;
|
|
170
172
|
/**
|
|
171
173
|
* *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
174
|
*/
|
|
174
175
|
matchConstraintsRaw(requestParameters: MatchConstraintsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSystems>>;
|
|
175
176
|
/**
|
|
176
177
|
* *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
178
|
*/
|
|
179
179
|
matchConstraints(requestParameters: MatchConstraintsRequest, initOverrides?: RequestInit): Promise<RespSystems>;
|
|
180
180
|
/**
|
|
181
|
-
* 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 -
|
|
182
|
-
* Update selected attributes of a system
|
|
181
|
+
* Update selected attributes of a system. Request body may only contain updatable attributes. System must exist. Attributes that may not be updated via PATCH are - id - systemType - owner - enabled - bucketName - rootDir - canExec Note that the attributes owner and enabled may be modified using other endpoints.
|
|
183
182
|
*/
|
|
184
183
|
patchSystemRaw(requestParameters: PatchSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespResourceUrl>>;
|
|
185
184
|
/**
|
|
186
|
-
* 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 -
|
|
187
|
-
* Update selected attributes of a system
|
|
185
|
+
* Update selected attributes of a system. Request body may only contain updatable attributes. System must exist. Attributes that may not be updated via PATCH are - id - systemType - owner - enabled - bucketName - rootDir - canExec Note that the attributes owner and enabled may be modified using other endpoints.
|
|
188
186
|
*/
|
|
189
187
|
patchSystem(requestParameters: PatchSystemRequest, initOverrides?: RequestInit): Promise<RespResourceUrl>;
|
|
190
188
|
/**
|
|
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
|
|
189
|
+
* 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 - canExec Note that the attributes owner and enabled may be modified using other endpoints.
|
|
193
190
|
*/
|
|
194
191
|
putSystemRaw(requestParameters: PutSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespResourceUrl>>;
|
|
195
192
|
/**
|
|
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
|
|
193
|
+
* 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 - canExec Note that the attributes owner and enabled may be modified using other endpoints.
|
|
198
194
|
*/
|
|
199
195
|
putSystem(requestParameters: PutSystemRequest, initOverrides?: RequestInit): Promise<RespResourceUrl>;
|
|
200
196
|
/**
|
|
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
|
|
197
|
+
* Retrieve details for systems. Use query parameters to specify search conditions. For example owner.eq=jdoe&port.gt=1024 Use *listType* and *select* query parameters to limit results. Query parameter *listType* allows for filtering results based on authorization. Options for *listType* are - *OWNED* Include only items owned by requester (Default) - *SHARED_PUBLIC* Include only items shared publicly - *ALL* Include all items requester is authorized to view. Includes check for READ or MODIFY permission.
|
|
203
198
|
*/
|
|
204
199
|
searchSystemsQueryParametersRaw(requestParameters: SearchSystemsQueryParametersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSystems>>;
|
|
205
200
|
/**
|
|
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
|
|
201
|
+
* Retrieve details for systems. Use query parameters to specify search conditions. For example owner.eq=jdoe&port.gt=1024 Use *listType* and *select* query parameters to limit results. Query parameter *listType* allows for filtering results based on authorization. Options for *listType* are - *OWNED* Include only items owned by requester (Default) - *SHARED_PUBLIC* Include only items shared publicly - *ALL* Include all items requester is authorized to view. Includes check for READ or MODIFY permission.
|
|
208
202
|
*/
|
|
209
203
|
searchSystemsQueryParameters(requestParameters: SearchSystemsQueryParametersRequest, initOverrides?: RequestInit): Promise<RespSystems>;
|
|
210
204
|
/**
|
|
211
|
-
* Retrieve details for systems. Use request body to specify SQL-like search conditions.
|
|
212
|
-
* Retrieve list of systems matching search conditions
|
|
205
|
+
* Retrieve details for systems. Use request body to specify SQL-like search conditions. Use *listType* and *select* query parameters to limit results. Query parameter *listType* allows for filtering results based on authorization. Options for *listType* are - *OWNED* Include only items owned by requester (Default) - *SHARED_PUBLIC* Include only items shared publicly - *ALL* Include all items requester is authorized to view. Includes check for READ or MODIFY permission.
|
|
213
206
|
*/
|
|
214
207
|
searchSystemsRequestBodyRaw(requestParameters: SearchSystemsRequestBodyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespSystems>>;
|
|
215
208
|
/**
|
|
216
|
-
* Retrieve details for systems. Use request body to specify SQL-like search conditions.
|
|
217
|
-
* Retrieve list of systems matching search conditions
|
|
209
|
+
* Retrieve details for systems. Use request body to specify SQL-like search conditions. Use *listType* and *select* query parameters to limit results. Query parameter *listType* allows for filtering results based on authorization. Options for *listType* are - *OWNED* Include only items owned by requester (Default) - *SHARED_PUBLIC* Include only items shared publicly - *ALL* Include all items requester is authorized to view. Includes check for READ or MODIFY permission.
|
|
218
210
|
*/
|
|
219
211
|
searchSystemsRequestBody(requestParameters: SearchSystemsRequestBodyRequest, initOverrides?: RequestInit): Promise<RespSystems>;
|
|
220
212
|
/**
|
|
221
213
|
* Mark a system as not deleted. System will appear in queries.
|
|
222
|
-
* Mark a system as not deleted
|
|
223
214
|
*/
|
|
224
215
|
undeleteSystemRaw(requestParameters: UndeleteSystemRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RespChangeCount>>;
|
|
225
216
|
/**
|
|
226
217
|
* Mark a system as not deleted. System will appear in queries.
|
|
227
|
-
* Mark a system as not deleted
|
|
228
218
|
*/
|
|
229
219
|
undeleteSystem(requestParameters: UndeleteSystemRequest, initOverrides?: RequestInit): Promise<RespChangeCount>;
|
|
230
220
|
}
|