Skip to content

Commit 43271fd

Browse files
api-clients-generation-pipeline[bot]therveci.datadog-api-spec
authored
Notebooks Public API Documentation (#432)
* Add cassettes * Update cassettes * More cassettes * Regenerate client from commit 62c8ffe of spec repo Co-authored-by: Thomas Hervé <thomas.herve@datadoghq.com> Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com> Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 8502818 commit 43271fd

File tree

135 files changed

+11724
-4
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

135 files changed

+11724
-4
lines changed

‎.apigentools-info‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.4.1.dev6",
7-
"regenerated": "2021-05-12 08:12:46.355942",
8-
"spec_repo_commit": "9b7eac3"
7+
"regenerated": "2021-05-12 09:32:34.223841",
8+
"spec_repo_commit": "62c8ffe"
99
},
1010
"v2": {
1111
"apigentools_version": "1.4.1.dev6",
12-
"regenerated": "2021-05-12 08:13:15.277569",
13-
"spec_repo_commit": "9b7eac3"
12+
"regenerated": "2021-05-12 09:33:01.936662",
13+
"spec_repo_commit": "62c8ffe"
1414
}
1515
}
1616
}

‎docs/v1/NotebookAbsoluteTime.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# NotebookAbsoluteTime
2+
3+
Absolute timeframe.
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**end** | **datetime** | The end time. |
9+
**start** | **datetime** | The start time. |
10+
**live** | **bool** | Indicates whether the timeframe should be shifted to end at the current time. | [optional]
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+
14+

‎docs/v1/NotebookAuthor.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# NotebookAuthor
2+
3+
Attributes of user object returned by the API.
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**created_at** | **datetime** | Creation time of the user. | [optional]
9+
**disabled** | **bool** | Whether the user is disabled. | [optional]
10+
**email** | **str** | Email of the user. | [optional]
11+
**handle** | **str** | Handle of the user. | [optional]
12+
**icon** | **str** | URL of the user&#39;s icon. | [optional]
13+
**name** | **str** | Name of the user. | [optional]
14+
**status** | **str** | Status of the user. | [optional]
15+
**title** | **str** | Title of the user. | [optional]
16+
**verified** | **bool** | Whether the user is verified. | [optional]
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+
20+

‎docs/v1/NotebookCellCreateRequest.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# NotebookCellCreateRequest
2+
3+
The description of a notebook cell create request.
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**attributes** | [**NotebookCellCreateRequestAttributes**](NotebookCellCreateRequestAttributes.md) | |
9+
**type** | [**NotebookCellResourceType**](NotebookCellResourceType.md) | |
10+
11+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
12+
13+

‎docs/v1/NotebookCellCreateRequestAttributes.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# NotebookCellCreateRequestAttributes
2+
3+
The attributes of a notebook cell in create cell request. Valid cell types are `markdown`, `timeseries`, `toplist`, `heatmap`, `distribution`, `log_stream`. [More information on each graph visualization type.](https://docs.datadoghq.com/dashboards/widgets/)
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**graph_size** | [**NotebookGraphSize**](NotebookGraphSize.md) | | [optional]
9+
**split_by** | [**NotebookSplitBy**](NotebookSplitBy.md) | | [optional]
10+
**time** | [**NotebookCellTime**](NotebookCellTime.md) | | [optional]
11+
**definition** | [**LogStreamWidgetDefinition**](LogStreamWidgetDefinition.md) | | [optional]
12+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
13+
14+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
15+
16+

‎docs/v1/NotebookCellResourceType.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# NotebookCellResourceType
2+
3+
Type of the Notebook Cell resource.
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**value** | **str** | Type of the Notebook Cell resource. | defaults to "notebook_cells", must be one of ["notebook_cells", ]
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+
12+

‎docs/v1/NotebookCellResponse.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# NotebookCellResponse
2+
3+
The description of a notebook cell response.
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**attributes** | [**NotebookCellResponseAttributes**](NotebookCellResponseAttributes.md) | |
9+
**id** | **str** | Notebook cell ID. |
10+
**type** | [**NotebookCellResourceType**](NotebookCellResourceType.md) | |
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+
14+

‎docs/v1/NotebookCellResponseAttributes.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# NotebookCellResponseAttributes
2+
3+
The attributes of a notebook cell response. Valid cell types are `markdown`, `timeseries`, `toplist`, `heatmap`, `distribution`, `log_stream`. [More information on each graph visualization type.](https://docs.datadoghq.com/dashboards/widgets/)
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**graph_size** | [**NotebookGraphSize**](NotebookGraphSize.md) | | [optional]
9+
**split_by** | [**NotebookSplitBy**](NotebookSplitBy.md) | | [optional]
10+
**time** | [**NotebookCellTime**](NotebookCellTime.md) | | [optional]
11+
**definition** | [**LogStreamWidgetDefinition**](LogStreamWidgetDefinition.md) | | [optional]
12+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
13+
14+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
15+
16+

‎docs/v1/NotebookCellTime.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# NotebookCellTime
2+
3+
Timeframe for the notebook cell. When 'null', the notebook global time is used.
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**live** | **bool** | Indicates whether the timeframe should be shifted to end at the current time. | [optional]
9+
**live_span** | [**WidgetLiveSpan**](WidgetLiveSpan.md) | | [optional]
10+
**end** | **datetime** | The end time. | [optional]
11+
**start** | **datetime** | The start time. | [optional]
12+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
13+
14+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
15+
16+

‎docs/v1/NotebookCellUpdateRequest.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# NotebookCellUpdateRequest
2+
3+
The description of a notebook cell update request.
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**attributes** | [**NotebookCellUpdateRequestAttributes**](NotebookCellUpdateRequestAttributes.md) | |
9+
**id** | **str** | Notebook cell ID. |
10+
**type** | [**NotebookCellResourceType**](NotebookCellResourceType.md) | |
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+
14+

0 commit comments

Comments
 (0)