-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
98d5ef0
commit 26f007c
Showing
8 changed files
with
397 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
--- | ||
id: todo-controller-create-to | ||
title: "Create todo" | ||
description: "Create todo" | ||
sidebar_label: "Create todo" | ||
hide_title: true | ||
hide_table_of_contents: true | ||
api: eJzNV99v2zYQ/lcIPq2AvDi2l2V6GJDYewiKLUXivswwjLN4tthKokrSSQPD/3txpCSTzjYrBQosMAJbvDvez+8+7bmqUYOVqroTPOVzJdRUVVarokC9yjSCxbniCa9BQ4kWteHpYplwjV92aOytEi883bufUqPgqdU7THimKouVpSOo60Jm7o6LT0ZV9MxkOZZA3+xLjTzlav0JM0v3aPLISjRO1xi5rVCs1i+BsLFaVluecIEm07Im0zyNhBOOX6GsCxIf4QR/2/x6NRDjq2wwGV1fDuDqFxggwDi7Xl9tEEb8kBz1rXrDZVZ912UGK4F6VZrt+bsC2fCqPyGXJbDHHEiPNRVBwaxiGgfeQ3YjTQ7sNgdrWYGgK1lt2RQri5pttCpT9l5pEJINfmfvc6hBSzbLQZc7ctPV8atdSXHezUD2ezLSqPe+J7okU7nS1iXWgrYrARZ7JPYoG3k8HE0Gw/Hg8np+OUyH9PmbTIsd9jTcSfYxa2xfZ08M1rt1IU1ONqy0RQ8bXiy08YC+T5wRp3vWBp2GJo4GICMZitzN9snEuMMZnQXa+1apgpKM6dafhKtCTFWuLCHTol8bLRNe4fPUNUNvtTFfku9Fcb/h6eIcJDVeefunMd4XgvlTdjdjP7WoyOSGBWEyaVgb57swGT3dTfqITSgZTSigNRAmSoulCSrsnx8OJ1k7jeovfP7hUY36RTV+U1Q0MjtzvqUfnRz7j8AEFmjxXdz3OsvlE4qg830Tn90dgXBosOt98v24URdRz8W16mKMXVh2iMBvurGbWcUPyzekZZ4j87JMbZjNkVkwnyOXZZUp+mrxldPxOo73ZbTRor1xBPcInANAbXGwxbIGj0Ls6UIM8jBtuIxQLg8H766pVWX8YI+Gl69bn+SZV3V1ngyHr4VuQbTb12XBwpZYklMmF2Jpb41ZOkx4iTZXRL1qZRzYgM15yi/o+MLzL5cv/dRRLyJRD0f69UcApSFd6jt1Ee3pqxTSlx9PRGIe0tfHjlC07CAmB/+8j8Mt/28SzcLu9u+xyR6O26sFo/b3yW78n2y9FgqiQU64rDaeAzdxUTeyEirYYkm0/lVPP3ycsZsPdzzh1Kf+4eXPw6YKkBGto9GgLi/BvQM0ocfjEJnt8InKeFEXIB3L2OmCzvykLHij2czKMuE5TVK64Pv9Ggx+1MXhQI+/7FC/+Al6Ai1h7XYTJSFHEKjd7v+MNDlT//YymHtoeYJi52p5+iZzWAYD/OH+cc4Tvm7eiEolXGXhmSfuf8qpui40hzfu2Z4XUG13sCVZb5P+vgFLOn/R | ||
sidebar_class_name: "post api-method" | ||
info_path: docs/todo-service/apis/todo-management | ||
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 todo"} | ||
> | ||
</Heading> | ||
|
||
<MethodEndpoint | ||
method={"post"} | ||
path={"/todo/create"} | ||
context={"endpoint"} | ||
> | ||
|
||
</MethodEndpoint> | ||
|
||
|
||
|
||
Create todo | ||
|
||
<Heading | ||
id={"request"} | ||
as={"h2"} | ||
className={"openapi-tabs__heading"} | ||
children={"Request"} | ||
> | ||
</Heading> | ||
|
||
<ParamsDetails | ||
parameters={[]} | ||
> | ||
|
||
</ParamsDetails> | ||
|
||
<RequestSchema | ||
title={"Body"} | ||
body={{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"assigned_by":{"type":"string","description":"assigned_by","example":"2e4e9f76-d36c-4281-a65a-eaa3c8b6fea2"},"assigned_to":{"type":"string","description":"assigned_to","example":"2e4e9f76-d36c-4281-a65a-eaa3c8b6fea2"},"sender_msg":{"type":"string","description":"sender_msg","example":"Mahima Shastri requested to re-assign Aisha Bhatt learning Center from: Koradi -> Khapari Dharmu"},"context_id":{"type":"string","description":"context_id","example":"2e4e9f76-d36c-4281-a65a-eaa3c8b6fea2"},"context":{"type":"string","description":"context","example":"cohort"},"start_date":{"type":"string","description":"start_date","example":"2024-03-18T10:00:00Z"},"due_date":{"type":"string","description":"due_date","example":"2024-03-18T10:00:00Z"},"state":{"type":"string","description":"state","example":"publish"},"title":{"type":"string","description":"title","example":"Reassign"},"type":{"type":"string","description":"type","example":"assign"},"action_data":{"description":"actionData","example":{"action_name":"reassign","oldCohotId":["2e4e9f76-d36c-4281-a65a-eaa3c8b6fea2"],"newCohortId":["2e4e9f76-d36c-4281-a65a-eaa3c8b6fea3"]},"allOf":[{"type":"object","properties":{"oldCohortId":{"description":"Old Cohort ID (required if action_name is reassign)","example":["2e4e9f76-d36c-4281-a65a-eaa3c8b6fea3","2e4e9f76-d36c-4281-a65a-eaa3c8b6fea4"],"type":"array","items":{"type":"array"}},"newCohortId":{"description":"New Cohort ID (required if action_name is reassign)","example":["2e4e9f76-d36c-4281-a65a-eaa3c8b6fea2","2e4e9f76-d36c-4281-a65a-eaa3c8b6fea3"],"type":"array","items":{"type":"array"}},"status":{"type":"string","description":"Status required if action_name is delete)","example":"archived"},"action_name":{"type":"string","description":"action_name","example":"reassign"}},"required":["oldCohortId","newCohortId","status","action_name"],"title":"ActionDataDto"}]},"status":{"type":"string","description":"The status of the task","example":"incomplete"}},"required":["assigned_by","assigned_to","sender_msg","context_id","context","start_date","due_date","state","title","type","action_data","status"],"title":"CreateTodoDto"}}}}} | ||
> | ||
|
||
</RequestSchema> | ||
|
||
<StatusCodes | ||
id={undefined} | ||
label={undefined} | ||
responses={{"201":{"description":"Todo Created"},"400":{"description":"Bad request"}}} | ||
> | ||
|
||
</StatusCodes> | ||
|
||
|
||
|
71 changes: 71 additions & 0 deletions
71
docs/todo-service/apis/todo-controller-delete-todo-by-id.api.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
--- | ||
id: todo-controller-delete-todo-by-id | ||
title: "Delete todo" | ||
description: "Delete todo" | ||
sidebar_label: "Delete todo" | ||
hide_title: true | ||
hide_table_of_contents: true | ||
api: eJxtkkFv2zAMhf+K8U4bICzZjrptTQ4BeiiK9hQEBWsxsVBZciW6mGHovxeMjWHtdrL9yEd9j/KMNHAm8SkeHCwekks3KUpOIXB+chxYWMVf08HBYKBMPQvnAnucEalnWHgtZX4dfWYHK3lkAx9hMZB0MChtxz3BzpBpUEeR7OMFtZ7UWIYUCxet/9hu9eG4tNkPyrVSNQtLU8a25VLOYwgTajUQuijMtQkn88m6W1yiRYOepUuacxl2DSQdLDbasJm9q0rL+W1JeNIY53QF9xKUXBubniJduOco+Hzgzf3jrvl5d4CBDlnE79+2MGhTFGoFdlbuIRXpKersdY0fWT+M/bM44d+yGQL5iGow5qC1JcQRq9N6p4voUhFV5/mZCj/mUKvKryPnacn2RtnTs8Y6znC+6LuDPVMo/A+A0mtgiy/361V/bWD+D7aKFCfdA4VRv2DwwtPyv9RT/es6dvvb/cMetb4DepXcoA== | ||
sidebar_class_name: "delete api-method" | ||
info_path: docs/todo-service/apis/todo-management | ||
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={"Delete todo"} | ||
> | ||
</Heading> | ||
|
||
<MethodEndpoint | ||
method={"delete"} | ||
path={"/todo/{id}"} | ||
context={"endpoint"} | ||
> | ||
|
||
</MethodEndpoint> | ||
|
||
|
||
|
||
Delete todo | ||
|
||
<Heading | ||
id={"request"} | ||
as={"h2"} | ||
className={"openapi-tabs__heading"} | ||
children={"Request"} | ||
> | ||
</Heading> | ||
|
||
<ParamsDetails | ||
parameters={[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}]} | ||
> | ||
|
||
</ParamsDetails> | ||
|
||
<RequestSchema | ||
title={"Body"} | ||
body={undefined} | ||
> | ||
|
||
</RequestSchema> | ||
|
||
<StatusCodes | ||
id={undefined} | ||
label={undefined} | ||
responses={{"200":{"description":"Todo delete successfully"}}} | ||
> | ||
|
||
</StatusCodes> | ||
|
||
|
||
|
71 changes: 71 additions & 0 deletions
71
docs/todo-service/apis/todo-controller-todo-get-by-id.api.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
--- | ||
id: todo-controller-todo-get-by-id | ||
title: "Get by id todo" | ||
description: "Get by id todo" | ||
sidebar_label: "Get by id todo" | ||
hide_title: true | ||
hide_table_of_contents: true | ||
api: eJytUktr3DAQ/ivmO7UgutsedWuSsviUEpJTWMLsamKL2pIjjZcao/9eZr0Jm6TNqSfBPL7XaEYcOJH4GGoHi9vo4mUMkmLXcXqQ6OKG5WKqHQwGStSzcMqw9zMC9QwLr63ET6NP7GAljWzgAywGkhYGed9yT7AzZBp0I0vyoUEp5gVkzJzqfwI9jZymD5G2upmHGDJn7X9br/VxnPfJD2pPzV1fXVcNS7WbqtopP4QaNXP0ja15s7BZZr2rNAgY9Cxt1JwalmMg0sJipd3V7F1RjZwOS0JbVf8Yj3K9dKpXB6ueAjXcc1CI14SXN3dX1fefNQwUZCl+/bKGwT4Gob3Azqp7iFl6Cop9SvCd1lfIL4kJ/5bV0JEPKAZj6rS3+LjHadN6p1m0MYtW53lHme9SV4qWl2PoB3A+067TWz1Sl/kdpUpWlxafbk5n/VzB/F3KL57O/8GBulGHoKc9UPLK9P9ZT0UK0znnsxrvULbl7OybH7co5Q/pOhGL | ||
sidebar_class_name: "get api-method" | ||
info_path: docs/todo-service/apis/todo-management | ||
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={"Get by id todo"} | ||
> | ||
</Heading> | ||
|
||
<MethodEndpoint | ||
method={"get"} | ||
path={"/todo/{id}"} | ||
context={"endpoint"} | ||
> | ||
|
||
</MethodEndpoint> | ||
|
||
|
||
|
||
Get by id todo | ||
|
||
<Heading | ||
id={"request"} | ||
as={"h2"} | ||
className={"openapi-tabs__heading"} | ||
children={"Request"} | ||
> | ||
</Heading> | ||
|
||
<ParamsDetails | ||
parameters={[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"userId","required":true,"in":"query","schema":{"type":"string"}}]} | ||
> | ||
|
||
</ParamsDetails> | ||
|
||
<RequestSchema | ||
title={"Body"} | ||
body={undefined} | ||
> | ||
|
||
</RequestSchema> | ||
|
||
<StatusCodes | ||
id={undefined} | ||
label={undefined} | ||
responses={{"200":{"description":"TODO get by Id"}}} | ||
> | ||
|
||
</StatusCodes> | ||
|
||
|
||
|
71 changes: 71 additions & 0 deletions
71
docs/todo-service/apis/todo-controller-update-todo.api.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
--- | ||
id: todo-controller-update-todo | ||
title: "Update todo" | ||
description: "Update todo" | ||
sidebar_label: "Update todo" | ||
hide_title: true | ||
hide_table_of_contents: true | ||
api: eJy1Vm1v2zgM/isCP22AvbpZ13b+cEDXHnDFcMDQJV+uKALGomNttuRJ8rog8H8fKDkvbu6Q3A7XL21pvjykyIdcg2nJoldG30vIYWqkuTXaW1PXZOddK9ETCyGBFi025Mk6yB/XoLEhyEFJSMDSt05ZkpB721ECSkMOLfoKEnBFRQ1Cvga/atnCeav0Evr+KRqS8x+MXLHGSz+F0Z6050/YtrUqAtKzL85olh24NosvVHjGajkvr8gFPdKS7Lxxy0MYCUhyhVUte2bxTjcB+oFNW7P2n1ipBsXnCtlODLhJCm+EpRSdU0stbpSrUHyo0HtRE1qt9FLckvZkRWlNk4uPxqJUIv1NfKywRavEXYW26aAfsv3h50oeh3l/J0wpfEUCnTOFQsYyOBgBp7LMsmu8Tifvrt6mF5eXMl1cX12lpZTlJV6Uxflb2gt+PPJtVBSjKJ0jy15iHUjOvTnuaTbbZcEOuJbPlWmCwKP7KpQTG4+/lJTzaP2ce5jRlMY26CEHFqReNQTJEYjTikRwIthmA5YHIgAcgZpkk4s0e59O3k3P3+dZlmfZXwxCdvRfIciOIoDS2F9A4Dz6zp3Q+0HvIEvxit4sE1EYDuNJJsISzxnJ16PwWwWO6ZWv6XhIzi6oHta231TmJB+r9sjzOKpL9qkkYT0PpT/Jc9AXrB+qPyTJg71p01GYbBILH+rekvb/IlQIEoyE0cfc9/u0+zjmrT0m2U32eDpHw7HXpNtu2Tzh8Aqjwo1Se9o+Nsy2++LOG+j7CNK1RrvIxJMs418vUuf3iqZSfO4Kcq7s6noVcvS45H0TlDjUCwoJVsLHDdWQr4yMq6eowsryFeRwxt/P1kr2jJzs97jDnhLgTfKw20G/b+o83hn/P/uPyf80ftvj7Mi/L+j3VC/7JPn3FLLPYf+kseGYPRbY9cW25zczwLM4HsVdZ4/nZjRQSpdxrwx++V1FgxqX1PCdcLCrHmZ34ubTPSTAbx6F52+yoXZY8L7jLmuN8w2Go2K4a8adNXK7HWUu/llbo9IMrrM1f4s99wiDZa4kt21lnGfper1ARzNb9z2Lv3VkV7EVv6NVuOC0HtcgleO/JeQl1o4OAGwPI3j1MJDAa7Gr7xjYIES94jpg3fF/kMBXWsUDrn/qE6gIJdkQPX64jTHSaRz/jeHBIcZ33HbyPt1Mb/+ABBbDRdcYyUYWn/lMxOcY2YREAiME2Rpq1MsOl6wbnfLPT0wWiD4= | ||
sidebar_class_name: "patch api-method" | ||
info_path: docs/todo-service/apis/todo-management | ||
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 todo"} | ||
> | ||
</Heading> | ||
|
||
<MethodEndpoint | ||
method={"patch"} | ||
path={"/todo/{id}"} | ||
context={"endpoint"} | ||
> | ||
|
||
</MethodEndpoint> | ||
|
||
|
||
|
||
Update todo | ||
|
||
<Heading | ||
id={"request"} | ||
as={"h2"} | ||
className={"openapi-tabs__heading"} | ||
children={"Request"} | ||
> | ||
</Heading> | ||
|
||
<ParamsDetails | ||
parameters={[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}]} | ||
> | ||
|
||
</ParamsDetails> | ||
|
||
<RequestSchema | ||
title={"Body"} | ||
body={{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sender_msg":{"type":"string","description":"sender_msg","example":"Mahima Shastri requested to re-assign Aisha Bhatt learning Center from: Koradi -> Khapari Dharmu"},"context_id":{"type":"string","description":"ID of the associated context","example":"eff008a8-2573-466d-b877-fddf6a4fc13e"},"context":{"type":"string","description":"Context ","example":"user"},"assigned_to":{"type":"string","description":"UUID of the user to whom the task is assigned","example":"eff008a8-2573-466d-b877-fddf6a4fc13e"},"start_date":{"format":"date-time","type":"string","description":"The start date of the Todo task","example":"2024-09-25T19:00:00Z"},"due_date":{"format":"date-time","type":"string","description":"The due date for the Todo task","example":"2024-09-25T19:00:00Z"},"status":{"type":"string","description":"status of the Todo task (e.g, completed, rejected)","example":"completed"},"title":{"type":"string","description":"The title of the Todo task"},"type":{"type":"string","description":"The type of the Todo task","example":"self"},"ideal_time":{"type":"string","description":"The ideal time for completing the task","example":"02:00:00"},"spent_time":{"type":"string","description":"The time spent on the task","example":"02:00:00"}},"required":["sender_msg","context_id","context","assigned_to","start_date","due_date","status","title","type","ideal_time","spent_time"],"title":"UpdateTodoDto"}}}}} | ||
> | ||
|
||
</RequestSchema> | ||
|
||
<StatusCodes | ||
id={undefined} | ||
label={undefined} | ||
responses={{"200":{"description":"Todo Updated Sucessfully"}}} | ||
> | ||
|
||
</StatusCodes> | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
--- | ||
id: todo-controller-view-list | ||
title: "Todo List" | ||
description: "Todo List" | ||
sidebar_label: "Todo List" | ||
hide_title: true | ||
hide_table_of_contents: true | ||
api: eJy1Vktv2zgQ/ivEnHYBeqM8msS6tUkWCFAgRepe1jACWhzZ7FKiSlJODUP/vRhSlqUoTd1DfbLImW+G8/hmdmAqtMIrU95LSGFmpLkxpbdGa7RPG4XPH5XzwKESVhTo0TpI5zsoRYGQQu3Q3kvgYPFbrSxKSL2tkYMqIYVvNdotcHDZGgsB6Q78tiI1560qV9A0i6iJzn8wcksSL4EyU3osPV2JqtIqC86efHWmpLMRtFl+xSw4bOlpXqGjW60K5XtiZV0s0QIHiS6zqiJQSOFjEGs4mDx3eITCQ5RrOORKx+jsXoj8Gy9YbixzKGy2Bg5C64c8RPJtv4VzalWifFpux/HjgN9FUWk6uroU7/D6Qkwuzs8vJxdX2fVken2ZT6bX+ZWQp9MEk+XI+z56ww+f3vxJY96QsZDY7/5JyT9gqwd+MPW2HSrlEc57a8WWmZw5LzyyjdA1upSRLM/M2ljKGJZ1AekcqnqplaPsSityuqFkqw1KWDQcAsTbPvQQfu5G7To/WnnOgkHemTvaJ6+8/oVPdxssPZsFwZd+xbsIQvWT0flT5Ia3MC3GYhgBztbIIgojbeYNWyKr0ObGFoOHDSA0euxiXIfG6YzNITP0zwd1Ve6/AmlRz1Eojg14B8XZAYmzDojvHy0IgOx5LNxrzMdB1vgk25IYWr+tkdENs6JcIYvM8hukkVtTvJ2As+TsYpJMJ2fJ7PQ6PU/SJPlvlIzPXlhPQZADfyjTvyKIDv+c8M+m6bvpGP+ulK+hN/1pMo+PCRYXXb1ShB5J+nb2AM3ipUqf1oasNqCdAzHsm3NvYFjKXVn1ctbzpeX3112Jc6ebJ4cxMQJ4jHMwwDQRxlWmdDGlZ0kyrhOa1ozmM8vRZ2uUzNVZhs7ltdaB0S9eU/sgJGunboi2Fysa6gFu3AqdEeBQoF8b2hMq0y4Ffg0pnHgjzYmOMg7tJm4JCw40ph8PA/5uXyDdQE4OozYZzNDB4Dt2CAwG2LFK/UH0mzqHsdGSe49v99kd8ueAIvsktmeuY+mqRx6x3X/W0yEUr/ZjqDJV5rGXW3cplawQpVhhQXvXy3K4efxyy95/ugcOlOZ4ePpP0gZFZDRmCZhKpBBhSWtf26+kAWjHJBTTk0oLVVLx1lbTXSyyefAMOIQyW3BYUwmmc9jtlsLhF6ubho7jzkkcKZUTS01tmAvtcGSz2yzhr8e2Y/9mBwYf+vI/bvvrbpgHkALQBrsRVpElKvmGwxqFRBtciFo30dBkRsAH3dE6S1hdh316+DwDDst2LS6MDAUjnqkQxDPZ5mDCY0K/hLMdaFGuarEi2YhJvx/JLvVr | ||
sidebar_class_name: "post api-method" | ||
info_path: docs/todo-service/apis/todo-management | ||
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={"Todo List"} | ||
> | ||
</Heading> | ||
|
||
<MethodEndpoint | ||
method={"post"} | ||
path={"/todo/list"} | ||
context={"endpoint"} | ||
> | ||
|
||
</MethodEndpoint> | ||
|
||
|
||
|
||
Todo List | ||
|
||
<Heading | ||
id={"request"} | ||
as={"h2"} | ||
className={"openapi-tabs__heading"} | ||
children={"Request"} | ||
> | ||
</Heading> | ||
|
||
<ParamsDetails | ||
parameters={[{"name":"userId","required":true,"in":"query","schema":{"type":"string"}}]} | ||
> | ||
|
||
</ParamsDetails> | ||
|
||
<RequestSchema | ||
title={"Body"} | ||
body={{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"limit":{"type":"number","description":"Limit"},"offset":{"type":"number","description":"Offset"},"filters":{"description":"Filters for search","allOf":[{"type":"object","properties":{"assigned_by":{"type":"string","example":"76a5e84a-4336-47c8-986f-98f7ad190e0b","description":"assigned_by"},"assigned_to":{"type":"string","example":"76a5e84a-4336-47c8-986f-98f7ad190e0b","description":"assigned_to"},"context_id":{"type":"string","example":"76a5e84a-4336-47c8-986f-98f7ad190e0b","description":"context_id"},"context":{"type":"string","example":"user","description":"Array of state values: user,cohort","enum":["publish","draft","archived"]},"state":{"type":"string","example":"publish","description":"Array of status values: publish, draft,archived","enum":["publish","draft","archived"]},"title":{"type":"string","example":"Event Title","description":"Event title"},"action_name":{"type":"string","example":"reassign","description":"The action type to be performed","enum":["reassign","delete"]},"status":{"example":["completed","incomplete","rejected"],"description":"Array of status values: completed, incomplete, rejected","type":"array","items":{"type":"string"}},"due_date":{"description":"Due date range filter","allOf":[{"type":"object","properties":{"from":{"type":"string","example":"2024-09-20T18:30:00Z","description":"Start of due date range"},"to":{"type":"string","example":"2024-09-23T18:29:59Z","description":"End of due date range"}},"required":["from","to"],"title":"DueRangeDTO"}]}},"required":["assigned_by","assigned_to","context_id","context","state","title","action_name","status","due_date"],"title":"FiltersDTO"}]}},"required":["limit","offset","filters"],"title":"FilterRequestDTO"}}}}} | ||
> | ||
|
||
</RequestSchema> | ||
|
||
<StatusCodes | ||
id={undefined} | ||
label={undefined} | ||
responses={{"200":{"description":"Todo List fetched successfully"},"400":{"description":"Bad request"}}} | ||
> | ||
|
||
</StatusCodes> | ||
|
||
|
||
|
Oops, something went wrong.