@@ -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:
@@ -17922,6 +17943,10 @@ components:
1792217943 description: The data for a notebook create request.
1792317944 example:
1792417945 attributes:
17946+ metadata:
17947+ is_template: false
17948+ take_snapshots: false
17949+ type: investigation
1792517950 cells:
1792617951 - attributes:
1792717952 definition:
@@ -17969,6 +17994,10 @@ components:
1796917994 NotebookCreateDataAttributes:
1797017995 description: The data attributes of a notebook.
1797117996 example:
17997+ metadata:
17998+ is_template: false
17999+ take_snapshots: false
18000+ type: investigation
1797218001 cells:
1797318002 - attributes:
1797418003 definition:
@@ -18041,6 +18070,8 @@ components:
1804118070 items:
1804218071 $ref: '#/components/schemas/NotebookCellCreateRequest'
1804318072 type: array
18073+ metadata:
18074+ $ref: '#/components/schemas/NotebookMetadata'
1804418075 name:
1804518076 description: The name of the notebook.
1804618077 example: Example Notebook
@@ -18061,6 +18092,10 @@ components:
1806118092 example:
1806218093 data:
1806318094 attributes:
18095+ metadata:
18096+ is_template: false
18097+ take_snapshots: false
18098+ type: investigation
1806418099 cells:
1806518100 - attributes:
1806618101 definition:
@@ -18196,6 +18231,45 @@ components:
1819618231 type: string
1819718232 x-enum-varnames:
1819818233 - MARKDOWN
18234+ NotebookMetadata:
18235+ description: Metadata associated with the notebook.
18236+ example:
18237+ is_template: false
18238+ take_snapshots: false
18239+ type: investigation
18240+ properties:
18241+ is_template:
18242+ default: false
18243+ description: Whether or not the notebook is a template.
18244+ example: false
18245+ type: boolean
18246+ take_snapshots:
18247+ default: false
18248+ description: Whether or not the notebook takes snapshot image backups of
18249+ the notebook's fixed-time graphs.
18250+ example: false
18251+ type: boolean
18252+ type:
18253+ $ref: '#/components/schemas/NotebookMetadataType'
18254+ type: object
18255+ NotebookMetadataType:
18256+ default: "null"
18257+ description: Metadata type of the notebook.
18258+ enum:
18259+ - postmortem
18260+ - runbook
18261+ - investigation
18262+ - documentation
18263+ - report
18264+ example: investigation
18265+ nullable: true
18266+ type: string
18267+ x-enum-varnames:
18268+ - POSTMORTEM
18269+ - RUNBOOK
18270+ - INVESTIGATION
18271+ - DOCUMENTATION
18272+ - REPORT
1819918273 NotebookRelativeTime:
1820018274 description: Relative timeframe.
1820118275 example:
@@ -18221,6 +18295,10 @@ components:
1822118295 example:
1822218296 data:
1822318297 attributes:
18298+ metadata:
18299+ is_template: false
18300+ take_snapshots: false
18301+ type: investigation
1822418302 cells:
1822518303 - attributes:
1822618304 definition:
@@ -18279,6 +18357,10 @@ components:
1827918357 description: The data for a notebook.
1828018358 example:
1828118359 attributes:
18360+ metadata:
18361+ is_template: false
18362+ take_snapshots: false
18363+ type: investigation
1828218364 cells:
1828318365 - attributes:
1828418366 definition:
@@ -18348,6 +18430,10 @@ components:
1834818430 NotebookResponseDataAttributes:
1834918431 description: The attributes of a notebook.
1835018432 example:
18433+ metadata:
18434+ is_template: false
18435+ take_snapshots: false
18436+ type: investigation
1835118437 cells:
1835218438 - attributes:
1835318439 definition:
@@ -18444,6 +18530,8 @@ components:
1844418530 format: date-time
1844518531 readOnly: true
1844618532 type: string
18533+ metadata:
18534+ $ref: '#/components/schemas/NotebookMetadata'
1844718535 modified:
1844818536 description: UTC time stamp for when the notebook was last modified.
1844918537 example: 2021-02-24T23:15:23.274966Z
@@ -18539,6 +18627,10 @@ components:
1853918627 description: The data for a notebook update request.
1854018628 example:
1854118629 attributes:
18630+ metadata:
18631+ is_template: false
18632+ take_snapshots: false
18633+ type: investigation
1854218634 cells:
1854318635 - attributes:
1854418636 definition:
@@ -18588,6 +18680,10 @@ components:
1858818680 NotebookUpdateDataAttributes:
1858918681 description: The data attributes of a notebook.
1859018682 example:
18683+ metadata:
18684+ is_template: false
18685+ take_snapshots: false
18686+ type: investigation
1859118687 cells:
1859218688 - attributes:
1859318689 definition:
@@ -18664,6 +18760,8 @@ components:
1866418760 items:
1866518761 $ref: '#/components/schemas/NotebookUpdateCell'
1866618762 type: array
18763+ metadata:
18764+ $ref: '#/components/schemas/NotebookMetadata'
1866718765 name:
1866818766 description: The name of the notebook.
1866918767 example: Example Notebook
@@ -18684,6 +18782,10 @@ components:
1868418782 example:
1868518783 data:
1868618784 attributes:
18785+ metadata:
18786+ is_template: false
18787+ take_snapshots: false
18788+ type: investigation
1868718789 cells:
1868818790 - attributes:
1868918791 definition:
@@ -18732,6 +18834,10 @@ components:
1873218834 example:
1873318835 data:
1873418836 - attributes:
18837+ metadata:
18838+ is_template: false
18839+ take_snapshots: false
18840+ type: investigation
1873518841 cells:
1873618842 - id: abcd1234
1873718843 type: notebook_cells
@@ -18754,6 +18860,10 @@ components:
1875418860 id: 123456
1875518861 type: notebooks
1875618862 - attributes:
18863+ metadata:
18864+ is_template: false
18865+ take_snapshots: false
18866+ type: investigation
1875718867 cells:
1875818868 - id: abcd1234
1875918869 type: notebook_cells
@@ -18792,6 +18902,10 @@ components:
1879218902 description: The data for a notebook in get all response.
1879318903 example:
1879418904 attributes:
18905+ metadata:
18906+ is_template: false
18907+ take_snapshots: false
18908+ type: investigation
1879518909 cells:
1879618910 - id: abcd1234
1879718911 type: notebook_cells
@@ -18832,6 +18946,10 @@ components:
1883218946 NotebooksResponseDataAttributes:
1883318947 description: The attributes of a notebook in get all response.
1883418948 example:
18949+ metadata:
18950+ is_template: false
18951+ take_snapshots: false
18952+ type: investigation
1883518953 cells:
1883618954 - id: abcd1234
1883718955 type: notebook_cells
@@ -18865,6 +18983,8 @@ components:
1886518983 format: date-time
1886618984 readOnly: true
1886718985 type: string
18986+ metadata:
18987+ $ref: '#/components/schemas/NotebookMetadata'
1886818988 modified:
1886918989 description: UTC time stamp for when the notebook was last modified.
1887018990 example: 2021-02-24T23:15:23.274966Z
@@ -30874,7 +30994,7 @@ components:
3087430994 readOnly: true
3087530995 type: object
3087630996 NotebooksResponse_meta:
30877- description: Metadata returned by the API.
30997+ description: Searches metadata returned by the API.
3087830998 example:
3087930999 page:
3088031000 total_count: 0
0 commit comments