aboutsummaryrefslogtreecommitdiffstats
path: root/docs/versioned_docs/version-v0.23.1/API/create-a-new-list.api.mdx
diff options
context:
space:
mode:
authorMohamed Bassem <me@mbassem.com>2025-04-13 16:25:03 +0000
committerMohamed Bassem <me@mbassem.com>2025-04-13 16:25:03 +0000
commitf3c525b7f7dd360f654d8621bbf64e31ad5ff48e (patch)
treef9c8378e5c24caf1441f055d0d08b60f8b91a0ab /docs/versioned_docs/version-v0.23.1/API/create-a-new-list.api.mdx
parentae76f9464f2f64018548f4ddfe7b94b92616c6dd (diff)
downloadkarakeep-f3c525b7f7dd360f654d8621bbf64e31ad5ff48e.tar.zst
docs: Revert 0.23.2 docs and just update 0.23.1 instead
Diffstat (limited to 'docs/versioned_docs/version-v0.23.1/API/create-a-new-list.api.mdx')
-rw-r--r--docs/versioned_docs/version-v0.23.1/API/create-a-new-list.api.mdx72
1 files changed, 72 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.23.1/API/create-a-new-list.api.mdx b/docs/versioned_docs/version-v0.23.1/API/create-a-new-list.api.mdx
new file mode 100644
index 00000000..2105ee77
--- /dev/null
+++ b/docs/versioned_docs/version-v0.23.1/API/create-a-new-list.api.mdx
@@ -0,0 +1,72 @@
+---
+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: eJy1VU1v2zAM/SsGz1o+hp58S4sN61BgxZphhyAH1mZitbakSnLbwNB/Hyg7sZN6KQZ0F8OSSJF875FqICeXWWm81ApSuLKEnhJMFL0kpXQeBHjcOkhXcCOdd7AW4CirrfQ7SFcN3BNasovaF5Cu1mEtwNJTTc5f6nwHaXMSYFlQvDfxOsliMBCQaeVJebZGY0qZIVtPHxy7NOCygirkP78zBCno+wfKODVjtSHrJTk+VVjRwMp5K9UWBFRS3ZDacoZzARW+7lcXsyCO8zvrPDtyns/YW2ZjbkF0G2/vI1VXjGaFqsYSBLgKrWdYc9pgXXpI92dBwFNNdvdeTUGAQUvKX+djpqouS7wvCVJvawqhZUhayjmPCFpXxzqE9tgZrVwL6ufZfJzFlr18r5IP4lCOlBDEX6h9n72T2s/w9Q8I/ndyzzMmcxBHtA2SXwvw0rNnbFdoCb2Yzd5yeIl50rXqx9GX6Xycp4qcw+3Y2Ul18YbePkoy+vtC55CC0TFfgyx9mJZxKPFMss9kXRxJtS0hhQbz3JJzYYpGTp/nIOAZrWRcY6rdcQvMnpzCe+PS6dTb3aTQaHOyEzQGxEgDdBckepP4gpLOPGkzYeQHo/KO8WvjDgfmAQyOy1VEM0g7IxDdz1dtK+T8vv9eRsSYl5/9nP3yipUpqR+CvZaO8z5st33Qr7s8DsLttNkb9P0xYFWqjeagDH0bYD6ZTWbQq/Bbh8ri9noUxMXtdbLRNiK4t2XAuSO18xWqQVFjr9PJADjoePwpa6v09OqnpkSpOE6US9MpagXl/pkrWGnpCprmHh39smUIvN0hs1r3eoovn4CCMCcbJfhIDN5Vm8ynJYdl87Lm8G8aLIi9xyLLyPiztutBM9z+uFuySLqntordBxZfQMRvCiBAR3Ci9uJeAyWqbR27Edo7WVJ4rMgTBcaquiNUu0GGTdNaLPUjqRBAdKV4XkPgBv4D5V7dCQ==
+sidebar_class_name: "post api-method"
+info_path: API/hoarder-api
+custom_edit_url: null
+hide_send_button: true
+---
+
+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":40},"description":{"type":"string","minLength":0,"maxLength":100},"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}},"required":["id","name","icon","parentId"],"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