@@ -5704,7 +5704,7 @@ paths:
57045704 format: int64
57055705 type: integer
57065706 style: form
5707- - description: Sort by field `modified` or `name `.
5707+ - description: Sort by field `modified`, `name`, or `created `.
57085708 explode: true
57095709 in: query
57105710 name: sort_field
@@ -5745,6 +5745,27 @@ paths:
57455745 example: false
57465746 type: boolean
57475747 style: form
5748+ - description: True value returns only template notebooks. Default is false
5749+ (returns only non-template notebooks).
5750+ explode: true
5751+ in: query
5752+ name: is_template
5753+ required: false
5754+ schema:
5755+ default: false
5756+ example: false
5757+ type: boolean
5758+ style: form
5759+ - description: If type is provided, returns only notebooks with that metadata
5760+ type. Default does not have type filtering.
5761+ explode: true
5762+ in: query
5763+ name: type
5764+ required: false
5765+ schema:
5766+ example: investigation
5767+ type: string
5768+ style: form
57485769 responses:
57495770 "200":
57505771 content:
@@ -17958,6 +17979,10 @@ components:
1795817979 description: The data for a notebook create request.
1795917980 example:
1796017981 attributes:
17982+ metadata:
17983+ is_template: false
17984+ take_snapshots: false
17985+ type: investigation
1796117986 cells:
1796217987 - attributes:
1796317988 definition:
@@ -18005,6 +18030,10 @@ components:
1800518030 NotebookCreateDataAttributes:
1800618031 description: The data attributes of a notebook.
1800718032 example:
18033+ metadata:
18034+ is_template: false
18035+ take_snapshots: false
18036+ type: investigation
1800818037 cells:
1800918038 - attributes:
1801018039 definition:
@@ -18077,6 +18106,8 @@ components:
1807718106 items:
1807818107 $ref: '#/components/schemas/NotebookCellCreateRequest'
1807918108 type: array
18109+ metadata:
18110+ $ref: '#/components/schemas/NotebookMetadata'
1808018111 name:
1808118112 description: The name of the notebook.
1808218113 example: Example Notebook
@@ -18097,6 +18128,10 @@ components:
1809718128 example:
1809818129 data:
1809918130 attributes:
18131+ metadata:
18132+ is_template: false
18133+ take_snapshots: false
18134+ type: investigation
1810018135 cells:
1810118136 - attributes:
1810218137 definition:
@@ -18232,6 +18267,45 @@ components:
1823218267 type: string
1823318268 x-enum-varnames:
1823418269 - MARKDOWN
18270+ NotebookMetadata:
18271+ description: Metadata associated with the notebook.
18272+ example:
18273+ is_template: false
18274+ take_snapshots: false
18275+ type: investigation
18276+ properties:
18277+ is_template:
18278+ default: false
18279+ description: Whether or not the notebook is a template.
18280+ example: false
18281+ type: boolean
18282+ take_snapshots:
18283+ default: false
18284+ description: Whether or not the notebook takes snapshot image backups of
18285+ the notebook's fixed-time graphs.
18286+ example: false
18287+ type: boolean
18288+ type:
18289+ $ref: '#/components/schemas/NotebookMetadataType'
18290+ type: object
18291+ NotebookMetadataType:
18292+ default: "null"
18293+ description: Metadata type of the notebook.
18294+ enum:
18295+ - postmortem
18296+ - runbook
18297+ - investigation
18298+ - documentation
18299+ - report
18300+ example: investigation
18301+ nullable: true
18302+ type: string
18303+ x-enum-varnames:
18304+ - POSTMORTEM
18305+ - RUNBOOK
18306+ - INVESTIGATION
18307+ - DOCUMENTATION
18308+ - REPORT
1823518309 NotebookRelativeTime:
1823618310 description: Relative timeframe.
1823718311 example:
@@ -18257,6 +18331,10 @@ components:
1825718331 example:
1825818332 data:
1825918333 attributes:
18334+ metadata:
18335+ is_template: false
18336+ take_snapshots: false
18337+ type: investigation
1826018338 cells:
1826118339 - attributes:
1826218340 definition:
@@ -18315,6 +18393,10 @@ components:
1831518393 description: The data for a notebook.
1831618394 example:
1831718395 attributes:
18396+ metadata:
18397+ is_template: false
18398+ take_snapshots: false
18399+ type: investigation
1831818400 cells:
1831918401 - attributes:
1832018402 definition:
@@ -18384,6 +18466,10 @@ components:
1838418466 NotebookResponseDataAttributes:
1838518467 description: The attributes of a notebook.
1838618468 example:
18469+ metadata:
18470+ is_template: false
18471+ take_snapshots: false
18472+ type: investigation
1838718473 cells:
1838818474 - attributes:
1838918475 definition:
@@ -18480,6 +18566,8 @@ components:
1848018566 format: date-time
1848118567 readOnly: true
1848218568 type: string
18569+ metadata:
18570+ $ref: '#/components/schemas/NotebookMetadata'
1848318571 modified:
1848418572 description: UTC time stamp for when the notebook was last modified.
1848518573 example: 2021-02-24T23:15:23.274966Z
@@ -18575,6 +18663,10 @@ components:
1857518663 description: The data for a notebook update request.
1857618664 example:
1857718665 attributes:
18666+ metadata:
18667+ is_template: false
18668+ take_snapshots: false
18669+ type: investigation
1857818670 cells:
1857918671 - attributes:
1858018672 definition:
@@ -18624,6 +18716,10 @@ components:
1862418716 NotebookUpdateDataAttributes:
1862518717 description: The data attributes of a notebook.
1862618718 example:
18719+ metadata:
18720+ is_template: false
18721+ take_snapshots: false
18722+ type: investigation
1862718723 cells:
1862818724 - attributes:
1862918725 definition:
@@ -18700,6 +18796,8 @@ components:
1870018796 items:
1870118797 $ref: '#/components/schemas/NotebookUpdateCell'
1870218798 type: array
18799+ metadata:
18800+ $ref: '#/components/schemas/NotebookMetadata'
1870318801 name:
1870418802 description: The name of the notebook.
1870518803 example: Example Notebook
@@ -18720,6 +18818,10 @@ components:
1872018818 example:
1872118819 data:
1872218820 attributes:
18821+ metadata:
18822+ is_template: false
18823+ take_snapshots: false
18824+ type: investigation
1872318825 cells:
1872418826 - attributes:
1872518827 definition:
@@ -18768,6 +18870,10 @@ components:
1876818870 example:
1876918871 data:
1877018872 - attributes:
18873+ metadata:
18874+ is_template: false
18875+ take_snapshots: false
18876+ type: investigation
1877118877 cells:
1877218878 - id: abcd1234
1877318879 type: notebook_cells
@@ -18790,6 +18896,10 @@ components:
1879018896 id: 123456
1879118897 type: notebooks
1879218898 - attributes:
18899+ metadata:
18900+ is_template: false
18901+ take_snapshots: false
18902+ type: investigation
1879318903 cells:
1879418904 - id: abcd1234
1879518905 type: notebook_cells
@@ -18828,6 +18938,10 @@ components:
1882818938 description: The data for a notebook in get all response.
1882918939 example:
1883018940 attributes:
18941+ metadata:
18942+ is_template: false
18943+ take_snapshots: false
18944+ type: investigation
1883118945 cells:
1883218946 - id: abcd1234
1883318947 type: notebook_cells
@@ -18868,6 +18982,10 @@ components:
1886818982 NotebooksResponseDataAttributes:
1886918983 description: The attributes of a notebook in get all response.
1887018984 example:
18985+ metadata:
18986+ is_template: false
18987+ take_snapshots: false
18988+ type: investigation
1887118989 cells:
1887218990 - id: abcd1234
1887318991 type: notebook_cells
@@ -18901,6 +19019,8 @@ components:
1890119019 format: date-time
1890219020 readOnly: true
1890319021 type: string
19022+ metadata:
19023+ $ref: '#/components/schemas/NotebookMetadata'
1890419024 modified:
1890519025 description: UTC time stamp for when the notebook was last modified.
1890619026 example: 2021-02-24T23:15:23.274966Z
@@ -30910,7 +31030,7 @@ components:
3091031030 readOnly: true
3091131031 type: object
3091231032 NotebooksResponse_meta:
30913- description: Metadata returned by the API.
31033+ description: Searches metadata returned by the API.
3091431034 example:
3091531035 page:
3091631036 total_count: 0
0 commit comments