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>

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.4.1.dev6",
-            "regenerated": "2021-05-12 08:12:46.355942",
-            "spec_repo_commit": "9b7eac3"
+            "regenerated": "2021-05-12 09:32:34.223841",
+            "spec_repo_commit": "62c8ffe"
         },
         "v2": {
             "apigentools_version": "1.4.1.dev6",
-            "regenerated": "2021-05-12 08:13:15.277569",
-            "spec_repo_commit": "9b7eac3"
+            "regenerated": "2021-05-12 09:33:01.936662",
+            "spec_repo_commit": "62c8ffe"
         }
     }
 }

docs/v1/NotebookAbsoluteTime.md

@@ -0,0 +1,14 @@
+# NotebookAbsoluteTime
+
+Absolute timeframe.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**end** | **datetime** | The end time. | 
+**start** | **datetime** | The start time. | 
+**live** | **bool** | Indicates whether the timeframe should be shifted to end at the current time. | [optional] 
+
+[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
+
+

docs/v1/NotebookAuthor.md

@@ -0,0 +1,20 @@
+# NotebookAuthor
+
+Attributes of user object returned by the API.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | **datetime** | Creation time of the user. | [optional] 
+**disabled** | **bool** | Whether the user is disabled. | [optional] 
+**email** | **str** | Email of the user. | [optional] 
+**handle** | **str** | Handle of the user. | [optional] 
+**icon** | **str** | URL of the user's icon. | [optional] 
+**name** | **str** | Name of the user. | [optional] 
+**status** | **str** | Status of the user. | [optional] 
+**title** | **str** | Title of the user. | [optional] 
+**verified** | **bool** | Whether the user is verified. | [optional] 
+
+[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
+
+

docs/v1/NotebookCellCreateRequest.md

@@ -0,0 +1,13 @@
+# NotebookCellCreateRequest
+
+The description of a notebook cell create request.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attributes** | [**NotebookCellCreateRequestAttributes**](NotebookCellCreateRequestAttributes.md) |  | 
+**type** | [**NotebookCellResourceType**](NotebookCellResourceType.md) |  | 
+
+[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
+
+

docs/v1/NotebookCellCreateRequestAttributes.md

@@ -0,0 +1,16 @@
+# NotebookCellCreateRequestAttributes
+
+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/)
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**graph_size** | [**NotebookGraphSize**](NotebookGraphSize.md) |  | [optional] 
+**split_by** | [**NotebookSplitBy**](NotebookSplitBy.md) |  | [optional] 
+**time** | [**NotebookCellTime**](NotebookCellTime.md) |  | [optional] 
+**definition** | [**LogStreamWidgetDefinition**](LogStreamWidgetDefinition.md) |  | [optional] 
+**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]
+
+[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
+
+

docs/v1/NotebookCellResourceType.md

@@ -0,0 +1,12 @@
+# NotebookCellResourceType
+
+Type of the Notebook Cell resource.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **str** | Type of the Notebook Cell resource. | defaults to "notebook_cells",  must be one of ["notebook_cells", ]
+
+[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
+
+

docs/v1/NotebookCellResponse.md

@@ -0,0 +1,14 @@
+# NotebookCellResponse
+
+The description of a notebook cell response.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attributes** | [**NotebookCellResponseAttributes**](NotebookCellResponseAttributes.md) |  | 
+**id** | **str** | Notebook cell ID. | 
+**type** | [**NotebookCellResourceType**](NotebookCellResourceType.md) |  | 
+
+[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
+
+

docs/v1/NotebookCellResponseAttributes.md

@@ -0,0 +1,16 @@
+# NotebookCellResponseAttributes
+
+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/)
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**graph_size** | [**NotebookGraphSize**](NotebookGraphSize.md) |  | [optional] 
+**split_by** | [**NotebookSplitBy**](NotebookSplitBy.md) |  | [optional] 
+**time** | [**NotebookCellTime**](NotebookCellTime.md) |  | [optional] 
+**definition** | [**LogStreamWidgetDefinition**](LogStreamWidgetDefinition.md) |  | [optional] 
+**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]
+
+[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
+
+

docs/v1/NotebookCellTime.md

@@ -0,0 +1,16 @@
+# NotebookCellTime
+
+Timeframe for the notebook cell. When 'null', the notebook global time is used.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**live** | **bool** | Indicates whether the timeframe should be shifted to end at the current time. | [optional] 
+**live_span** | [**WidgetLiveSpan**](WidgetLiveSpan.md) |  | [optional] 
+**end** | **datetime** | The end time. | [optional] 
+**start** | **datetime** | The start time. | [optional] 
+**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]
+
+[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
+
+

docs/v1/NotebookCellUpdateRequest.md

@@ -0,0 +1,14 @@
+# NotebookCellUpdateRequest
+
+The description of a notebook cell update request.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attributes** | [**NotebookCellUpdateRequestAttributes**](NotebookCellUpdateRequestAttributes.md) |  | 
+**id** | **str** | Notebook cell ID. | 
+**type** | [**NotebookCellResourceType**](NotebookCellResourceType.md) |  | 
+
+[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
+
+

docs/v1/NotebookCellUpdateRequestAttributes.md

@@ -0,0 +1,16 @@
+# NotebookCellUpdateRequestAttributes
+
+The attributes of a notebook cell in update 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/)
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**graph_size** | [**NotebookGraphSize**](NotebookGraphSize.md) |  | [optional] 
+**split_by** | [**NotebookSplitBy**](NotebookSplitBy.md) |  | [optional] 
+**time** | [**NotebookCellTime**](NotebookCellTime.md) |  | [optional] 
+**definition** | [**LogStreamWidgetDefinition**](LogStreamWidgetDefinition.md) |  | [optional] 
+**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]
+
+[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
+
+

docs/v1/NotebookCreateData.md

@@ -0,0 +1,13 @@
+# NotebookCreateData
+
+The data for a notebook create request.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attributes** | [**NotebookCreateDataAttributes**](NotebookCreateDataAttributes.md) |  | 
+**type** | [**NotebookResourceType**](NotebookResourceType.md) |  | 
+
+[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
+
+

docs/v1/NotebookCreateDataAttributes.md

@@ -0,0 +1,15 @@
+# NotebookCreateDataAttributes
+
+The data attributes of a notebook.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cells** | [**[NotebookCellCreateRequest]**](NotebookCellCreateRequest.md) | List of cells to display in the notebook. | 
+**name** | **str** | Notebook name. | 
+**time** | [**NotebookGlobalTime**](NotebookGlobalTime.md) |  | 
+**status** | [**NotebookStatus**](NotebookStatus.md) |  | [optional] 
+
+[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
+
+

docs/v1/NotebookCreateRequest.md

@@ -0,0 +1,12 @@
+# NotebookCreateRequest
+
+The description of a notebook create request.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**NotebookCreateData**](NotebookCreateData.md) |  | 
+
+[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
+
+

docs/v1/NotebookDistributionCellAttributes.md

@@ -0,0 +1,15 @@
+# NotebookDistributionCellAttributes
+
+The attributes of a notebook distribution cell.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**definition** | [**DistributionWidgetDefinition**](DistributionWidgetDefinition.md) |  | 
+**graph_size** | [**NotebookGraphSize**](NotebookGraphSize.md) |  | [optional] 
+**split_by** | [**NotebookSplitBy**](NotebookSplitBy.md) |  | [optional] 
+**time** | [**NotebookCellTime**](NotebookCellTime.md) |  | [optional] 
+
+[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
+
+

docs/v1/NotebookGlobalTime.md

@@ -0,0 +1,16 @@
+# NotebookGlobalTime
+
+Notebook global timeframe.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**live** | **bool** | Indicates whether the timeframe should be shifted to end at the current time. | [optional] 
+**live_span** | [**WidgetLiveSpan**](WidgetLiveSpan.md) |  | [optional] 
+**end** | **datetime** | The end time. | [optional] 
+**start** | **datetime** | The start time. | [optional] 
+**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]
+
+[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
+
+

docs/v1/NotebookGraphSize.md

@@ -0,0 +1,12 @@
+# NotebookGraphSize
+
+The size of the graph.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **str** | The size of the graph. |  must be one of ["xs", "s", "m", "l", "xl", ]
+
+[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
+
+

docs/v1/NotebookHeatMapCellAttributes.md

@@ -0,0 +1,15 @@
+# NotebookHeatMapCellAttributes
+
+The attributes of a notebook heat map cell.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**definition** | [**HeatMapWidgetDefinition**](HeatMapWidgetDefinition.md) |  | 
+**graph_size** | [**NotebookGraphSize**](NotebookGraphSize.md) |  | [optional] 
+**split_by** | [**NotebookSplitBy**](NotebookSplitBy.md) |  | [optional] 
+**time** | [**NotebookCellTime**](NotebookCellTime.md) |  | [optional] 
+
+[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
+
+

docs/v1/NotebookLogStreamCellAttributes.md

@@ -0,0 +1,14 @@
+# NotebookLogStreamCellAttributes
+
+The attributes of a notebook log stream cell.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**definition** | [**LogStreamWidgetDefinition**](LogStreamWidgetDefinition.md) |  | 
+**graph_size** | [**NotebookGraphSize**](NotebookGraphSize.md) |  | [optional] 
+**time** | [**NotebookCellTime**](NotebookCellTime.md) |  | [optional] 
+
+[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
+
+

docs/v1/NotebookMarkdownCellAttributes.md

@@ -0,0 +1,12 @@
+# NotebookMarkdownCellAttributes
+
+The attributes of a notebooks markdown cell.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**definition** | [**NotebookMarkdownCellDefinition**](NotebookMarkdownCellDefinition.md) |  | 
+
+[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
+
+

docs/v1/NotebookMarkdownCellDefinition.md

@@ -0,0 +1,13 @@
+# NotebookMarkdownCellDefinition
+
+Text in a notebook is formatted with [Markdown](https://daringfireball.net/projects/markdown/), which enables the use of headings, subheadings, links, images, lists, and code blocks.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text** | **str** | The markdown content. | 
+**type** | [**NotebookMarkdownCellDefinitionType**](NotebookMarkdownCellDefinitionType.md) |  | 
+
+[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
+
+

docs/v1/NotebookMarkdownCellDefinitionType.md

@@ -0,0 +1,12 @@
+# NotebookMarkdownCellDefinitionType
+
+Type of the markdown cell.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **str** | Type of the markdown cell. | defaults to "markdown",  must be one of ["markdown", ]
+
+[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
+
+

docs/v1/NotebookRelativeTime.md

@@ -0,0 +1,12 @@
+# NotebookRelativeTime
+
+Relative timeframe.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**live_span** | [**WidgetLiveSpan**](WidgetLiveSpan.md) |  | 
+
+[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
+
+

docs/v1/NotebookResourceType.md

@@ -0,0 +1,12 @@
+# NotebookResourceType
+
+Type of the Notebook resource.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **str** | Type of the Notebook resource. | defaults to "notebooks",  must be one of ["notebooks", ]
+
+[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
+
+

docs/v1/NotebookResponse.md

@@ -0,0 +1,12 @@
+# NotebookResponse
+
+The description of a notebook response.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**NotebookResponseData**](NotebookResponseData.md) |  | [optional] 
+
+[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
+
+

docs/v1/NotebookResponseData.md

@@ -0,0 +1,14 @@
+# NotebookResponseData
+
+The data for a notebook.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attributes** | [**NotebookResponseDataAttributes**](NotebookResponseDataAttributes.md) |  | 
+**id** | **int** | Unique notebook ID, assigned when you create the notebook. | [readonly] 
+**type** | [**NotebookResourceType**](NotebookResourceType.md) |  | 
+
+[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
+
+