diff options
| author | Mohamed Bassem <me@mbassem.com> | 2025-11-08 21:29:59 +0000 |
|---|---|---|
| committer | Mohamed Bassem <me@mbassem.com> | 2025-11-08 21:29:59 +0000 |
| commit | d9ef832e0b4fb04909a848ae948e22a01613c3b7 (patch) | |
| tree | 1e977b94fca1a36eff16df56535271e8ab0b5e8e /docs/versioned_docs/version-v0.28.0/api/create-a-new-list.api.mdx | |
| parent | 7339d1dfcde77d8945534180f8780ed6cc2063c5 (diff) | |
| download | karakeep-d9ef832e0b4fb04909a848ae948e22a01613c3b7.tar.zst | |
release(docs): release the 0.28 docs
Diffstat (limited to 'docs/versioned_docs/version-v0.28.0/api/create-a-new-list.api.mdx')
| -rw-r--r-- | docs/versioned_docs/version-v0.28.0/api/create-a-new-list.api.mdx | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.28.0/api/create-a-new-list.api.mdx b/docs/versioned_docs/version-v0.28.0/api/create-a-new-list.api.mdx new file mode 100644 index 00000000..35e45c79 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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: eJy1VU1v2zAM/SsGz1qSDtvFt7TYgG4FVqwZdghyYGw2UStLqiS3DQz994GyEzup12JAdwliiZ/vPVINlOQLJ22QRkMOF44wUIaZpqdMSR9AQMCNh3wJV9IHDysBnoraybCDfNnAmtCRm9dhC/lyFVcCHD3U5MO5KXeQNycJFltKcbNgsiIlAwGF0YF0YGu0VskC2Xp659mlAV9sqUL+F3aWIAezvqOCS7POWHJBkudbjRUNrHxwUm9AQCX1FekNV3gmoMLnw9dsFsVxga96z468PydvWYy5RdEdvIxHuq4Yzgp1jQoE+ApdYFxLusVaBcj3d1HAQ01u91ZTUYBFRzpclmOmulYK14ogD66mGFuKpKOS60iodX2sYmyvvTXat6h+nJ2N09jSV+5l8k4kypEWovgLt2+zd9L7K3z9A4L/ndwX+Wy9VrIYmK6NUYQaTtmUJYgjSgeNHcKsBAQZOHwaamhZ/zSbvST6HMusG+j347gw5TiZFXmPm7G7kzZThN4+6Tb5h60pIQdrUr0WeT5gqtLq4s3lHsn5tLhqpyCHBsvSkfdxilZOH89AwCM6yeCnUrvrFpg9g9sQrM+n0+B2k3t0eE9kJ2gtiJEx6SJk5jYLW8q+d/ZZWwtjP1ipN4xgm3m4WA9wcGbuI5mxDJIRiO7PV+Mq5Aq//V4kzJiZn/0+/vKMlVXUL8tecseFH47bcem/uzoO+u4k3Bv0YzTgVepbw0kZ/DbB2WQ2mUGvwwMs8+vLURjn15fZrXHHGDLmPB3Ghwr1oK2xd+xkUxy0PP7otX0Geg5Tq1BqzpMk03SqWoLaP4hbVlu+hKZZo6dfTsXIxx02y1WvqfRGCtgSluSSDO+J4btoi/mw4LRsrmpO/2LIoth7zIuCbHjVdjUYiOsfNwuWSfcoV2kCweETiPSbAwgwCZykvnTWgEK9qdNEQhuTRYXHmjzRYOqqu0K9G1TYNK3FwtyTjhFE10rgb4g8xH8AqpnrCg== +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"}},"required":["id","name","icon","parentId","public"],"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 |
