aboutsummaryrefslogtreecommitdiffstats
path: root/docs/versioned_docs/version-v0.29.0/api/create-a-new-list.api.mdx
diff options
context:
space:
mode:
authorMohamed Bassem <me@mbassem.com>2025-11-29 18:31:05 +0000
committerMohamed Bassem <me@mbassem.com>2025-11-29 18:32:19 +0000
commit97c386a4d15294b4ed07ff83c8a6a773e7289ab8 (patch)
tree3c8a22fdd92efa489638d5216714497d61b47b3e /docs/versioned_docs/version-v0.29.0/api/create-a-new-list.api.mdx
parentf01d96fd91f8829d4d91c465e9950e78fc6f7513 (diff)
downloadkarakeep-97c386a4d15294b4ed07ff83c8a6a773e7289ab8.tar.zst
release(docs): release the 0.29 docs
Diffstat (limited to 'docs/versioned_docs/version-v0.29.0/api/create-a-new-list.api.mdx')
-rw-r--r--docs/versioned_docs/version-v0.29.0/api/create-a-new-list.api.mdx71
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.29.0/api/create-a-new-list.api.mdx b/docs/versioned_docs/version-v0.29.0/api/create-a-new-list.api.mdx
new file mode 100644
index 00000000..aea2e62b
--- /dev/null
+++ b/docs/versioned_docs/version-v0.29.0/api/create-a-new-list.api.mdx
@@ -0,0 +1,71 @@
+---
+id: create-a-new-list
+title: "Create a new list"
+description: "Create a new list"
+sidebar_label: "Create a new list"
+hide_title: true
+hide_table_of_contents: true
+api: eJy1VsFu2zAM/RWDZ61Jh+3iW1dsQLcCK7YMOwQ5MDYba5UlVZLbBob+faDkJE7qtRiwXQJLIsXHx0cqPdTkKydtkEZDCZeOMFCBhabHQkkfQEDAjYdyCdfSBw8rAZ6qzsmwhXLZw5rQkbvoQgPlchVXAhzdd+TDB1NvoexPAiwaSvcWwRRVCgYCKqMD6cDWaK2SFbL17Jdnlx581VCL/BW2lqAEs/5FFUOzzlhyQZLnU40tjax8cFJvQEAr9TXpDSM8F9Di0341n0dxDPBF7/mR9/vkLasptyiGjef3ke5aprNF3aECAb5FF5jXmm6xUwHK3VkUcN+R276WVBRg0ZEOV/WUqe6UwrUiKIPrKMZcIumoZhyJtSGPVYz52FujfWb17fx8uoy5fPVOJv+oiHIihSj+UNvXq3eS+wv1+gsG/3txn8Wz3VrJamS6NkYRar6lQX9p2N44DMb5aavOk/tm1IuozaMmx+taBsMfD5Ie084Qf3UqHlmDOFLQiMe91wTEEZ6VgCADA0sTBrIE383nz1X3AetimC7/TnCVqaeV1ZL3uJk6OyEh3XCwT02U/ENjaijBmoTXIjcrzFSaozxG3QNxuZY9dE5BCT3WtSPv4wytnD2ccwXQSVZCgjocZ2J2cmpCsL6czYLbnt2hwzsie4bWgpjo2eGGwtwWoaHiy2BfZCzM/Wi+f2cGc+TxlN/TwZE5j2TGaktGIIaPT8a1yAg//1wkzrgy3w6Pw8cnbG0WZO7ugyCPge+3c+8e1gOOfbMN/XQwOPT0qK5S3xoOyuTnAOdn87M5HHS4p+Xi5mqSxoubq+LWuGMOmXNuVeNDi3qU1tSjejK29lqefoFznoGewswqlLmhWTL9oKolqN3r3LDayiX0/Ro9/XAqRt4euFmuDppKD7aAhrAml2R4R0zfZQbzZsFh2Vx1HP5Zk0Wx87ioKrLhRdvVqCFuvn5fsEyGfwht6kBw+Agi/ZYAAkwiJ6kv7fWgUG+61JGQ72RR4bEmTzSYshqOUG9HCPs+WyzMHekYQQypBF5D5Cb+DVD4G/I=
+sidebar_class_name: "post 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={"Create a new list"}
+>
+</Heading>
+
+<MethodEndpoint
+ method={"post"}
+ path={"/lists"}
+ context={"endpoint"}
+>
+
+</MethodEndpoint>
+
+
+
+Create a new list
+
+<Heading
+ id={"request"}
+ as={"h2"}
+ className={"openapi-tabs__heading"}
+ children={"Request"}
+>
+</Heading>
+
+<ParamsDetails
+ parameters={undefined}
+>
+
+</ParamsDetails>
+
+<RequestSchema
+ title={"Body"}
+ body={{"description":"The list to create","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"description":{"type":"string","minLength":0,"maxLength":500},"icon":{"type":"string"},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","minLength":1},"parentId":{"type":"string","nullable":true}},"required":["name","icon"]}}}}}
+>
+
+</RequestSchema>
+
+<StatusCodes
+ id={undefined}
+ label={undefined}
+ responses={{"201":{"description":"The created 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"},"hasCollaborators":{"type":"boolean"},"userRole":{"type":"string","enum":["owner","editor","viewer","public"]}},"required":["id","name","icon","parentId","public","hasCollaborators","userRole"],"title":"List"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
+>
+
+</StatusCodes>
+
+
+ \ No newline at end of file