Skip to content

Commit fe68264

Browse files
jreynard-codecsmplatform
jreynard-code
and
csmplatform
committed
chore(docs): Update generated documentation
Co-authored-by: csmplatform <[email protected]>
1 parent b1e2565 commit fe68264

8 files changed

+98
-0
lines changed

‎doc/Models/CreateInfo.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# CreateInfo
2+
## Properties
3+
4+
| Name | Type | Description | Notes |
5+
|------------ | ------------- | ------------- | -------------|
6+
| **timestamp** | **Long** | The timestamp of the creation in millisecond | [default to null] |
7+
| **userId** | **String** | The id of the user who did the creation | [default to null] |
8+
| **runnerId** | **String** | The runner id which has created the dataset (nullable) | [optional] [default to null] |
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+

‎doc/Models/DatasetCreateRequest.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# DatasetCreateRequest
2+
## Properties
3+
4+
| Name | Type | Description | Notes |
5+
|------------ | ------------- | ------------- | -------------|
6+
| **name** | **String** | | [default to null] |
7+
| **description** | **String** | | [optional] [default to null] |
8+
| **tags** | **List** | | [optional] [default to []] |
9+
| **parts** | [**List**](DatasetPartCreateRequest.md) | | [optional] [default to []] |
10+
| **security** | [**DatasetSecurity**](DatasetSecurity.md) | | [optional] [default to null] |
11+
| **runnerId** | **String** | | [optional] [default to null] |
12+
13+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14+

‎doc/Models/DatasetPart.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# DatasetPart
2+
## Properties
3+
4+
| Name | Type | Description | Notes |
5+
|------------ | ------------- | ------------- | -------------|
6+
| **id** | **String** | | [default to null] |
7+
| **name** | **String** | | [default to null] |
8+
| **sourceName** | **String** | the source data name (e.g. filename associated to the dataset part) | [default to null] |
9+
| **description** | **String** | | [optional] [default to null] |
10+
| **tags** | **List** | | [default to null] |
11+
| **type** | [**DatasetPartTypeEnum**](DatasetPartTypeEnum.md) | | [default to null] |
12+
| **organizationId** | **String** | the associated Organization Id | [default to null] |
13+
| **workspaceId** | **String** | the associated Workspace Id | [default to null] |
14+
| **datasetId** | **String** | the associated Dataset Id | [default to null] |
15+
| **createInfo** | [**EditInfo**](EditInfo.md) | The details of the Dataset creation | [default to null] |
16+
| **updateInfo** | [**EditInfo**](EditInfo.md) | The details of the Dataset last update | [default to null] |
17+
18+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
19+

‎doc/Models/DatasetPartCreateRequest.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# DatasetPartCreateRequest
2+
## Properties
3+
4+
| Name | Type | Description | Notes |
5+
|------------ | ------------- | ------------- | -------------|
6+
| **name** | **String** | | [default to null] |
7+
| **sourceName** | **String** | the source data name (e.g. filename associated to the dataset part) | [default to null] |
8+
| **description** | **String** | | [optional] [default to null] |
9+
| **tags** | **List** | | [optional] [default to []] |
10+
| **type** | [**DatasetPartTypeEnum**](DatasetPartTypeEnum.md) | | [optional] [default to null] |
11+
12+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13+

‎doc/Models/DatasetPartTypeEnum.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# DatasetPartTypeEnum
2+
## Properties
3+
4+
| Name | Type | Description | Notes |
5+
|------------ | ------------- | ------------- | -------------|
6+
7+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
8+

‎doc/Models/DatasetPartUpdateRequest.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# DatasetPartUpdateRequest
2+
## Properties
3+
4+
| Name | Type | Description | Notes |
5+
|------------ | ------------- | ------------- | -------------|
6+
| **description** | **String** | | [optional] [default to null] |
7+
| **tags** | **List** | | [optional] [default to null] |
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+

‎doc/Models/DatasetUpdateRequest.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# DatasetUpdateRequest
2+
## Properties
3+
4+
| Name | Type | Description | Notes |
5+
|------------ | ------------- | ------------- | -------------|
6+
| **name** | **String** | | [optional] [default to null] |
7+
| **description** | **String** | | [optional] [default to null] |
8+
| **tags** | **List** | | [optional] [default to null] |
9+
| **parts** | [**List**](DatasetPartCreateRequest.md) | | [optional] [default to null] |
10+
| **security** | [**DatasetSecurity**](DatasetSecurity.md) | | [optional] [default to null] |
11+
12+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13+

‎doc/Models/EditInfo.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# EditInfo
2+
## Properties
3+
4+
| Name | Type | Description | Notes |
5+
|------------ | ------------- | ------------- | -------------|
6+
| **timestamp** | **Long** | The timestamp of the modification in millisecond | [default to null] |
7+
| **userId** | **String** | The id of the user who did the modification | [default to null] |
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+

0 commit comments

Comments
 (0)