Notebook.update¶
Update notebook fields (title, description).
Signature¶
update(**kwargs: Any) -> None
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
**kwargs |
Any |
no | - |
HTTP parameters¶
| Name | In | Type | Required | Default |
|---|---|---|---|---|
notebook_id |
path |
string |
yes | - |
Fields¶
Schema: NotebookUpdateSchema
| Field | Type | Required |
|---|---|---|
description |
string |
no |
tag_ids |
array<string> |
no |
title |
string |
no |
view_config |
object |
no |
Return shape¶
HTTP 200 — OK
Schema: NotebookSchema
| Field | Type | Required |
|---|---|---|
created_at |
string |
no |
description |
string |
yes |
id |
string |
yes |
primary_dataset_id |
string |
no |
project_id |
string |
yes |
slug |
string |
no |
slug_number |
integer |
no |
tags |
array<NotebookTagSchema> |
no |
title |
string |
yes |
trace_count |
integer |
no |
updated_at |
string |
no |
Permission¶
Required permission: notebook:update
HTTP¶
PATCH /api/notebooks/{id} (updateNotebook)
Usage¶
notebook.update()