aboutsummaryrefslogtreecommitdiffstats
path: root/docs/versioned_docs/version-v0.25.0/API/update-a-list.api.mdx
diff options
context:
space:
mode:
Diffstat (limited to 'docs/versioned_docs/version-v0.25.0/API/update-a-list.api.mdx')
-rw-r--r--docs/versioned_docs/version-v0.25.0/API/update-a-list.api.mdx71
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.25.0/API/update-a-list.api.mdx b/docs/versioned_docs/version-v0.25.0/API/update-a-list.api.mdx
new file mode 100644
index 00000000..e240ffe1
--- /dev/null
+++ b/docs/versioned_docs/version-v0.25.0/API/update-a-list.api.mdx
@@ -0,0 +1,71 @@
+---
+id: update-a-list
+title: "Update a list"
+description: "Update list by its id"
+sidebar_label: "Update a list"
+hide_title: true
+hide_table_of_contents: true
+api: eJytVk1v4zYQ/SvEnFqAtZ0iRRe6uYsWTbtAg60XPRg+jMWxxUQitSSVWBX034uhJEuOlSwKxAdDJEfz8d6boRpQ5FOny6CtgQS+lAoDiVz7IPa10MELrUBCwKOHZAuftA8edhI8pZXToYZk28Ce0JFbVyGDZLtrdxJKdFhQIOejgU8zKhCSBkJdEiTgg9PmCBLohEWZ85YmrfJTfSyeHz78bE///pSdQrDpB46uQzTh6HcKWgmOvlbakYIkuIokGCzYIO8MJGgupsSQAWfD1uTDL1bVnMNlyZuMhMKAIlhRxfIX4i+T1yJkJA6acuVFbSvxjCaMNsIQKV7uSZTOPmlFagESUmsCmcBhsCxznSKHWT54jjUDhN0/UBpAQulsSS5o8nza1XMNV6HNJzJHBvpGQoGnYXW7auVlYdcvmyrPcc9IdqBNnK0unN2s2JtO59y0kVwyjPM3Y7QSvlbk6m+Vwk6rfa7TieHe2pzQQBt/TKIvrfEdPj+uVvNMduyoqOD3o0PP1NrKV1j6v0S8G9SdwUyPmarg5i3QVJiDBF+gC9zFig5Y5QGS4ewtwq7ivUHZtEO3EEdIBKsvdVLY2c3uss+hY/12dXtNNJ8LY4M42Mqo96M5tWqez4K8x+Pc2YtKo4fRftdrt6CQWdWNpDSL5bPuYcky9cumm1stU0PuaZialcshgQaVcuR9u8RSL59uQMITOs1MxKT74w6lgc4shNIny2Vw9eIRHT4SlQssS5AzPdN7EPYQZ96fvb3ocmEiJgP/b8ayizwd+2dgODLXEc1YE9EIZP/wm3UFcoZ//LOJ6DFHn8f5/OtwHwwzcNTfZeLn7a53xvXYMuNer+mJUS/dof/MwXJIhr5zf7NYLVaTq+cMyvr+bhbE9f2dOFh3iSAjzo1ifSjQTIrq71kc5tSLgXHW8+sXcod2oFNYljlqw3GiYJpeXNt4G3qQkPTX4k5CZn3go6bZo6cvLm9b3u7x2e5GbUUFKu35WUFywNzTG3l+97nvgu/Fa9n1m2jqKOG84hVIeKR6vLrbXSshI1TkYgbd4ccuzg8bdjG+fNXrrRzeWKcpleFN292kL+/Xm4+/s0j7T4QiTgJw+Awy/sdMbSw8aj/uNZCjOVZxMkDnlCWNlx3xogNiWbNYNE1nsbGPZNr2DE3gNSPTtv8BTB5PJw==
+sidebar_class_name: "patch api-method"
+info_path: API/karakeep-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+
+<Heading
+ as={"h1"}
+ className={"openapi__heading"}
+ children={"Update a list"}
+>
+</Heading>
+
+<MethodEndpoint
+ method={"patch"}
+ path={"/lists/{listId}"}
+ context={"endpoint"}
+>
+
+</MethodEndpoint>
+
+
+
+Update list by its id
+
+<Heading
+ id={"request"}
+ as={"h2"}
+ className={"openapi-tabs__heading"}
+ children={"Request"}
+>
+</Heading>
+
+<ParamsDetails
+ parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"ListId"},"required":true,"name":"listId","in":"path"}]}
+>
+
+</ParamsDetails>
+
+<RequestSchema
+ title={"Body"}
+ body={{"description":"The data to update. Only the fields you want to update need to be provided.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":40},"description":{"type":"string","nullable":true,"minLength":0,"maxLength":100},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"query":{"type":"string","minLength":1},"public":{"type":"boolean"}}}}}}}
+>
+
+</RequestSchema>
+
+<StatusCodes
+ id={undefined}
+ label={undefined}
+ responses={{"200":{"description":"The updated list","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","nullable":true},"public":{"type":"boolean"}},"required":["id","name","icon","parentId","public"],"title":"List"}}}},"404":{"description":"List not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
+>
+
+</StatusCodes>
+
+
+ \ No newline at end of file