diff options
| author | Mohamed Bassem <me@mbassem.com> | 2025-04-13 16:18:09 +0000 |
|---|---|---|
| committer | Mohamed Bassem <me@mbassem.com> | 2025-04-13 16:18:09 +0000 |
| commit | ae76f9464f2f64018548f4ddfe7b94b92616c6dd (patch) | |
| tree | add456d6e4039e4843125bffad22fd106c281f8c /docs/versioned_docs/version-v0.23.2/API/update-a-list.api.mdx | |
| parent | 969e774ac029c9fd2f82678af7981862966b79f2 (diff) | |
| download | karakeep-ae76f9464f2f64018548f4ddfe7b94b92616c6dd.tar.zst | |
docs: Release the new API docs
Diffstat (limited to 'docs/versioned_docs/version-v0.23.2/API/update-a-list.api.mdx')
| -rw-r--r-- | docs/versioned_docs/version-v0.23.2/API/update-a-list.api.mdx | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.23.2/API/update-a-list.api.mdx b/docs/versioned_docs/version-v0.23.2/API/update-a-list.api.mdx new file mode 100644 index 00000000..3f701461 --- /dev/null +++ b/docs/versioned_docs/version-v0.23.2/API/update-a-list.api.mdx @@ -0,0 +1,72 @@ +--- +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: eJytVd9v2zYQ/leIe9oAznaGDCv05hUtmqHAgs7FHgw90OLZYiqRKnlKrAn634cj5chOlBQD4gdD5B3vx3ff3fWgMRTeNGSchQy+NloRisoEErtOGArCaJBA6hAg28JnEyhALiFg0XpDHWTbHnaoPPp1SyVk23zIJTTKqxoJfYgKoSixVpD1QF2DkEEgb+wBJOBR1U3FVwaNro7doX64e/e7O/77W3kkcsU79m4oqrD3Gw2DBI/fW+NRQ0a+RQlW1axQJQUJhpNpFJXA0bA2BvrD6Y5juEx5U6LQipQgJ9qY/kL8ZatOUIlib7DSQXSuFQ/K0qQjLKLm4w5F49290agXIKFwltASu1FNU5lCsZvlXWBfM0C43R0WBBIa7xr0ZDCwNOXzHK7a2M9oDwz0lYRaHU+n69UgLxN7/ti2VaV2jGQC7czY6sLY1YqtmWLOzBCLi5Zx/qGPQcL3Fn33o1SG+ONChcbZkDD4dbWar1aqgI4sfTvIzUw+g3yhEv8X7DeDMynM9JFta27QWtlWVSAh1MoTd6rGvWorguwke60oT/xddNoW4iiIgIzpnAWfX7YppIJer66f15DlwjoSe9da/XYVLJyeL1WNIajDnOxJgtHCpJ+PtKyRSqfTRCnKmDXTFpbMwLDs09gZGHX096eh1/oKMuiV1h5DGJaqMcv7K5Bwr7xhkGPQozihdKpUSdSEbLkk3y1Kp7xGv1BNA3KmG0YDwu3jxBrVRYqEy3A2rf9mJJPf85n9CAv75SyiGmSjEsjx46PzteL4/vxnE7HjCn2ZhuuH0zA/DbCJWJdxP16nppjOUy9MdyNZz+pp7N6xE4Y6GbxarBars03xaURhfXszC9r69kbsnY+InXQZYG5HF6hW9iyJcSmq08B50vmP7H15eyZ0CY+0bCplLPuJ9OhHKm3j6gogIRt3WC6hdIFY1Pc7FfCrr4aBr0c8tvnEpMg3bQJ/a8j2qgr4Spw/fRk5/7N4KbrxUtkuErZq+QQSvmE37dkhHySUqDT6GEESvk9+ftmwienxs84e5OnFuiiwoVd187MuvF1v3n9iUo77vI59D149gIz/MVIXE49cj3c9VMoe2jgHIBllCqvLDnjC+JjWLBZ9nzQ27hvaYXiEhvjMyAzDfypDMuk= +sidebar_class_name: "patch 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={"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}}}}}}} +> + +</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}},"required":["id","name","icon","parentId"],"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 |
