@cosmotech/api-ts 5.0.0-beta5 → 5.0.0-rc1
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/.github/workflows/publish.yaml +10 -8
- package/.github/workflows/track_dependencies.yml +3 -0
- package/.openapi-generator/FILES +1 -7
- package/README.md +4 -12
- package/api.ts +160 -482
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +159 -381
- package/dist/api.js +64 -271
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/Dataset.md +4 -2
- package/docs/DatasetApi.md +34 -15
- package/docs/DatasetCreateInfo.md +24 -0
- package/docs/DatasetCreateRequest.md +2 -2
- package/docs/DatasetEditInfo.md +22 -0
- package/docs/DatasetPart.md +4 -2
- package/docs/DatasetPartCreateRequest.md +2 -0
- package/docs/DatasetPartUpdateRequest.md +2 -0
- package/docs/DatasetUpdateRequest.md +2 -0
- package/docs/RunApi.md +0 -129
- package/docs/RunData.md +1 -1
- package/docs/RunTemplateParameter.md +2 -4
- package/docs/RunTemplateParameterCreateRequest.md +2 -4
- package/docs/RunTemplateParameterGroup.md +2 -6
- package/docs/RunTemplateParameterGroupCreateRequest.md +2 -6
- package/docs/RunTemplateParameterGroupUpdateRequest.md +2 -6
- package/docs/RunTemplateParameterUpdateRequest.md +2 -4
- package/docs/Runner.md +3 -3
- package/docs/RunnerCreateRequest.md +2 -2
- package/docs/RunnerUpdateRequest.md +2 -2
- package/docs/SendRunDataRequest.md +2 -3
- package/docs/Workspace.md +2 -2
- package/docs/WorkspaceCreateRequest.md +2 -2
- package/docs/WorkspaceSolution.md +0 -4
- package/docs/WorkspaceUpdateRequest.md +2 -2
- package/git_push.sh +2 -2
- package/index.ts +1 -1
- package/package.json +2 -2
|
@@ -1,22 +1,24 @@
|
|
|
1
1
|
name: Node.js Package on npm
|
|
2
|
+
|
|
2
3
|
on:
|
|
3
4
|
release:
|
|
4
5
|
types: [created]
|
|
6
|
+
|
|
7
|
+
permissions:
|
|
8
|
+
contents: read
|
|
9
|
+
id-token: write
|
|
10
|
+
|
|
5
11
|
jobs:
|
|
6
12
|
build:
|
|
7
13
|
name: Build & Publish
|
|
8
14
|
runs-on: ubuntu-latest
|
|
9
15
|
steps:
|
|
10
|
-
- uses: actions/checkout@
|
|
11
|
-
- uses: actions/setup-node@
|
|
16
|
+
- uses: actions/checkout@v5
|
|
17
|
+
- uses: actions/setup-node@v6
|
|
12
18
|
with:
|
|
13
|
-
node-version: '
|
|
19
|
+
node-version: '24'
|
|
14
20
|
registry-url: 'https://registry.npmjs.org'
|
|
15
21
|
scope: '@cosmotech'
|
|
16
22
|
- run: npm version ${{ github.event.release.tag_name }} --allow-same-version --no-git-tag-version
|
|
17
23
|
- run: npm install
|
|
18
|
-
- run: npm publish
|
|
19
|
-
env:
|
|
20
|
-
NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
|
|
21
|
-
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
|
22
|
-
NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
|
|
24
|
+
- run: npm publish --tag ${{ github.event.release.prerelease && 'prerelease' || 'latest' }}
|
package/.openapi-generator/FILES
CHANGED
|
@@ -11,12 +11,12 @@ docs/AboutInfoVersion.md
|
|
|
11
11
|
docs/ComponentRolePermissions.md
|
|
12
12
|
docs/ContainerResourceSizeInfo.md
|
|
13
13
|
docs/ContainerResourceSizing.md
|
|
14
|
-
docs/CreateInfo.md
|
|
15
14
|
docs/CreatedRun.md
|
|
16
15
|
docs/Dataset.md
|
|
17
16
|
docs/DatasetAccessControl.md
|
|
18
17
|
docs/DatasetApi.md
|
|
19
18
|
docs/DatasetCreateRequest.md
|
|
19
|
+
docs/DatasetEditInfo.md
|
|
20
20
|
docs/DatasetPart.md
|
|
21
21
|
docs/DatasetPartCreateRequest.md
|
|
22
22
|
docs/DatasetPartTypeEnum.md
|
|
@@ -24,7 +24,6 @@ docs/DatasetPartUpdateRequest.md
|
|
|
24
24
|
docs/DatasetRole.md
|
|
25
25
|
docs/DatasetSecurity.md
|
|
26
26
|
docs/DatasetUpdateRequest.md
|
|
27
|
-
docs/EditInfo.md
|
|
28
27
|
docs/LastRunInfo.md
|
|
29
28
|
docs/MetaApi.md
|
|
30
29
|
docs/Organization.md
|
|
@@ -35,13 +34,10 @@ docs/OrganizationEditInfo.md
|
|
|
35
34
|
docs/OrganizationRole.md
|
|
36
35
|
docs/OrganizationSecurity.md
|
|
37
36
|
docs/OrganizationUpdateRequest.md
|
|
38
|
-
docs/QueryResult.md
|
|
39
37
|
docs/ResourceSizeInfo.md
|
|
40
38
|
docs/Run.md
|
|
41
39
|
docs/RunApi.md
|
|
42
40
|
docs/RunContainer.md
|
|
43
|
-
docs/RunData.md
|
|
44
|
-
docs/RunDataQuery.md
|
|
45
41
|
docs/RunEditInfo.md
|
|
46
42
|
docs/RunResourceRequested.md
|
|
47
43
|
docs/RunState.md
|
|
@@ -70,7 +66,6 @@ docs/RunnerRunTemplateParameterValue.md
|
|
|
70
66
|
docs/RunnerSecurity.md
|
|
71
67
|
docs/RunnerUpdateRequest.md
|
|
72
68
|
docs/RunnerValidationStatus.md
|
|
73
|
-
docs/SendRunDataRequest.md
|
|
74
69
|
docs/Solution.md
|
|
75
70
|
docs/SolutionAccessControl.md
|
|
76
71
|
docs/SolutionApi.md
|
|
@@ -89,7 +84,6 @@ docs/WorkspaceRole.md
|
|
|
89
84
|
docs/WorkspaceSecurity.md
|
|
90
85
|
docs/WorkspaceSolution.md
|
|
91
86
|
docs/WorkspaceUpdateRequest.md
|
|
92
|
-
docs/WorkspaceWebApp.md
|
|
93
87
|
git_push.sh
|
|
94
88
|
index.ts
|
|
95
89
|
package.json
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @cosmotech/api-ts@5.0.
|
|
1
|
+
## @cosmotech/api-ts@5.0.0-rc1
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @cosmotech/api-ts@5.0.
|
|
39
|
+
npm install @cosmotech/api-ts@5.0.0-rc1 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -64,7 +64,7 @@ Class | Method | HTTP request | Description
|
|
|
64
64
|
*DatasetApi* | [**listDatasetParts**](docs/DatasetApi.md#listdatasetparts) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts | Retrieve all dataset parts of a Dataset
|
|
65
65
|
*DatasetApi* | [**listDatasetSecurityUsers**](docs/DatasetApi.md#listdatasetsecurityusers) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/users | Get the Dataset security users list
|
|
66
66
|
*DatasetApi* | [**listDatasets**](docs/DatasetApi.md#listdatasets) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets | Retrieve a list of defined Dataset
|
|
67
|
-
*DatasetApi* | [**queryData**](docs/DatasetApi.md#querydata) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id}/query |
|
|
67
|
+
*DatasetApi* | [**queryData**](docs/DatasetApi.md#querydata) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id}/query | Query data of a Dataset part. This endpoint is only available for dataset parts that support queries (type == DB).
|
|
68
68
|
*DatasetApi* | [**replaceDatasetPart**](docs/DatasetApi.md#replacedatasetpart) | **PUT** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id} | Replace existing dataset parts of a Dataset
|
|
69
69
|
*DatasetApi* | [**searchDatasetParts**](docs/DatasetApi.md#searchdatasetparts) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/search | Search Dataset parts by tags
|
|
70
70
|
*DatasetApi* | [**searchDatasets**](docs/DatasetApi.md#searchdatasets) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/search | Search Datasets by tags
|
|
@@ -92,8 +92,6 @@ Class | Method | HTTP request | Description
|
|
|
92
92
|
*RunApi* | [**getRunLogs**](docs/RunApi.md#getrunlogs) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/logs | get the logs for the Run
|
|
93
93
|
*RunApi* | [**getRunStatus**](docs/RunApi.md#getrunstatus) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/status | get the status for the Run
|
|
94
94
|
*RunApi* | [**listRuns**](docs/RunApi.md#listruns) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs | get the list of Runs for the Runner
|
|
95
|
-
*RunApi* | [**queryRunData**](docs/RunApi.md#queryrundata) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/data/query | query the run data
|
|
96
|
-
*RunApi* | [**sendRunData**](docs/RunApi.md#sendrundata) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/data/send | Send data associated to a run
|
|
97
95
|
*RunnerApi* | [**createRunner**](docs/RunnerApi.md#createrunner) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners | Create a new Runner
|
|
98
96
|
*RunnerApi* | [**createRunnerAccessControl**](docs/RunnerApi.md#createrunneraccesscontrol) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access | Add a control access to the Runner
|
|
99
97
|
*RunnerApi* | [**deleteRunner**](docs/RunnerApi.md#deleterunner) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Delete a runner
|
|
@@ -163,11 +161,11 @@ Class | Method | HTTP request | Description
|
|
|
163
161
|
- [ComponentRolePermissions](docs/ComponentRolePermissions.md)
|
|
164
162
|
- [ContainerResourceSizeInfo](docs/ContainerResourceSizeInfo.md)
|
|
165
163
|
- [ContainerResourceSizing](docs/ContainerResourceSizing.md)
|
|
166
|
-
- [CreateInfo](docs/CreateInfo.md)
|
|
167
164
|
- [CreatedRun](docs/CreatedRun.md)
|
|
168
165
|
- [Dataset](docs/Dataset.md)
|
|
169
166
|
- [DatasetAccessControl](docs/DatasetAccessControl.md)
|
|
170
167
|
- [DatasetCreateRequest](docs/DatasetCreateRequest.md)
|
|
168
|
+
- [DatasetEditInfo](docs/DatasetEditInfo.md)
|
|
171
169
|
- [DatasetPart](docs/DatasetPart.md)
|
|
172
170
|
- [DatasetPartCreateRequest](docs/DatasetPartCreateRequest.md)
|
|
173
171
|
- [DatasetPartTypeEnum](docs/DatasetPartTypeEnum.md)
|
|
@@ -175,7 +173,6 @@ Class | Method | HTTP request | Description
|
|
|
175
173
|
- [DatasetRole](docs/DatasetRole.md)
|
|
176
174
|
- [DatasetSecurity](docs/DatasetSecurity.md)
|
|
177
175
|
- [DatasetUpdateRequest](docs/DatasetUpdateRequest.md)
|
|
178
|
-
- [EditInfo](docs/EditInfo.md)
|
|
179
176
|
- [LastRunInfo](docs/LastRunInfo.md)
|
|
180
177
|
- [Organization](docs/Organization.md)
|
|
181
178
|
- [OrganizationAccessControl](docs/OrganizationAccessControl.md)
|
|
@@ -184,12 +181,9 @@ Class | Method | HTTP request | Description
|
|
|
184
181
|
- [OrganizationRole](docs/OrganizationRole.md)
|
|
185
182
|
- [OrganizationSecurity](docs/OrganizationSecurity.md)
|
|
186
183
|
- [OrganizationUpdateRequest](docs/OrganizationUpdateRequest.md)
|
|
187
|
-
- [QueryResult](docs/QueryResult.md)
|
|
188
184
|
- [ResourceSizeInfo](docs/ResourceSizeInfo.md)
|
|
189
185
|
- [Run](docs/Run.md)
|
|
190
186
|
- [RunContainer](docs/RunContainer.md)
|
|
191
|
-
- [RunData](docs/RunData.md)
|
|
192
|
-
- [RunDataQuery](docs/RunDataQuery.md)
|
|
193
187
|
- [RunEditInfo](docs/RunEditInfo.md)
|
|
194
188
|
- [RunResourceRequested](docs/RunResourceRequested.md)
|
|
195
189
|
- [RunState](docs/RunState.md)
|
|
@@ -217,7 +211,6 @@ Class | Method | HTTP request | Description
|
|
|
217
211
|
- [RunnerSecurity](docs/RunnerSecurity.md)
|
|
218
212
|
- [RunnerUpdateRequest](docs/RunnerUpdateRequest.md)
|
|
219
213
|
- [RunnerValidationStatus](docs/RunnerValidationStatus.md)
|
|
220
|
-
- [SendRunDataRequest](docs/SendRunDataRequest.md)
|
|
221
214
|
- [Solution](docs/Solution.md)
|
|
222
215
|
- [SolutionAccessControl](docs/SolutionAccessControl.md)
|
|
223
216
|
- [SolutionCreateRequest](docs/SolutionCreateRequest.md)
|
|
@@ -234,7 +227,6 @@ Class | Method | HTTP request | Description
|
|
|
234
227
|
- [WorkspaceSecurity](docs/WorkspaceSecurity.md)
|
|
235
228
|
- [WorkspaceSolution](docs/WorkspaceSolution.md)
|
|
236
229
|
- [WorkspaceUpdateRequest](docs/WorkspaceUpdateRequest.md)
|
|
237
|
-
- [WorkspaceWebApp](docs/WorkspaceWebApp.md)
|
|
238
230
|
|
|
239
231
|
|
|
240
232
|
<a id="documentation-for-authorization"></a>
|