diff --git a/docs/user-service/apis/auth-rbac-controller-sign-in-rbac.api.mdx b/docs/user-service/apis/auth-rbac-controller-sign-in-rbac.api.mdx new file mode 100644 index 0000000..289f711 --- /dev/null +++ b/docs/user-service/apis/auth-rbac-controller-sign-in-rbac.api.mdx @@ -0,0 +1,71 @@ +--- +id: auth-rbac-controller-sign-in-rbac +title: "AuthRbacController_signInRbac" +description: "AuthRbacController_signInRbac" +sidebar_label: "AuthRbacController_signInRbac" +hide_title: true +hide_table_of_contents: true +api: eJyFUsGK2zAQ/RUzpxbUOulRt2Vbiullye6egikTexKL2JJXGoe6Rv9exkrSmHTpxTKa0Zv33rwJXE8e2Thb1KDhYeBms8Pq0Vn2rm3J/wzmYAsrl6CgR48dMfkAejuBxY5AA5NFy6YGBcaChoawJg8KagqVN73Ag4aXuS0rpM/T22A81aDZD6QgVA11CHoCHnvBDOyNPUCMpTSH3tlAQepfVis5ltAQowLGg9C6ioBSQaBq8IbHmS5WFYXwid2RLOhtKdhLnP/p74gbJ0YdiGc7uAEN+RDI56d1jgM3ud9hlacZMt+fkls3ZJ5FbFKzpHRVj735QeOdn2e/haXz5ve8t1m6sXs3PzfcSsdzY46hweypRd47393t4nHz+jV7eCpAgfBLl+vPK1BQOctYMehJkHsXuMOZ2830TPzI/rqUiUtZYbOzT4thV1VMvzjvWzQWooLBt1JLHm5BPBQ2a1AgPkpIElgyp1TQuMDSOk07DPTq2xjl+m0gPyaHT+gN7sSCbRnVxTjZfW2CFGrQe2wD3VEU1WQZNHzYnLP5MbtN7D81HGlc5v+E7UBzIMubtHz/9nJRtdjxcd7x+UdYXkp2vMFarvsyVL5RvfNkmlKCYrz2p9K7L64ZS90ir4wx/gG9GWSL +sidebar_class_name: "get api-method" +info_path: docs/user-service/apis/shiksha-platform +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={"AuthRbacController_signInRbac"} +> +</Heading> + +<MethodEndpoint + method={"get"} + path={"/user/v1/auth/rbac/token"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +AuthRbacController_signInRbac + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"name":"tenantid","in":"header","description":"Tenant Id","required":true,"schema":{"type":"string"}}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":""}}} +> + +</StatusCodes> + + + \ No newline at end of file diff --git a/docs/user-service/apis/cohort-members-controller-craete-bulk-cohort-members.api.mdx b/docs/user-service/apis/cohort-members-controller-craete-bulk-cohort-members.api.mdx deleted file mode 100644 index b5ef001..0000000 --- a/docs/user-service/apis/cohort-members-controller-craete-bulk-cohort-members.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: cohort-members-controller-craete-bulk-cohort-members -title: "Bluk Cohort Member Create" -description: "Bluk Cohort Member Create" -sidebar_label: "Bluk Cohort Member Create" -hide_title: true -hide_table_of_contents: true -api: eJytlMlu2zAQhl9FmDMTxz3qlrg9BEXRIMvJMIoxNbYYU6TCxY0q8N2LoWzFitMCBXqRLXLWb/5RD7Ylh0FZc1tBCQtbWxe+UbMm5xfWBGe1JvdDOqRAN1HvJhYgoEWHDQV+KZc9GGwISkCJFTVKdoROVSBAGSihJqzIgQAva2oQyh5C17K9D06ZLaQkxhCBDJrwT84rAY5eIvlwY6uOLfhVOaqgDC6SAGlNIBP4CttWK5lbnz17a/jsLLRdP5MM3KZjUEGRh7JPAoIKmg3eI4GUUuIyfGuNz9bw6WrOPxV56VTLCUfSxeBV1OiLNZEppCMMVBU+Skneb6LW3SVzgYBbRjx1hJUATzI6FbrMH7PbRbA7MlAuV8xkmvhGx10xzb7ISUFAQ6G2rIPW+tw1hhpKmEVPbrafz2R2a7LXbM2tHz09uf2ggZOKHhjnwGBa18gXW/WVurMRHyRwHUNtnfqVh5Qh8KDu30b85RWblufAI1FmY3Pow2gearXzNRZ3GsPGugbek1jcP30uru9uQQDXPhzOL69g0AlK1glnZRoN5roPlf0N4iTJ2Gmg1zBrNSoDSUB0mu8GvktgvlzFPKd+YwwCTiivBNQ8l3IJfb9GT09Op8THL5FcN7Dfo1O4ZgDLVRJHpCyNSnm+qKDcoPZ0Vui4GwDi46p31H2023vUkY2Bt/d/ZTlZ/0n84XYxRLl45ABvFmc7zfIfRX33/eGRiR6+DY2t2MfhTxD5mUuyudKs2XzWg0azjbhl2yEmSwIjT+5Ux7us48Mf5n28Mt1JhVNJH5vlJzf3oUvfD1uS0mg/XP3RY9yjwZqxrlJKvwHj4weD -sidebar_class_name: "post api-method" -info_path: docs/user-service/apis/shiksha-platform -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={"Bluk Cohort Member Create"} -> -</Heading> - -<MethodEndpoint - method={"post"} - path={"/user/v1/cohortmember/bulkCreate"} - context={"endpoint"} -> - -</MethodEndpoint> - - - -Bluk Cohort Member Create - -<Heading - id={"request"} - as={"h2"} - className={"openapi-tabs__heading"} - children={"Request"} -> -</Heading> - -<ParamsDetails - parameters={[{"name":"academicyearid","in":"header","schema":{"type":"string"}},{"name":"tenantid","in":"header","schema":{"type":"string"}}]} -> - -</ParamsDetails> - -<RequestSchema - title={"Body"} - body={{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"title":"BulkCohortMember"}}}}} -> - -</RequestSchema> - -<StatusCodes - id={undefined} - label={undefined} - responses={{"201":{"description":"Cohort Member has been created successfully."}}} -> - -</StatusCodes> - - - \ No newline at end of file diff --git a/docs/user-service/apis/cohort-members-controller-create-bulk-cohort-members.api.mdx b/docs/user-service/apis/cohort-members-controller-create-bulk-cohort-members.api.mdx new file mode 100644 index 0000000..a13f6dd --- /dev/null +++ b/docs/user-service/apis/cohort-members-controller-create-bulk-cohort-members.api.mdx @@ -0,0 +1,71 @@ +--- +id: cohort-members-controller-create-bulk-cohort-members +title: "Bulk Cohort Member Create" +description: "Bulk Cohort Member Create" +sidebar_label: "Bulk Cohort Member Create" +hide_title: true +hide_table_of_contents: true +api: eJy1Vdtu2zAM/RWBTxvgNHGappvf2mwPxTCs6OUpCAbaZmI1tuVKctrM8L8PtBLn4q7obn6zKJKHPIdUBaogjVaq/CqGACYqUdp+pSwkbSYqt1qlKenvkSa0dFmmy4Mb4EGBGjOy/BNMK8gxIwigNKSvYvBA02MpNcUQWF2SBzKHAB5L0mvwICYTaVlw9tZHtB4e0DNmRcrx/OEpjc7G5z368DHs+cP4tIejs3FvNByP/ZF/PhoMBuCBiRLKEIIK7LpgP2O1zBdQ114LDSOMKZPRmlBLztJASghj0i8AfktISznm9q+CzdxlMvZSxWu+cewbqdxSbtmERZHKqGGt/2C4eVU3tAofKLLMkGaOrSTD1g0zQXXU/buEhLMZoebCJiSihmqRtVxvIqPWyPRJS5l5sTPgXH+VZ2v9F5k0ZWpFkzfms0qEJJxPLOZaZb+RrN4ndLrTeFtsB83MAytto+Dj2eF4TUBTqNw4boYDv1uAcxLOSyRoREiUCzeRsTBlFJEx8zJN1ydNRywueBYPHRnKYVwGJA6DT5qY4EFGNlG8DwplGgmhTSCAPpfcX/l9V7Gjqx9yZVtPQ3rldsGMf6JSS7u+ZW26ErFB27NqSflej7GQX2jdmZ/NfF2UNlFa/mgU39TIqr/Zzcvn7aLY6Xu65W22r8b902Pl7Gw145irBt+GvttELk2C4jpFO1c662yvyc39J3FxfQUecAPcoX8yADe5GPHkMnRuaYZN8ZvyXmPiIEnbLkvPtl+kKHOoPSh1yjZHktMlo/BbaTqiwIM9qmYeJExuMIWqCtHQvU7rmo/dduZlHkuDYcpqn2NqqIOmXUnw7mYzGO9Fd42/CHpJ6/13YoVpyZeAN+EKteTErKLa28rhjxG9DqHzHuygeP8l4d5rcZDKWScuYO+OA+xudFY+96kd0+tvt3dM7+bpyFTMPhqfeCXhE2fwQDWgmylszipIMV+UuOC7LiZ/PwFFZsQK +sidebar_class_name: "post api-method" +info_path: docs/user-service/apis/shiksha-platform +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={"Bulk Cohort Member Create"} +> +</Heading> + +<MethodEndpoint + method={"post"} + path={"/user/v1/cohortmember/bulkCreate"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Bulk Cohort Member Create + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[{"name":"userId","required":true,"in":"query","description":"userId required","example":"123e4567-e89b-12d3-a456-426614174000","schema":{"type":"string"}},{"name":"academicyearid","in":"header","required":true,"schema":{"type":"string"}},{"name":"tenantid","in":"header","required":true,"schema":{"type":"string"}}]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"description":"The userIds of the cohort members","type":"array","items":{"type":"string"}},"cohortId":{"description":"The cohortIds of the cohort members","type":"array","items":{"type":"string"}},"removeCohortId":{"description":"The cohortIds to be removed from","type":"array","items":{"type":"string"}}},"required":["userId","cohortId","removeCohortId"],"title":"BulkCohortMember"}}}}} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"201":{"description":"Cohort Member has been created successfully."}}} +> + +</StatusCodes> + + + \ No newline at end of file diff --git a/docs/user-service/apis/cohort-members-controller-create-cohort-members.api.mdx b/docs/user-service/apis/cohort-members-controller-create-cohort-members.api.mdx index 557b24a..a64ab75 100644 --- a/docs/user-service/apis/cohort-members-controller-create-cohort-members.api.mdx +++ b/docs/user-service/apis/cohort-members-controller-create-cohort-members.api.mdx @@ -5,7 +5,7 @@ description: "Create Cohort Member" sidebar_label: "Create Cohort Member" hide_title: true hide_table_of_contents: true -api: eJy1VMtu2zAQ/BVhz0wc96hb6vQQBEWDPA6FYRRram0xlkiFpNyogv69WFKWLdsB0qK9yJb2wdnZGbZgKrLoldG3GaQwM7mx/iuVS7JuZrS3pijI/pCW0NMoCgIqtFiS55d03oLGkiCFjLZKkspAgNKQQk6YkQUBTuZUIqQt+KbiTOet0mvoOjEUo8SMSiUbQvuXLTxp1P6PihcCLL3W5PxnkzWcwa/KUgaptzUJkEZ70p5DWFWFkoGzyYszmr+dtDbLF5KeObLMsFfkOCoDg0z1MQgBGTlpVcV9IYWnnJJddmJWiR/ek3JYQEYrrAsPKUAn+ubXPYPfCe1HDjpbddy6dvShZow65n4IcycOiJ7v2XlnlgHHQoBXvqBjxd54A10X27rKaBdZ/3Q15Z8x1FiYxMokR5csiXQSlZ4lrpaSnFvVRdFcBqQe16zzcSFDcSRrq3wTTICh7MKbDWlI5wvW1tHB4YRk3EZAST437MHKuCAc9DmkMOGRJ9vpJDISeZxElKxpstvovwMgj6zGOPoYzrA+rNQdNScO6R10XfvcWPUraDzMzjp/2DvkyxuWFdN/qOi9Js4LcR/fqWkwIONYmYCvX+tjrjYux+S+QL8ytjxR2uzh+Sa5vr8FAUxA/Di9vILoVZTsVYbOdJYYhu/He2cBo/4DU57e/KQqUOngA1twLO5mHgZhANNh6HLXrd/QQkDO+0zn0LZLdPRsi67jz6812SbubYtW4ZLnni86sVsHqylTjgMZpCssHJ2AHK4lAHEe8Yaa8Z28xaKmaOt/1//k2v4vpxzc7KP+MTqLXS6euME+4+S6ZkcOZrv/9vgEApb9tV+ajGss/gQRngGSCUiDn8K3FgrU6xrXnBt7stKwZlUcemwTPNb/4X3uQro5QDi2225YfvJwZ0vaNjq464b8GHq3YvB4zGZaF13X/QbJdLze +api: eJy1VU1v2zAM/SsGTxugNs2OvnXtDsUwrOjHYQiCgbGZWI0tuZKc1jP83wdKjmMn6ZAO26WpRfHpkXxPakCXZNBJrW5SiOFKZ9q4b1QsyNgrrZzReU7mZ2IIHY2iIKBEgwU5/ohnDSgsCGKoLJmbFAQYeq6koRRiZyoSIBXE8FyRqUGATTIqEOIGXF1ymnVGqhW0reiRUtrIhCRj+dyMMCVzYjImmFIhk5rQ/CWEI4XKvSt5Hsom6z7rtOYd+11ItHKkHIewLHOZ+O5PnqxWvHYArRdPlDjutuFZOUmWo4mfBQ9tn4SAlGxiZMm4EMNDRtF2d6SXkeu/o6IfZUpLrHIHMUArOvDLroM/CM0pBx3N2ofu1HES67D3JM7tUG6zXXfeqKXnMRfgpMtpX/vXTkPbBlhbamVD1z9dTPlnTDUkRiEzytBGCyIVBc+kka2ShKxdVnlen3umDlfsmHEiU7GUVEa62tsJfdqZ02tSEM/mrK29g/0J0RhGQEEu0+zmUlsvHHQZxDDhkieb6SR0JPRxEliypslsgpMHRO5ZjaH0MZ1+fFjKr1QfOKRz0GXlMm3kL69xXzvr/G7nkC+vWJTc/qGid5o4LsRdfKum3oDMY6k9v26s95lc2wyj2xzdUpviQGlXd4/X0eXtDQjgBoTF6fkFBK9iwl5l6tzOAn3xXXlvDGCE33fK0aublDlK5X1gco6F2cx8IUxg2hddbNG6Cc0FZDzPeAZNs0BLjyZvW14OVypLJpUWFzlbYIm5pQMm/d0DH+46t3yMQBxnuKZ6eJtvMK/Ie23OH0bySV6XYjv291H487mDu393svh3+AfPw385ZfCCjPBD9CqgnD0wwG7HwbPAHe9Nffv9/gEELLrnpdAp5xh84RcXXwIl7Zl63/q1BnJUqwpXvDdgsqKxYvUNvbz2Xu7+4XluQ6oeMBzbelss/+XijqY0Tbgp2rbfH0JvZvR3SdjNbZ23bfsbYd/4mQ== sidebar_class_name: "post api-method" info_path: docs/user-service/apis/shiksha-platform custom_edit_url: null @@ -47,7 +47,7 @@ Create Cohort Member </Heading> <ParamsDetails - parameters={[{"name":"deviceid","in":"header","schema":{"type":"string"}},{"name":"academicyearid","in":"header","schema":{"type":"string"}},{"name":"tenantid","in":"header","schema":{"type":"string"}}]} + parameters={[{"name":"userId","required":true,"in":"query","schema":{"type":"string"}},{"name":"deviceid","in":"header","schema":{"type":"string"}},{"name":"academicyearid","in":"header","schema":{"type":"string"}},{"name":"tenantid","in":"header","schema":{"type":"string"}}]} > </ParamsDetails> diff --git a/docs/user-service/apis/cohort-members-controller-update-cohort-members.api.mdx b/docs/user-service/apis/cohort-members-controller-update-cohort-members.api.mdx index 9e7e43d..b44112d 100644 --- a/docs/user-service/apis/cohort-members-controller-update-cohort-members.api.mdx +++ b/docs/user-service/apis/cohort-members-controller-update-cohort-members.api.mdx @@ -5,7 +5,7 @@ description: "Update Cohort Member" sidebar_label: "Update Cohort Member" hide_title: true hide_table_of_contents: true -api: eJyNVk2P2zgM/SsCT1vAbWYWPfk2k9kFBsWig+nMXoKgYGwmVse2XElO6zX03xeU/BknbS6BI5FP5CP5pBZURRqtVOVjCjGsVaa0/YeKHWmzVqXVKs9Jf62rFC3NdiGCCjUWZPlPvGmhxIIghsRbFcEqk5VMIQJN32upKYXY6poikCXEUKHNIAKTZFQgxC3YpmIEY7UsD+DcNjiSsfcqbdjiFCdRpaXS8hZWVS4Tn8vqm1Elry2g1e4bJZZj15y5lWR4N8TMFJwGEUFKJtGyYlyI4SUj0VsLtRd2+C+6lMFFUBvS16IF28tYxqKtzTksKusC4g1gYuWRgFkdPlOtKlVzpqiTTB4phe250wP65dMTTWgpvW+upKY3/wU3vpeuRhzMf8fQM2FX9d+DdlknGZYHEjp4cra1sar4W1Keesbnnndaow9j7c3EPthFgHn+ee9n4Ndt5h2u6QsfgXhMOaYj5jVd6+KNDTg3HbnNcHCPto3ASptT7/evd/vssR6sArc9RRgmZGjuoTOnTTIt70lhTtidhDDTlVfv74NwIQhTqdIEAv+8uV2WJbiL4C8yNGJHVPaNI0ydJGTMvs7z5gMT+vHmZglyj6notCbYfFzaPKBFUSor9qouU0+yxQOL3zwGzs1QUmtpG98V6CN4b9UblRBvtm4xiiFrMYeJoCCbKRbmyo+yF8wYVlyB1fF2NZXaVch31S7113EpSB+DUE+C+8LyGJidhzg0G1byEzXQCXZGmPq4Oqm/q22mtPzPi67ng4X3eZTsv35iUeU0l9ixg3uZHFd6sRs1bSJAE8dRQ059exkY10+HepjC0aSbsfHm4YT3yhPRNemXTL6ZDMVTjnavdLEYwPXz64O4e3pkONImLN5+uIFwS2HCtxQjV8rYAj3LHY8Xqj/DH0pi6addVTlKr1i1znkvdMbGM8oB3PpTx0YYOIMI4jM39DaCTBnLEG27Q0OvOneOl7/XpJvQNkfUEnfMxqaFVBr+TiHeY25oEe1wM8Mfz52OvBMQnc+i77aymRQDInij5vyLwm1d1LcjRxMM1+HM9y8MNwItXgY8f8NoPb2+QAS77oFRqJRdNP7gVwv+CHEon5bvHr/WQo7locYD2wZIrizWXIXp8Lz54ek+JhfEPNP5HPVp86+LLri0bRhN5wb7sHXRYxjeYM3Eb51z/wOwvHcK +api: eJytVk1v4zYQ/SvCnFpAu06KPemWOC0QFMUG2aQXwyjG0tjiRiK1/PCuKui/F0Pq07KzPvRiyOTM48ybmUc2oCrSaIWSjxkksFa50vYvKnekzVpJq1VRkP7HVRlamu1CDBVqLMnyn2TTgMSSIIHUW5XBKheVyCAGTd+c0JRBYrWjGISEBCq0OcRg0pxKhKQBW1eMYKwW8gBtGw+gzpB+vAj0zZGu30XaBk8y9l5lNVucAqVKWpKWt7CqCpF6VlZfjZK8toBWu6+UWmZBM4dWkOHdkD2TeRpEDBmZVIuKcSGBl5yi3jpS+8gO/6OOPGjjPvGr0ILtZSxj0TpzDoukKyHZAKZWHAmY1uEz06pSjjNFnebiSBlsz50e0C+fnmpCS9l9fSU1vfk73PiuvBpxMP8ZQ8+EXdV/DtplneYoDxTp4MnZOmNV+YegIvOMzz3vtEYfxtqbRftgFwMWxee9n6b328w7XNMXPoLoMeOYjlg4utbFGxsewsmobIaDe7RtDFbYgnq/v73bZ4/1YBW021OEYULicaq7zpw2ybS8J4U5YXcSwkyhXr2/D6INQZhKSRMI/O3mdlmW4B4F/yhHE+2IZN84kXFpSsbsXVHUH5nQTzc3S5B7zKJOa4LNp6XNA1qMpLLRXjmZeZItHlhG5zFwboZSp4WtfVegj+CDVW8kIdls28UohqyjOUwMJdlcscRXfpS99Caw4gqsjrerqWivQr6rZqnkLZeC9DFI/iS4LyyPgdl5iEOzYSX+pBo6xc4JMx9Xp+93zuZKi3+96Ho+WHifR8n+/QeWVUFziR07uJfJcaUXu1HTJgI0cRw15NS3l4Fx/XSohykcTboZm9xhIOReeSK6Jv2SizeTY/RUoN0rXS4GcP38+hDdPT0yHGkTFm8/3kC4pTDlW4qRK2VsiZ7ljscL1Z/hDyWx9MOuqgKFVyynC94LnbHxjHIAt/7UsREGziCG5Mxdv40hV8YyRNPs0NCrLtqWl8MtzV2cCYO7guVgj4WhRXzDXQy/PHfK8WsE8fm436iePhD6AgCPxhG14JP+/1P7rpb19Mw+mjO8tNs27tueowmG63DmhxeGG4EWLxBOZhjhp9cXiGHXPWRKlbGLxu/8PMLvIQ7l0/Jd6tcaKFAeHB7YNkByB6Hjak+H9M0PafcxuYjmmc7ntU+bf/nRdtalaYIEtO1gH7YuegwiEayZ+G3btv8BDy6yxQ== sidebar_class_name: "put api-method" info_path: docs/user-service/apis/shiksha-platform custom_edit_url: null @@ -47,7 +47,7 @@ Update Cohort Member </Heading> <ParamsDetails - parameters={[{"name":"cohortmembershipid","required":true,"in":"path","schema":{"type":"string"}}]} + parameters={[{"name":"cohortmembershipid","required":true,"in":"path","schema":{"type":"string"}},{"name":"userId","required":true,"in":"query","schema":{"type":"string"}}]} > </ParamsDetails> diff --git a/docs/user-service/apis/tenant-controller-create-tenants.api.mdx b/docs/user-service/apis/tenant-controller-create-tenants.api.mdx index 42923b2..65d7ac3 100644 --- a/docs/user-service/apis/tenant-controller-create-tenants.api.mdx +++ b/docs/user-service/apis/tenant-controller-create-tenants.api.mdx @@ -5,7 +5,7 @@ description: "Create Tenants" sidebar_label: "Create Tenants" hide_title: true hide_table_of_contents: true -api: eJyFlE1v2zAMhv+KwdMGqEuz7eTb1m5AsGILmvYUBANjM7Fa2XIpum0W+L8PlPI5F5hvlshXr8hH3IJviVGsbyYl5HBHDTZy5Rth7xzx74IJhdJyAAMtMtYkxAHy+RYarAly6ALxpAQDTE+dZSohX6ELZMA2kMNTR7wBA6GoqEbItyCbVvOCsG3W0PeLlEpBvvpyoxFHJeGODBS+EWpEt7BtnS2i6dFD8I2uDaT98oEKUcesVxRLQXeT4X8NGCgpFGxb1TyUIYvBurfCzgnkAL2B0tdom/9rXMe47OdbGrGK4S235xrTFDdIZ79mrCc1rtOtzrNubJDMr7JdWGZjXPbu/vYmZJ4zLxVxxuRQqMyS/fAezN4MMqO2ywqdmTx0qz9t9DzVdGFArDg6QhTJuRavCTEjtL4JyfDHy/HQ967qKbHMZl1RUAirzrmN3vrz5adhznfPS1uW1ICecb6XhLIjvDVJ5RXz1oeIBkoFOYwU39HzeCQxcpSYV16JnxPpC/0pOraymSlp6RYYDV6If6RTILC1PygWUF1UhCUxmP1b+dJJ5dn+ifxG18rw7ZH+b69Yt46OtJ4QtmPvuHIgaYjFfB+16NXKykeLux7NKvsYKsymDmXluR6gd3V7f519mU7AgNYgLY4/XEJ6iljoU1T3WssamxO7g7qfKR/KJPQqo9bphXoDHTvdSy2Zx4miR48VyyikB6fGLAxU2sB8DtvtEgPds+t7XU6DRgdTaQMu3ckgeqTN6aB6RtdRfE4L/WGr0dro3uw7pjIp6yrNnos7NX7MHcwh1TowNv01uwMDy908q32pOYwvOibxRc824GNRIkxxbQsOm3WHa41Nmvr9BYvC7wQ= +api: eJxtVE1v2zAM/SsBTxugLsm2k29du2HBDiv6cQqCgbGYWK0suZScNgv83wdKSZzMycUIRT6+Jz5xB74hxmi8m2ko4JEcunjjXWRvLfGfkgkj5XAABQ0y1hSJAxTzHTisCQpoA/FMgwKm19YwaSgit6TAOCjgtSXegoJQVlQjFDuI20bKQmTj1tB1i1xJIX7zeisZ/wOV3kVyUY6waawpE+fxc/BOYgNov3ymMgphFoXRUJDTzHdAQIH2NRp38ShJDkPsLoGvGetZjWs6zUBmFMUm0lnlUbACTaFk04iKy10z9E9CfRmgv6F5lnWOeY6wUBBNtNSPOM31NnrouowWGu9CVvF5MpXPGcV93SgbQo9CW5YUwqq1dit8v06+DGt+eF4arcklxhHX4po9knA6z86cRr3ZaoqVF1s2PqRZYqyggLHYbbyZjmPKHGdKYjDiTXbmQv6ULZu4fRBrZF2YKF9F/0Knl46N+UVpXMKiItTEoA7evm5j5dn8TYZLOsR0971dv79j3Vjq7XWYUu+qPnI009A980PW4GL66lNTnJjFuJVPgvYzfqjMS6hwdGcxrjzXMLjq+6fb0fXdDBTIjeXg9NME8kvDUl6aaJWbr9GdiBtM6bKTI73HcWNFfqegZStneYDztC+k9RQU5CFK4zzGhYJKxl3MYbdbYqAntl0n4bxHZO1oE3BpxfsrtIEGHI7bAj7c75/Jx5H0usTthbanK2yDtpUkkK20QTbSSSzVqYM3hEKuusmNrh4FuK8drCjBOrr57vfDIyhY7ldd7bXUML7JAsU36a3AJzHJtim2A4tu3eJacjOm/P4BnC/55g== sidebar_class_name: "post api-method" info_path: docs/user-service/apis/shiksha-platform custom_edit_url: null @@ -47,14 +47,14 @@ Create Tenants </Heading> <ParamsDetails - parameters={[{"name":"userId","required":false,"in":"query","schema":{"type":"string"}}]} + parameters={[{"name":"userId","required":true,"in":"query","schema":{"type":"string"}}]} > </ParamsDetails> <RequestSchema title={"Body"} - body={{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Tenant name","default":""},"domain":{"type":"string","description":"Domain Name","default":""},"params":{"type":"object","description":"Params","default":""},"programImages":{"description":"List of program images (URLs or other related strings)","type":"array","items":{"type":"string"}}},"required":["name"],"title":"TenantCreateDto"}}}}} + body={{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"domain":{"type":"string"},"params":{"type":"object"},"programImages":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"programHead":{"type":"string"}},"required":["name","description","programHead"],"title":"TenantCreateDto"}}}}} > </RequestSchema> @@ -62,7 +62,7 @@ Create Tenants <StatusCodes id={undefined} label={undefined} - responses={{"201":{"description":"Tenant Created Successfully"},"403":{"description":"Forbidden"}}} + responses={{"201":{"description":"Tenant created successfully"},"403":{"description":"Forbidden"}}} > </StatusCodes> diff --git a/docs/user-service/apis/tenant-controller-delete-tenants.api.mdx b/docs/user-service/apis/tenant-controller-delete-tenants.api.mdx index a7fd1c2..bb1dabb 100644 --- a/docs/user-service/apis/tenant-controller-delete-tenants.api.mdx +++ b/docs/user-service/apis/tenant-controller-delete-tenants.api.mdx @@ -5,7 +5,7 @@ description: "Delete Tenants" sidebar_label: "Delete Tenants" hide_title: true hide_table_of_contents: true -api: eJxtUstu2zAQ/BVhTy3AVnbbk25B7ABBewjyOAVGsZbWJWGKVJYro67Afy+WSpw07ongPmdmZ4I4EKO4GK47aOCeAga5jEE4ek/8syNPQnM4gYEBGXsS4gTN4wQBe4IGXAcGmJ5Gx9RBIzySAReggaeR+AgGUmupR2gmkOOgLUnYhV+Q80Y70xBDoqT5L4ulPh2llt2gyE64qhUKVlckrYVs4Nvi63nlVeSt6zoKkLN5l1sVMtUrm57ERuU90yz8xEID9ZiI68OyllJbn/KJ+DCT3+inHdnJ8U7JzeixbSmlTxL3FN6wxcF9J9WhiGIJO2IwL/JdjGIjuz/lDgW3C7tY2p14rbizbp8sVjceZRe5h/fULm8fVtXFzTUYUHxzcPl5AQbaGARbgWbSyUNM0mPB9rz9TJV/Jp8oCP2WevDogmo/stfcLNcjqFy6egkGZsnKnCLaxoCNSbRsmraY6IF9zhqezaE+6lzCrVfv7NAnOsOgHCgINPDh9tlmHyvd9T9sezq+ePKAftQCUJsdkJ1u0ePlN8dfrX+s79eQ8193lghZ +api: eJytkk1v00AQhv+KNSeQFpwAJ9+qJpUiOFT9OFURmtiTepX1rjs7jjCW/zuadZKGBjhxsrzz+T7zDhBaYhQb/KqCAh7Io5fr4IWDc8TfK3IkND1HMNAiY0NCHKF4GsBjQ1CArcAA00tnmSoohDsyYD0U0KLUYCCWNTUIxQDSt1oRha1/hnE0pyZdJF79tdFLR9z/s9NaK2MbfKSo8U+zuX4qiiXbViWeBGYLFMxuSMoaRgNfZp8vM28Cb2xVkdclQfBZFR/qYW3eZC8Sp+wVVENSB0U6EUzopIYCctWZ7+e5pNz8FI/E+4nrWn/Kjq309yp30oNlSTF+kLAjf6YfW/uVlEzCVBNWxGCOUK86qQPbn+nESYn125DKrTjNuK/tLtaY3TqUbeAG3kq7vntcZFe3KzCg+02P848zMFAGL1gKFIN2bkOUBtNuh+kXVH7rfJIg9EPy1qH1eo2OncYmXE/JFjp6DgYmZKlPgrY2UIcomjYMG4z0yG4c9Xmyi1q0shE3Tt20RRfpYgfVQF6ggHd3B+O9z3TWn3bbUX/u1D26TpNAzbdHtjrp/089Xtr35zOP29gKxvV45rjF8tvyYQnj+AsZc01C sidebar_class_name: "delete api-method" info_path: docs/user-service/apis/shiksha-platform custom_edit_url: null @@ -47,7 +47,7 @@ Delete Tenants </Heading> <ParamsDetails - parameters={[{"name":"id","required":true,"in":"query","schema":{"type":"string"}}]} + parameters={[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"userId","required":true,"in":"query","schema":{"type":"string"}}]} > </ParamsDetails> diff --git a/docs/user-service/apis/tenant-controller-get-tenants.api.mdx b/docs/user-service/apis/tenant-controller-get-tenants.api.mdx index 85503e7..046c6b9 100644 --- a/docs/user-service/apis/tenant-controller-get-tenants.api.mdx +++ b/docs/user-service/apis/tenant-controller-get-tenants.api.mdx @@ -5,7 +5,7 @@ description: "Get Tenants" sidebar_label: "Get Tenants" hide_title: true hide_table_of_contents: true -api: eJxlkU9P5DAMxb9K9c5hO7PsqTcEC0Jc0AKn0WjlaQ2JaJPiuKMdqn535HY1/DtFsV+ef34ZkXoW0pDidYMK9xwp6nmKKqltWf4+sS61DIeehDpWloxqs3UQzn2KmTOqET9XazsazrWE3hyPfsUFKRWXrLXH5PBrdfpdeZlkF5qGI6bJfeldsRbvFB2rTwb7xDpDqUeFcsgs5X5d6iwshamBQ2bZH3kz14MEPdzVnruFmuqacz7R9MzR7nroGRWoDzd8gEOw+Z6pYYFDpM66Z4P6JOF1zm3mDfExzc+Dtqa48+E5eypuW9LHJB2+rnT+5+GiOLu9hoPxLcX1jxUc6hSVakU1mnOfsnY0s/2f/jmNT7ZHfuV/WvYthWiBD9Jab0lqA0vK5q7hsKQF+0tqsHXwKauJxnFHmR+knSYrvwwshyXFPUmgna252U4fvuPq9z2m6Q105sis +api: eJxlUUtv00AQ/ivWd97iBDj5VhWoql4q2p6iCE3sSXZVe9fMjiOM5f+Oxq4CLafVzuN7zYTUs5CGFO8aVHjiSFFvUlRJbcvy48S61jIcehLqWFkyqt3eQTj3KWbOqCZ83GztaTjXEnpDvOAVmUlqX+Shrjnn49C2I2aHz5tP/698S3IITcMR8+ygdDKyVyDs3bvpW9bir8CO1SfzcWJd9KpHhXLILOV5W+oyWApTA4fMcr5YyVwPEnR8rD13qyFaxF5peuFofx17RgXqwz2PcAjG75kaFjhE6qx7PahPEn4vkS4OQjymZT1oaxOPPrxkT8VDS3pM0uG9pZvvz1+K64c7OJi+tbj9sIFDnaJSragmQ+5T1o4Wba/sb9N4A3vRr/xLy76lEO0Eg7TWW5PawZIy3i0c1rRgZ6bGkvcpqw1N04EyP0s7z1b+ObCMa4pnkkAHs7nbz/+c4/brE+b5Dw4e0qI= sidebar_class_name: "get api-method" info_path: docs/user-service/apis/shiksha-platform custom_edit_url: null @@ -62,7 +62,7 @@ Get Tenants <StatusCodes id={undefined} label={undefined} - responses={{"201":{"description":"Tenant Data Fetch"},"403":{"description":"Forbidden"}}} + responses={{"201":{"description":"Tenant search successfully"},"403":{"description":"Forbidden"}}} > </StatusCodes> diff --git a/docs/user-service/apis/tenant-controller-search-tenants.api.mdx b/docs/user-service/apis/tenant-controller-search-tenants.api.mdx new file mode 100644 index 0000000..618c57c --- /dev/null +++ b/docs/user-service/apis/tenant-controller-search-tenants.api.mdx @@ -0,0 +1,71 @@ +--- +id: tenant-controller-search-tenants +title: "TenantController_searchTenants" +description: "TenantController_searchTenants" +sidebar_label: "TenantController_searchTenants" +hide_title: true +hide_table_of_contents: true +api: eJydlUtv20YQgP8KMacW2FRU2hNvid2gQgLYiOyTIAQjcihuvA9mH65Vgf+9mF1apC2lCaqDRM3OzM7jm+ERbE8Og7Rm1UAFd2TQhCtrgrNKkfviCV3dZbEHAT061BTIeag2WwGOvkXy4b1tDlAd01/pqIEquEgCamsCmcBH2PdK1umqxVdvDct83ZFGfgqHnqACu/tKdeB7HAcWJHk+VVLLMFMzUe/IgYCGfO1kz06hgk9JTYCWRuqooVoK0PiUn9+WJeu3GFWAalkOAmzbevoJvzdZb+a4/K5j9ttKlSv0o7xCqitX/qTpg5NmfxZC7kCxagodfSh2VGDxy/396vpXGAQY1HTuYxDQWI3SXDzyAUOcx4jO4eHs4nVSK2xbhI6KHDDM8t1AH3dK+o4a2AqQgbS/lA4ZrtVcW0DjsGVnjJh8ZAfDIKB2hIGa94efqEpHxer6ObhkaN2sLrFv/p+rbDh31Tu7d6j/IrzQLQ47yKDo1KkPIwJ8Mg3FZiT5hN72td06zdv13Q0MQ7b1vTU+4/K2XPLPRTLyoBY+1jV530alDhz2H+Xv5yYfrNvJpiGTA8c9D/PoiEO6dMF/7ARNobO8PXrrE+MYOqhgET25xeNykaFZZDMQ4Mk9nhaIpzo6GQ5rXgU5TUwpvAn2geboYi8/EgPKQENH2KRRzezDuxg66+Q/acGkvHjJfJ7W059PqHtFs3WyLKcVUL6c2tNcTriM90z4jKM1SZ4n6tVIzHiedGdkTsIXjM3Zkqa1Ka6RlXUnH3yHxa3C0Fqnz2i++nx/Xby7XYEALnUWLn8rIa9krHnrsWdumcZU5jHBkaep389oTQ1/cdepP4GewqJXXBQePaf4LLOwAWaBg1mCgNMSGYnYCuiYnGoDx+MOPd07NQws/hbJHTInj+gk7jj7zXYQz+2vNkd4IC7iVX7TvLnjYFhdxQzNq7fOsJ0Be3uzvgMBu/HtpW3DNg7/BpG+K+BRTYkmLpLsCArNPuKedbNP/vwLeo59Lg== +sidebar_class_name: "post api-method" +info_path: docs/user-service/apis/shiksha-platform +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={"TenantController_searchTenants"} +> +</Heading> + +<MethodEndpoint + method={"post"} + path={"/user/v1/tenant/search"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +TenantController_searchTenants + +<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":{"limit":{"type":"number","description":"Limit","minimum":1,"maximum":200,"default":10},"offset":{"type":"number","description":"Offset","minimum":0,"maximum":200,"default":0},"filters":{"type":"object","properties":{"tenantId":{"type":"string","description":"Tenant Id must be a (UUID)"},"name":{"type":"string"},"domain":{"type":"string"},"status":{"type":"array","description":"Status of the tenant","default":["published"],"items":{"type":"string","enum":["published","draft","archived"]}},"createdBy":{"type":"string","description":"The ID of the creator (UUID)"},"updatedBy":{"type":"string","description":"The ID of the updater (UUID)"},"programHead":{"type":"string"}},"title":"TenantFilters"}},"required":["limit","offset"],"title":"TenantSearchDTO"}}}}} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"201":{"description":"Tenant search successfully"},"403":{"description":"Forbidden"}}} +> + +</StatusCodes> + + + \ No newline at end of file diff --git a/docs/user-service/apis/tenant-controller-update-tenants.api.mdx b/docs/user-service/apis/tenant-controller-update-tenants.api.mdx index e092a6b..8a07ee0 100644 --- a/docs/user-service/apis/tenant-controller-update-tenants.api.mdx +++ b/docs/user-service/apis/tenant-controller-update-tenants.api.mdx @@ -5,7 +5,7 @@ description: "Update Tenants" sidebar_label: "Update Tenants" hide_title: true hide_table_of_contents: true -api: eJyNVE1v2zAM/SsGTxugLs22k29dsmLBgCHox6kICsZmYrW25Ep02izwfx8oJU4ae9h8sc2Pp0fxkTuwNTlkbc0shxTuyKDhiTXsbFmSe2zqHJmi2YOCGh1WxOQ8pA87MFgRpKBzUODopdGOckjZNaRAG0jhpSG3BQU+K6hCSHfA21pSPDtt1tC2qkNpPLnZe6QVlv7/oRYxlTx/s/lWIs45ZdYwGRYX1nWps1D66MlbI7YetF0+UcZSt5OLYk1evJHwOQEFOfnM6Vowu8tMQrD4VtiUDClAqyC3FWrzb4xpiEt+DWGEXvghtu8x5jGul+7s2mE1q3BNfuA6z2AG/J6Rm4HUcwK3IS6xq4QLSjhcCygg01SQPgBmrDdSnjbdJ7qskK/FKeu9t20VsOaSuju+DyqdsoW2Fa8jX1vjY1mfL8fyGuzNFBmTa+KskHq+Xn7pR15bt9R5Tiac+94Xz02O41ERF1YGqUbBlB5xASmMRNujzXgUix/FsRIxk9vEYVrIT9Y4zdtbkWEkj1lG3l+wfabTHmCtf9IW9pNREObkQB0G6arhwjr9O4g70BaB3xxH4/sbVnVJRymfdG4vzKOlk1lfM39reGc+KKRrnTBe2VDJvoO3hX72BSbzEnllXdUDm9zcT5Or+QwUyFVF4/jTJcRxxkzGWYqsrecKzUlVvf4MK5rpjUd1KXW3ChpXii927iFsJTl6DAo66e77t1BQWM8Sttst0dO9K9tWzHFZyYrMtcdlebLMzjh0Kwk+3Oy31cdEzhri9kzbw7rdYNlQHOWBQ2Jgt1GPwQv5cVqiRXStOqhHuMasSWR0cScMjrm9hSlYneDnV3eTH6Bgud+8lc0lyeGrLHR8lcMV2FB2UHaw7aBEs25wLbERVJ4/QGg+ng== +api: eJytVUtv2kAQ/ivWnFrJqUPbk28JaRTUS5THCaFq8A54E3vX2R2TUOT/Xs0uGCemPZULYufxzeP7hh3YhhyytmamIIcHMmh4ag07W1XkfrWNQqb47CGFBh3WxOQ85PMdGKwJctAKUnD00mpHCnJ2LaWgDeTQIJeQgi9KqhHyHfC2kQjPTps1dF3aJ2k9udlfE7205Lb/zLSIkeT50qqteHxMVFjDZFhM2DSVLkLj2ZO3Rt5Gqe3yiQqWrp2MiTV5scZ6RwWkoGyN2pw0hbn5ce4uJF87rGc1rmnogc6hdKyZ3kUeRweKfOF0I12cRPWM3J6I/RAJ98EvsauES0o4bBtSINPWkM+haZeV9iXJcpTDldjQFaXekIKFJFthW7Gsu/fsUigcIZO63J6eSGz7hlCdbo41V9Rz8jEQ8YotdJ1YHfnGGh8n9vV8Il/vm4pxyRUyJtfERSmo38+/jT2vrVtqpchEXFwLuffxsb+hd6wkOWqiJi6timQvyiASLiGHTBidbSZZHGgWtZTttOqEyOQ2UUYL+VG0TvP2XigYe8KiIO/P2D7TcLnY6J8UaCG1lISKHKQHDV20XFqnfwdih26E3HdHWfx4w7qp6EjjASX27D2+9KQds3R+8BqNp48+kO8dfQacGOAMqTCgiDYrG1rfM+G+1M++xOS2Ql5ZV494PL17vEoubmeQgsw2Pk6+nEPUPhaifZlKYz3XaAZjGG31tLaY3jhrKhlUl0LrKrHFfc/DBRPoCaTQiyhuHVLIdRBLaT2L8263RE+Pruo6eY73TW6q0h6XlVytFVaeRpX0Vww+3e0P3OdEEE9V+Ezb4WndYNWKE8i13KDTgvT/UQ9cNdsh5qEaraBbdOmBvIIeDdOIcfYg4cfA0a2W4nvR3V48TG8gheX+6NdWSZDDV/krwdeIbEMjQVjhbQcVmnWLa/GNSeXzB1pLaQE= sidebar_class_name: "patch api-method" info_path: docs/user-service/apis/shiksha-platform custom_edit_url: null @@ -28,7 +28,7 @@ import Heading from "@theme/Heading"; <MethodEndpoint method={"patch"} - path={"/user/v1/tenant/update"} + path={"/user/v1/tenant/update/{id}"} context={"endpoint"} > @@ -47,14 +47,14 @@ Update Tenants </Heading> <ParamsDetails - parameters={[{"name":"id","required":true,"in":"query","schema":{"type":"string"}},{"name":"userId","required":false,"in":"query","schema":{"type":"string"}}]} + parameters={[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"userId","required":true,"in":"query","schema":{"type":"string"}}]} > </ParamsDetails> <RequestSchema title={"Body"} - body={{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Tenant name","default":""},"domain":{"type":"string","description":"Domain Name","default":""},"params":{"type":"object","description":"Params","default":""},"programImages":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","description":"Status of the tenant","enum":["active","inactive","archive"],"default":"active"}},"title":"TenantUpdateDto"}}}}} + body={{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"domain":{"type":"string"},"params":{"type":"object"},"programImages":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"status":{"type":"string","description":"Status of the tenant","enum":["published","draft","archived"],"default":"published"},"createdBy":{"type":"string"},"programHead":{"type":"string"}},"title":"TenantUpdateDto"}}}}} > </RequestSchema> diff --git a/docs/user-service/apis/user-controller-check-user.api.mdx b/docs/user-service/apis/user-controller-check-user.api.mdx new file mode 100644 index 0000000..9f11379 --- /dev/null +++ b/docs/user-service/apis/user-controller-check-user.api.mdx @@ -0,0 +1,71 @@ +--- +id: user-controller-check-user +title: "Check User" +description: "Check User" +sidebar_label: "Check User" +hide_title: true +hide_table_of_contents: true +api: eJxlkUFvwjAMhf8KeudsrDv2htgF7TA0xgmhKQSzRLRN57horOp/n5wiNLZTFDt+7/NLj9gSWwmxWexRYp2I57ERjlVF/O48uaPWYNBatjUJcUK52RowpTY2iRLKHo8PhR57So5Dq3IogWEwEPuhA1kZW/PnyVwNJheHmsRHpWhjkuwoHiWmXSKenopppoFBIj5dMRK5joOcV85TPcJY5yilO4lHavQu55ZQwrbhmc4wCOrsye6za2Nr7c468ZHDd84ik4fmEPN4kEpfrHw4Jm8ny8rKIXKNf8u8rp8ms+UCBso3Fov7Bxi42Ih1grJXZd2vtpnt4n6Tw43qFV/oS6ZtZUODwaDjSntjRBt04+SpUK8c09bAa4zlBn2/s4nWXA2Dlj874vMY3slysDvdbrMdfn3A8mX1hmH4AV0cthg= +sidebar_class_name: "post api-method" +info_path: docs/user-service/apis/shiksha-platform +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={"Check User"} +> +</Heading> + +<MethodEndpoint + method={"post"} + path={"/user/v1/check"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Check User + +<Heading + id={"request"} + as={"h2"} + className={"openapi-tabs__heading"} + children={"Request"} +> +</Heading> + +<ParamsDetails + parameters={[]} +> + +</ParamsDetails> + +<RequestSchema + title={"Body"} + body={undefined} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"201":{"description":""}}} +> + +</StatusCodes> + + + \ No newline at end of file diff --git a/docs/user-service/apis/user-controller-create-user.api.mdx b/docs/user-service/apis/user-controller-create-user.api.mdx index 9828556..c67a872 100644 --- a/docs/user-service/apis/user-controller-create-user.api.mdx +++ b/docs/user-service/apis/user-controller-create-user.api.mdx @@ -5,7 +5,7 @@ description: "Create User" sidebar_label: "Create User" hide_title: true hide_table_of_contents: true -api: eJzlWW1v3DYS/iuCPnsavovcT5cmLS64HBrE6QEHIzCG5NCrRittJa0T1/B/P1C769XuOo3RKw4H1B8WFjnzcGY4z5Aa3Zfdmnoc6659E8tF+fNA/auuHfuuaai/Dj3hSHmwvCjX2OOKRuqHcnF1X7a4onJRYsBIqzrcEfZ1LC/Kui0X5ZIwTkqRhtDX67xAuShf7oSLLF3UkdqxTvUkOIQlrbBc3Jfj3ToDD2Nftzflw8PHi7KnXzc0jN938S5L5Me6p1guxn5Dp4uUF2Xo2pHaMcviet3UYfLwxS9DFrg/X6vzv1AYs499jsdY05BnNwP1WzfPrLoovzoRO38+fmrkhyUVEUcqulR8X/fjMv8zLqnIa2aUVefr5okFngLK7mIYi3az8tSfItEK6+Z5QJPoqf4ah+Fz18fnQeylT1FinZXC+MzQ7KRPUYYRx2cGZRI91ccYexqG5yHshM/iUbehi8+0Yid8ijFSi+34qlt2/fi+a+ifuF5niMX9CcbbepiCkBULHEdqI7aBikgj1s1QXuxtwL7Hu0y/kVbDt1N7a8Cb52zqJFm8idnuMFn8Jg7nlm4TMU8X9fHuZ8SEm2YsF1cfv2nwI+8vyr5r6Dkm5gJV5DButR6rw9XBzbxuPWZC7cZmUX89dpNi2Axjt/qxpuZr/qU89y9sNjQUP+0D+8c2YIJ6jnOTPbvw3+aln6syCQ9nIdkvvEebRebHg3s/TVjbyJwAPFbFXQ2cVYivJ/ZslemMmQ6WCf6ipC+4Wjf7vMTV2+3hkQv1ZrXC/q5clFuF4gPhqnj79OHy+vBUpK4vPi+pLbAtaLUe7wrfxbuiHnJGHnxfPB5jly0tsSne4Vg35cWs8pdj43uhnK2Mnru6KPdDX+Xy1ZxmJSXnnHIeqiQRFOoElhkEMhUZK0naJMsjhl2V2qOLDitgIjlQJgZApgKYKkSbtEIpeQ7tniili9FJYRNwHypQSiVwhiQETTwiSs0VlvlEPc71q1k+lkYZFyQGsEEZUC5WYLVAYCw5bV0lq6APEbwqv39ffny4mCN4wymmYEBWtgLFKgfWRAmyEkb4JCQ6miO8e/nhFEIhemORwEorQElEQKURyHkhneTO6uoI4vIUAY3wQXgHwXICZWQA5FID+koIMkTI3AGhlKI81tfCW9Qpgk/agBKWgQ3BAmcBsYoerZ+FoVxhLj/HPqTAnA0aPAUNClO2QEdgTlqmPdOczy3IqX/dbHP7BChGrpivwHnvQXGpwEXlgWwISmjhiPsZkGBClQ8fHy5217CJWPt72r8J+wl0KgzDuIm7i9IZ1y53c6c8+zs1TbenUoHDVOhveqJxW4vOqNVterwthOg6PKbWEPbUUvvZ/y2/hFIVIgugOOeggnfgVOTgrLOUjKs0HvNLORmYIgHoogdVJQFeMgWayYhS26iT+ovwq8KI0fkKWEgCFCoLPhgG2qBlMTDB2RHCQKFr43VY5vvLNTabVVufYorEqoBowHBvQaFBcCIpcMpr7Qwqa9Qs0bk9IUqmumZRga1QgIqBg4tkwGrteNCWJx1m+omeYK1wXFmuAghkCZQSAjAlC8ZH6ZmLkhk396tub7vmluJ13V7HbkXDWIfrz13/6dS5JBMGFiT4YD0oYRhYrw1ww2yKkgchZwErL5f4qW5OjHOoMBrGgQnpQZkqgfeewEfk1upkq3AUdHu270lZXXEP1qYISnoHGLwExzFFrBzjGI52LSy7rrkOTTdserqOG7oeu+vQ3dbxzL+kKmFUBSYoBkqQAS8Ygxgq5YXi5PhRXm/aFfZ9TWdAEbVTXhAEo3LddAYwcQ2GRBRK2yo4PLJxhf24XnYtnSFx7qITCRL6ClSoIlhZ5bgr5jVFIeM8H9ru22XTam5slcuwEAQKhQAvqgTGG5NQMuUpTKU1YaibesSxe/oq8+Ns/s8psfy4uqZDeWVPV9bdm2E5TOrX6x7HJa7+dpOHvwvd6v+s+EofiTFhwTjGQOUfF5kGIm+YtUpWuSD8JYqvrrxmXFkQXltQmjQ4LyowyKqgJa8Ct/PLDTupI1jxFKVjkKKpQOkgAT0nMM4pb6MzFYrfv9wEr1gVOYfE8+VGqACYa6WqtEYeFHoxv9zM2fDncawh7NuvvCq83c39t9x6TR7bX7A9JlfTf+OtYM+tuFP/I6wywXrLGYIxQYBKLIINLEBgQiuuUSmej8NHgjAmnGMOwVQqnw6MwHl0EFTloqikj+avQhAZhaSkKpDMS1CJFFgpAyiRKu5JVGTmV2Zqb5p6WJ6etsw6SfmixwKCSskDssqCJCYM4yZ5Pc9xwU/0rbWIhifgSRpQnlnw0nCwVrGgBJeK2TOWPePe/rB7Jx/WXTts35sF4+cti6kvsu3hxmLYhEDDkDZNc5ffuhWTX9HApieMdwV9qYfxuyyrGTuXfdOOmQ5NcUn9LfXFD32fyZ27W3gzVfipcfzxlIA7fu66yisal132a90NU5cEx2W5KF9krr245S+25ucG8bTKsO0hDRQ2fT3eXeZOLu0Cld2DsftE7axFguv6H3R31pfe0fjlZlx2ff3b1B+ebM894veHdvMP297EcTf40Hc5fZ56v4fHfRP3MPJ45O4HZqXjgPLYKz2M7Tqfh4HHVuYMa9+ZPAw9s9I8yh+d0LvR+Rm87879fhF5hNun9qPaQ96I1E0btOsHXS7rT8MSi3cNjqnrV2cV+9X7n18XL9+9yXjUD9tB/h3bNfpxairnvcsptMJ2VryPc+0I9jFDRvoyvlg3WLc51Tf91CvfpuG22ZXXzXerXSp+vCiXOVcXV+X9vceBfu6bh4c8/OuG8gmUE/QW+xp99u/qQOgpSrEe8kQsFwmb4fTrxf3h28XvfS150vRPdPfUB5n9HkzFaSvzarsGfMgwB4mzbyV5mx8J+u6nyw/lRel3H2FW20zr8XM+gvDz9stLN/kxEXIauy8bbG82eJNlt5j57z8jNWVi +api: eJzlWW2P2zYS/iuCPu80fBfpT5cmLS64HBpk0wMOi2AxJIdrNbLkSvIm28X+9wNley3bm2bRKw4HNB8WMTnzcGY4z5Aa3pfdmnoc6659E8tF+fNA/auuHfuuaai/Dj3hSHmwvCjX2OOKRuqHcnF1X7a4onJRYsBIqzrcEfZ1LC/Kui0X5ZIwTkqRhtDX67xAuShf7oSLLF3UkdqxTvUkOIQlrbBc3Jfj3ToDD2Nftzflw8PHi7KnXzc0jN938S5L5J91T7FcjP2GThcpL8rQtSO1Y5bF9bqpw+Thi1+GLHB/vlbnf6EwZh/7HI+xpiHPbgbqt26eWXVRfnUidv58/NTID0sqIo5UdKn4vu7HZf7PuKQir5lRVp2vmycWeAoou4thLNrNylN/ikQrrJvnAU2ip/prHIbPXR+fB7GXPkWJdVYK4zNDs5M+RRlGHJ8ZlEn0VB9j7GkYnoewEz6LR92GLj7Tip3wKcZILbbjq27Z9eP7rqF/4nqdIRb3Jxhv62EKQlYscBypjdgGKiKNWDdDebG3Afse7zL9RloN307trQFvnrOpk2TxJma7w2TxmzicW7pNxDxd1Me7nxETbpqxXFx9/KbBj7y/KPuuoeeYmAtUkcO41XqsDlcHN/O69ZgJtRubRf312E2KYTOM3erHmpqv+Zfy3L+w2dBQ/LQP7B/bgAnqOc5N9uzCf5uXfq7KJDychWS/8B5tFpkfD+79NGFtI3MC8FgVdzVwViG+ntizVaYzZjpYJviLkr7gat3s8xJXb7eHRy7Um9UK+7tyUW4Vig+Eq+Lt04fL68OvInV98XlJbYFtQav1eFf4Lt4V9ZAz8uD74vEYu2xpiU3xDse6KS9mlb8cG98L5Wxl9NzVRbkf+iqXr+Y0Kyk555TzUCWJoFAnsMwgkKnIWEnSJlkeMeyq1B5ddFgBE8mBMjEAMhXAVCHapBVKyXNo90QpXYxOCpuA+1CBUiqBMyQhaOIRUWqusMwn6nGuX83ysTTKuCAxgA3KgHKxAqsFAmPJaesqWQV9iOBV+f378uPDxRzBG04xBQOyshUoVjmwJkqQlTDCJyHR0Rzh3csPpxAK0RuLBFZaAUoiAiqNQM4L6SR3VldHEJenCGiED8I7CJYTKCMDIJca0FdCkCFC5g4IpRTlsb4W3qJOEXzSBpSwDGwIFjgLiFX0aP0sDOUKc/k59iEF5mzQ4CloUJiyBToCc9Iy7ZnmfG5BTv3rZpvbJ0AxcsV8Bc57D4pLBS4qD2RDUEILR9zPgAQTqnz4+HCxu4ZNxNrf0/5N2E+gU2EYxk3cXZTOuHa5mzvl2d+pabo9lQocpkJ/0xON21p0Rq1u0+NtIUTX4TG1hrCnltrP/m/5JZSqEFkAxTkHFbwDpyIHZ52lZFyl8ZhfysnAFAlAFz2oKgnwkinQTEaU2kad1F+EXxVGjM5XwEISoFBZ8MEw0AYti4EJzo4QBgpdG6/DMt9frrHZrNr6FFMkVgVEA4Z7CwoNghNJgVNea2dQWaNmic7tCVEy1TWLCmyFAlQMHFwkA1Zrx4O2POkw00/0BGuF48pyFUAgS6CUEIApWTA+Ss9clMy4uV91e9s1txSv6/Y6disaxjpcf+76T6fOJZkwsCDBB+tBCcPAem2AG2ZTlDwIOQtYebnET3VzYpxDhdEwDkxID8pUCbz3BD4it1YnW4WjoNuzfU/K6op7sDZFUNI7wOAlOI4pYuUYx3C0a2HZdc11aLph09N13ND12F2H7raOZ/4lVQmjKjBBMVCCDHjBGMRQKS8UJ8eP8nrTrrDvazoDiqid8oIgGJXrpjOAiWswJKJQ2lbB4ZGNK+zH9bJr6QyJcxedSJDQV6BCFcHKKsddMa8pChnn+dB23y6bVnNjq1yGhSBQKAR4USUw3piEkilPYSqtCUPd1COO3dNXmR9n839OieXH1TUdyit7urLuvgzLYVK/Xvc4LnH1t5s8/F3oVv9nxVf6SIwJC8YxBir/cZFpIPKGWatklQvCX6L46sprxpUF4bUFpUmD86ICg6wKWvIqcDu/3LCTOoIVT1E6BimaCpQOEtBzAuOc8jY6U6H4/ctN8IpVkXNIPF9uhAqAuVaqSmvkQaEX88vNnA1/Hscawr79yqfC293cf8ut1+Sx/QXbY3I1/Te+Cvbcijv1P8IqE6y3nCEYEwSoxCLYwAIEJrTiGpXi+Th8JAhjwjnmEEyl8unACJxHB0FVLopK+mj+KgSRUUhKqgLJvASVSIGVMoASqeKeREVmfmWm9qaph+Xpacusk5QveiwgqJQ8IKssSGLCMG6S1/McF/xE31qLaHgCnqQB5ZkFLw0HaxULSnCpmD1j2TPu7Q+7b/Jh3bXD9rtZMH7espj6ItsebiyGTQg0DGnTNHf5q1sx+RUNbHrCeFfQl3oYv9vKunPZ15ttZ3VqZOIkpxk7l3vTjpk2TXFJ/S31xQ99n4tA7oLhzXQSTA3mj6dE3fF4131e0bjssv/rbpi6KTguy0X5InPyxS1/sXUzN5KnVYZtr2mgsOnr8e4yd3xpF9AcBhi7T9TOWim4rv9Bd2f96x3dX27GZdfXv0195Mn23Et+f2hL/7DtYRx3jQ/9mdPfU4/48HPf7D2MPB7N+4FZiTmgPPZUD2O7Dulh4LHlOcPadzAPQ8+sSI/yRyf5bnR+Vu+7eL9fbB7h9hR4VHvIG5G6aYN2faPLZf1pWGLxrsExdf3qrLK/ev/z6+LluzcZj/phO8i/Y7sHAZyaz3nvcgqtsJ0V+eNcO4J9zJCRvowv1g3WbU71TT/11LdpuG2K5XXzHWyXih8vymXO1cVVeX/vcaCf++bhIQ//uqF8UuUEvcW+Rp/9uzoQf4pSrIc8EctFwmY4feW4P7xx/N6rypOmf6K7px5u9nswFbGtzKvtGvAhwxwkzt5U8jY/EvTdT5cfyovS7x5rVttM6/FzPqrw8/aFppv8mAg5jd2XDbY3G7zJslvM/O8/PdVyig== sidebar_class_name: "post api-method" info_path: docs/user-service/apis/shiksha-platform custom_edit_url: null @@ -62,7 +62,7 @@ Create User <StatusCodes id={undefined} label={undefined} - responses={{"201":{"description":"User created successfully"},"403":{"description":"User already exist."},"500":{"description":"Internal Server Error"}}} + responses={{"201":{"description":"User created successfully"},"403":{"description":"User already exist."},"409":{"description":"Duplicate data."},"500":{"description":"Internal Server Error"}}} > </StatusCodes> diff --git a/docs/user-service/apis/user-controller-search-user.api.mdx b/docs/user-service/apis/user-controller-search-user.api.mdx index 3adb5f0..025e6c2 100644 --- a/docs/user-service/apis/user-controller-search-user.api.mdx +++ b/docs/user-service/apis/user-controller-search-user.api.mdx @@ -5,7 +5,7 @@ description: "User List" sidebar_label: "User List" hide_title: true hide_table_of_contents: true -api: eJydV8tS4zgU/RXXXfTKbuJgcOIdj+4panoaisAqlZqSZZm4sS23JNNkXP73qSv5SUIS2FBEPtI99+i+VAEvmCAq4flNBAE8SiaueK4ET1Mm/pWMCLrGRbChIIJkTDEhIVhWkJOMQQCK5SRXSQQ2JDkEsGYk0nBJ1ywjEFSgNgUipRJJ/gR1vbJBsN8lk+qSRxtE4M9EsAgCJUpmQ8QkFUmBtCAAsIHyXLFcIZYURZpQTfnkl0RAtW2Lh78YVUhaoIMqYRK/pkmWqAEsL7NQkx0b/KFhtQ08jiU7YsOtwdU2xElqFKreQL43H2wgaXobawn3k5WKKLat31vbCw2rbYgSRFB1eMt1i6xtCFNOnw9vudSw2gbB0yNI3SOqtqGUTJhAObQDg8z6idBmG8bjUZtuIqhrG1SiUg1lqtW6XtU20FIqnn1PWBrJnw2V8SlXGmEZiOGAhmJSpgqC5cpuWRAhyAYDXbFM7opsu0mHK77mQqEI/5CiwG9bRh800DJIawg9PkKMsWOEaqyhVJhMaNNse6OEYXMTfV4AjI9jGKHH7dX16b/sya36K31H1GvFzRWzV5qW0Y6b/XjSmcjbkb/fjA3LhNy1/LxCrYd7jLT38Hkzb1Rt3RpaHwjcCGgywGgquVDbBBe4ioKTrMCdyz7DbSCSwucpmtrc1dy+lO5I4QF1vI+FblM6HDpu2qRuCbLMMiI2EMBfTFnI10oTqazLjTUgP/ZzH/KFpCUbdBN3VPX7igexpKGYevOZf34GnaRLoIIRxaIL1WvWNpoJqhIeYK2L60HGDWo/W1PN4YERumbiIyTpEdI2deSgsBp3WFY9ofgzPz49D4nj0rnveKHnOrNZyJz4NIy9KI6o788+4kd0wA/dXq22Y1pfLNMJD/r17r79fuqmL7Hh3kPf0nHh7uIBmnatfy4+4iXb5yV7VYJQ1VyFtL5YfZHY7+f+nVueTkaluiu1S/BP3fPJbOo5kedHjjd1Z07ox54TRnRKp+eMTvwz9GlQOpcw9TyfkAl1PNd1HY+Gc2fuRa4zn81nLD6f+2fEhdXRItVNRZIFz6UpH9OJu10CH1vvv5qGT540Gz0kr2yQjJYiURvdawilTEpH8WeWY/3G0XfHaT8SiZwyptYcY7zg+ndB1BoCOEGhTl7ck9TAJBMvZggfmFvgBNwUvZHRru6SIvmbbbbG9KZWXZRqzUXyn56rtWM4W9/3Y/q3tuR31zkZyLcdw6PO302m/Vozd/YLTSnqfg8K6WhNV4G2iewa75bt19Xecawfnvrz+8loeEg70gys7g7jfssoUNvlQSi+7Zo1XkvMNa+msS3WybNcE+suJSrmIttKxav7x2vr4u4GM40JaRbdr5PmuUT0SwBvEsMpIzoWGkGHUTc6tIsWxV7VSZGSJNfzuEjxmwlIwx6tumCDDsqVDWuM2WAJVRUSyR5FWte4/LtkWHEwVF+ISEiopwb0t4lATJMokfghgiAmqXz7/qv61x8+BXcSfGab8Vu0qT0AtV01X6/MKc4DHtAjtt6TmKRdKt7dLnTZbR6qGcdLB0H+YMSSP4YS10xNQ8W1ClKSP5XkCbHmTLwHUqJ8w4R81gnZ/DMYTkm+GTAc52brLP5F53ZuqSqT7nXd4c2nd3d0BcGgUdZVXdf/A07Lcp4= +api: eJydV99z4jgM/lcyetinZEto2kDe+mP3pnN7205pnxjmxnGc4m0SZ22nW47J/34j25BQKNDyhiJZnz7JkrwEUTNJNBfVTQYJPComr0SlpSgKJv9VjEg6RyH4UBNJSqaZVJBMl1CRkkECmlWk0jwDH3gFCcwZyYy6onNWEkiWoBc1aiotefUEbTvzQbLfDVP6UmQL1MC/XLIMEi0b5kPGFJW8RliQAPhARaVZpVGX1HXBqYF88kuhwnLbl0h/MaoRtMQANWcKvxa85LqnVjVlasBuOvxh1FofRJ4rdoTBrdVrfch5YRlavlH57j74QIriNjcU7gerNNFsm7+3vidGrfUh46hB9WGT65Vm60NaCPp82OTSqLU+SFEcAeoetVofGsWkLZRDFlhk3k9UdWZYj0cZ3WRowkrCi23ajdi7yZB4dxaRkiywXDUr1a769A31zY4kOvnxR7U+aK4LI2N6VQPtrPWBNkqL8jtnRaZ+Ooo2vV0ZDc+qWG6QgJw0hYZkOvtIRPaaXom5kBqT8w+pa/y25fTBKHpW0+urHl+51tkxCXTebAqp8WnN3jBh0dxknycA6/YYRBixwdP6vbY07cDNupS+Q+q1FjbF7JUWTbYjsx9vBvZG7CjJb9aHZ6/Ctfo8Q6sI9zhZ5eHzbt6wugqr771HsCPQ3gDLqRJSbwOcoBQJJ2WNltOu8/hAFIXPQ7QzYz0Luha/4wr3oGM+JmZ8mnJYYzMuzahSTVkSuYAE/mLaQ7xewZX2LhdeD/xmnPs0X0jRsN6UCzemUdeJIVc0lcNoPIrPz2BN6RSoZESz7EJ3nK0G4ABZSQ+gNk3/IGKntR+tnTLwwAidM/kRkPQIal0fOUis0TtMq9mc4lGcn56nJAjpOA6iNAqD0ShlQX6a5lGWZzSORx+JIzsQhxn73mqSe188O6EPxvWu3f44zTKicBG4h27VQMHdxQO4NcL8nXwkSrYvSvaqJaHapUJ5X7yuSeyPc7/lVqSDjVa9brVTiE/D88FoGAVZFGdBNAxHQRrnUZBmdEiH54wO4jOMqdc6pzCMopiQAQ2iMAyDiKbjYBxlYTAejUcsPx/HZySE2dEkta4jqVpUyraP4SDcboGPq+i/2oFPngwas7zPdi5OP7hClyXTc4ElXAvzvyZ6DgmcIA8nL+FJYdUUky9295/hH9pIrhcTXLxdT6OUKRVo8cyqXlslNf+bLbZeB64VXTR6LiT/z6zzBjeu9Pfd6+DbqqOvszXosbNdohuDfb0QdzK37nYC12nW/3t9ckNmLvla4rbN6Uoy63bGTrZzyeub7FnKuhWqc9rtR/1DVovNeoC9V8ydyUa59tCuCvLt7Gwxe7kwuNx4m8z5s5oT764gOhey3LqQV/eP197F3Q3eNyaVFYZfB+4xR8w7BROOVVcSUzKO935xbhy6LirNXvVJXRBemdeCNIu/rVuLHr2G4IOp3ZkPcyztZArLZUoUe5RF26L4d8Ow72BFvxDJSWp2B4zXFSouZhlX+CGDJCeFevs6XXZvU+geBpsAn9li86XsOhBA6y/d1yt7SvCAB3QaW69dfD2vb+zd7cQ0X/eMLgUmHST5g4VN/lhIwiC1YxVlSyhI9dSQJ9S1Z+Lvf0bVbOw= sidebar_class_name: "post api-method" info_path: docs/user-service/apis/shiksha-platform custom_edit_url: null @@ -54,7 +54,7 @@ User List <RequestSchema title={"Body"} - body={{"required":true,"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"limit":{"type":"number","description":"Limit"},"offset":{"type":"number","description":"Offset"},"filters":{"description":"Filters","allOf":[{"type":"object","properties":{"state":{"type":"string","description":"State"},"district":{"type":"string","description":"District"},"block":{"type":"string","description":"Block"},"role":{"type":"string","description":"Role"},"username":{"type":"string","description":"User Name"},"userId":{"type":"string","description":"User Id"}},"title":"setFilters"}]},"customFieldsName":{"description":"Custom Fields Name","default":[],"type":"array","items":{"type":"string"}},"tenantCohortRoleMapping":{"description":"Tenant Cohort RoleMapping","allOf":[{"type":"object","properties":{"tenantId":{"type":"string","description":"Tenant Id"},"cohortId":{"description":"Cohort Id","default":[],"type":"array","items":{"type":"string"}},"roleId":{"type":"string","description":"Role Id"}},"required":["cohortId"],"title":"tenantCohortRoleMappingDto"}]},"exclude":{"description":"Filters","allOf":[{"type":"object","properties":{"userIds":{"description":"Exclude User IDs","default":[],"type":"array","items":{"type":"string"}},"cohortIds":{"description":"Exclude Cohort IDs","default":[],"type":"array","items":{"type":"string"}}},"required":["userIds","cohortIds"],"title":"excludeFields"}]},"sort":{"description":"Sort","example":["username","asc"],"type":"array","items":{"type":"string"}}},"required":["limit","offset","filters","customFieldsName"],"title":"UserSearchDto"},"examples":{"a":{"summary":"Get user list By username","description":"Get user list By username","value":{"limit":1,"filters":{"username":"fscbr2498765"},"sort":["createdAt","asc"],"offset":0}},"b":{"summary":"Get user list By Role","description":"Get user list By Role","value":{"limit":1,"filters":{"role":"Teacher"},"sort":["createdAt","asc"],"offset":0}},"c":{"summary":"Get user list By userId","description":"Get user list By userId","value":{"limit":1,"filters":{"userId":"787f36ba-1c97-4b41-88be-f3bf4dfdc778"},"sort":["createdAt","asc"],"offset":0}},"d":{"summary":"Get user list By State District & Block","description":"Get user list By State District & Block","value":{"limit":1,"filters":{"states":"BR","districts":"PAT","blocks":"PS"},"sort":["createdAt","asc"],"offset":0}},"e":{"summary":"Get user list extract userIds & cohortIds","description":"Get user list extract userIds & cohortIds","value":{"limit":10,"exclude":{"userIds":["73160824-d47d-4218-b7f4-bdc2c26ec075"],"cohortIds":["2447aa0c-4111-4cb9-94d1-9898ef6975a1"]},"sort":["createdAt","asc"],"offset":0}}}}}}} + body={{"required":true,"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"limit":{"type":"number","description":"Limit"},"offset":{"type":"number","description":"Offset"},"filters":{"description":"Filters","allOf":[{"type":"object","properties":{"state":{"type":"string","description":"State"},"district":{"type":"string","description":"District"},"block":{"type":"string","description":"Block"},"role":{"type":"string","description":"Role"},"username":{"type":"string","description":"User Name"},"userId":{"type":"string","description":"User Id"},"email":{"description":"email Ids","type":"array","items":{"type":"string"}},"status":{"description":"status","type":"array","items":{"type":"string"}}},"title":"setFilters"}]},"customFieldsName":{"description":"Custom Fields Name","default":[],"type":"array","items":{"type":"string"}},"tenantCohortRoleMapping":{"description":"Tenant Cohort RoleMapping","allOf":[{"type":"object","properties":{"tenantId":{"type":"string","description":"Tenant Id"},"cohortId":{"description":"Cohort Id","default":[],"type":"array","items":{"type":"string"}},"roleId":{"type":"string","description":"Role Id"}},"required":["cohortId"],"title":"tenantCohortRoleMappingDto"}]},"exclude":{"description":"Filters","allOf":[{"type":"object","properties":{"userIds":{"description":"Exclude User IDs","default":[],"type":"array","items":{"type":"string"}},"cohortIds":{"description":"Exclude Cohort IDs","default":[],"type":"array","items":{"type":"string"}}},"required":["userIds","cohortIds"],"title":"excludeFields"}]},"sort":{"description":"Sort","example":["username","asc"],"type":"array","items":{"type":"string"}}},"required":["limit","offset","filters","customFieldsName"],"title":"UserSearchDto"},"examples":{"a":{"summary":"Get user list By username","description":"Get user list By username","value":{"limit":1,"filters":{"username":"fscbr2498765"},"sort":["createdAt","asc"],"offset":0}},"b":{"summary":"Get user list By Role","description":"Get user list By Role","value":{"limit":1,"filters":{"role":"Teacher"},"sort":["createdAt","asc"],"offset":0}},"c":{"summary":"Get user list By userId","description":"Get user list By userId","value":{"limit":1,"filters":{"userId":"787f36ba-1c97-4b41-88be-f3bf4dfdc778"},"sort":["createdAt","asc"],"offset":0}},"d":{"summary":"Get user list By State District & Block","description":"Get user list By State District & Block","value":{"limit":1,"filters":{"states":"BR","districts":"PAT","blocks":"PS"},"sort":["createdAt","asc"],"offset":0}},"e":{"summary":"Get user list extract userIds & cohortIds","description":"Get user list extract userIds & cohortIds","value":{"limit":10,"exclude":{"userIds":["73160824-d47d-4218-b7f4-bdc2c26ec075"],"cohortIds":["2447aa0c-4111-4cb9-94d1-9898ef6975a1"]},"sort":["createdAt","asc"],"offset":0}}}}}}} > </RequestSchema> diff --git a/docs/user-service/apis/user-controller-send-otp.api.mdx b/docs/user-service/apis/user-controller-send-otp.api.mdx new file mode 100644 index 0000000..2e98b5c --- /dev/null +++ b/docs/user-service/apis/user-controller-send-otp.api.mdx @@ -0,0 +1,71 @@ +--- +id: user-controller-send-otp +title: "Send Otp" +description: "Send Otp" +sidebar_label: "Send Otp" +hide_title: true +hide_table_of_contents: true +api: eJxdk8Fy4jAMhl+F0dksZY+5dds9dPYAU+CUYXZEIoiLY7u2QpvN5N13ZAOl5EKwLP2/PikDOE8BWTv7UkMBm0jhyVkOzhgKfyPZesEeFHgM2BJTiFCUWwWB3juK/MvVPRRD+qsD1VBw6EhB5SyTZQmh90ZXSWL2Fp2Vs1g11KK8ce8JCnC7N6pYdIIYYk1Roq3baUM39yIHbQ8wigE8F7sLjerGTXkpcU3YKmDNUhQW7Fdk6+f1AsYx50XvbMzaPx8e5KemWAXtxb6krJeTSJYnsasqinHfGdMnTcaDoEkEReR7nuhMMsmWuHHC2ruYOkZuoIBZFynMTvOZMJ+6dDVSOF2JR6q6oLlfCbtsEZOHKbsj3ZJAr/9QDwq0SDeENQVQYLGV6GPHjQv6X5pIsi5Tef2a5+9PbH2mfuF/gfuF/WYS2u5dUj9jXTX6GBucLA3y3oUW7mE8vW6eJ4/LF1Ag7eXD+Y8HyHuDleyNGBNCLabWzuZvOH6ree2d6ZNn3qC2Yq0LRmIZcQmCWETnie0Z81ZBI5MoShiGHUbaBDOOcvzeUegz/BMGjTtpr9yO6sK0KAc4Ui8t5X2frsWFXDddnsTd7o/bmwVYLlZrULA7f0OtqyUn4Idwxg8oABS41GEadzobwKA9dHiQu7mmPP8BDWBK5g== +sidebar_class_name: "post api-method" +info_path: docs/user-service/apis/shiksha-platform +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={"Send Otp"} +> +</Heading> + +<MethodEndpoint + method={"post"} + path={"/user/v1/send-otp"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Send Otp + +<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":{"mobile":{"type":"string"},"reason":{"type":"string"}},"required":["mobile","reason"],"title":"OtpSendDTO"}}}}} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"OTP sent successfully"}}} +> + +</StatusCodes> + + + \ No newline at end of file diff --git a/docs/user-service/apis/user-controller-send-password-reset-link.api.mdx b/docs/user-service/apis/user-controller-send-password-reset-link.api.mdx index 637ee92..29aab7c 100644 --- a/docs/user-service/apis/user-controller-send-password-reset-link.api.mdx +++ b/docs/user-service/apis/user-controller-send-password-reset-link.api.mdx @@ -1,11 +1,11 @@ --- id: user-controller-send-password-reset-link -title: "Passwort reset" -description: "Passwort reset" -sidebar_label: "Passwort reset" +title: "Password reset" +description: "Password reset" +sidebar_label: "Password reset" hide_title: true hide_table_of_contents: true -api: eJx9U81y2jAQfhVmzyKGHn1Lkx7SdqYMhBPDdIS9wQqypKzWSVzG795ZCRJCmPiCWWt3vz/twQckzca7uxpKWEakG++YvLVIfyO6eqZjfPFUzzEi/zZuBwqCJt0iI0UoV2sFhE8dRv7u6x7KffprCGsomTpUUHnH6Fg+6RCsqdLC4jF6J7VYNdhqeeM+IJTgN49YsewhgccGo3ztIpLTLZ6cjEzGbUEBvuo2WCn99I2DQTDVhrDiJdmvGxrmEMuiOFSuKt/CMKgTFqv31R/nrhWw4TRlcUmqW/YwDHlYDN7FTOTbZCI/NcaKTBAtoIRj84ike2SN240iOh7FrqowxofO2v4qIWO9FeGTW4Lh4iDOg0BBi9x4cTf4mFTV3EAJhZAqnqdFOGwep4axzR5HpOc3gyNWHRnuF2JVJqETqjH7HboTgXUwv7AHBUawNKhrJFCQfYPrjhtP5l8KQOIiIZi/x+fH0ZZTu7OnZ5Ze9k32PviE52hMY3ax0aOZ1fzgqYVzvW7my9vR9ewOFAjhXJxeTSAHV1cSXIEq8rU6kT3g+iT1h8lvmjC+chGsNimYXQ5kdiFHS1ZPkzOfnVgraMS3cgX7/UZHXJIdBik/dUh99udZk9Eb4btaD+ooe7naww574Zhv4PheAMlx22Wzzm7jsD6Jy+zP4h4UbA63uvW19JB+ESv0C5QACnwimxKRanuw2m07vZWzeaY8/wFK9Yg8 +api: eJx9U81y2jAQfhVmzwKHHn1Lkx7SdqYMhBPDdIS9wQqypKzWJC7jd++sBAkhmfiCWWt3vz8dwAckzca7uxpKWEakG++YvLVIfyO6eqZjfPZUzzEi/zZuBwqCJt0iI0UoV2sFhE8dRv7u6x7KQ/prCGsomTpUUHnH6Fg+6RCsqdLC4jF6J7VYNdhqeeM+IJTgN49YsewhgccGo3ztIpLTLZ6djEzGbUEBvug2WCn99I2DQTDVhrDiJdmvGxrmEMuiOFYmlW9hGNQZi9Xb6vdz1wrYcJqy+EyqW/YwDHlYDN7FTOTb1ZX81BgrMkG0gBJOzSOS7pE1bjeK6HgUu6rCGB86a/tJQsZ6K8IntwTDV4NAQYvceHE3+JhU1dxACYWQKvbTIhwbxqlhbLPHEWn/anDEqiPD/UKsyiR0QjVmv0N3JrAO5hf2oMAIlgZ1jQQKsm9w3XHjyfxLAUhcJATzt/j8ONlybnf29MLSz32TvQ8+4TkZ05hdbPRoZjU/eGrhUq+b+fJ2dD27AwVCOBenkyvIwdWVBFeginytTmSPuD5I/W7yqyaML1wEq00KZpcDmV3I0ZLV0+TMRyfWChrxrVzB4bDREZdkh0HKTx1Sn/3ZazJ6I3xX60GdZC9XB9hhLxzzDRzfCyA5brts1sVtHNZncZn9WdyDgs3xVre+lh7Sz2KFfoYSQIFPZFMiUu0AVrttp7dyNs+U5z8P5Ygc sidebar_class_name: "post api-method" info_path: docs/user-service/apis/shiksha-platform custom_edit_url: null @@ -22,7 +22,7 @@ import Heading from "@theme/Heading"; <Heading as={"h1"} className={"openapi__heading"} - children={"Passwort reset"} + children={"Password reset"} > </Heading> @@ -36,7 +36,7 @@ import Heading from "@theme/Heading"; -Passwort reset +Password reset <Heading id={"request"} diff --git a/docs/user-service/apis/user-controller-send-password-reset-otp.api.mdx b/docs/user-service/apis/user-controller-send-password-reset-otp.api.mdx new file mode 100644 index 0000000..91dd42c --- /dev/null +++ b/docs/user-service/apis/user-controller-send-password-reset-otp.api.mdx @@ -0,0 +1,71 @@ +--- +id: user-controller-send-password-reset-otp +title: "Send Password Reset Otp" +description: "Send Password Reset Otp" +sidebar_label: "Send Password Reset Otp" +hide_title: true +hide_table_of_contents: true +api: eJx1U0tz2jAQ/iuePYsAPfqWJj2kPcDwODFMR9gLVpAlZbUmcT3+752VgZCk9QGb1T6+x6oDH5A0G++eSshhHZEevGPy1iL9jujKuY7x1VO5wIg8W81BQdCka2SkCPlmq4DwpcHI333ZQt6lv4awhJypQQWFd4yO5UiHYE2R5o2fo3cSi0WFtZYvbgNCDn73jAXLHBJ0bDDKaRORnK7xJjMyGXcABfim62Al9NNXDvpe3aDYvJduFbDhlLj8B7dH9tD3Q3UM3sVh8rfJRF4lxoJMEPCQw6U2IynOrHHHLKLjLDZFgTHuG2vbuwSF9UGUSuoKhI+NBEh27ZagZDMOoKBGrrzYEnxMemiuIIex0BmfpuNwLholCCOfiiLS6epMxKIhw+1SNB7I6IRuxP6I7kZKHcwvbEGBEUwV6hIJFAyCw33DlSfzJzmXOIl7i3fff1wMuPXpbIb03Ps066J9ZY6x0tncat57quGzJg+L9WN2P38CBUJmCE7vJjBsky5kmwSGKFPrROQ88/9yfhhxJc74xuNgtUlIG7JyNig9LI5gmCb1v6i9VVCJNfkGum6nI67J9r2EXxqkdvDgpMnonfDebHt1kTbfdHDEVrgO12O0EjySbpvBkE9Xpd/ebMR8tlyBgt35ytW+lBrSr6DSbw6gwCeuyfUU68Bqd2j0QXKHnvL8BQptZB4= +sidebar_class_name: "post api-method" +info_path: docs/user-service/apis/shiksha-platform +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={"Send Password Reset Otp"} +> +</Heading> + +<MethodEndpoint + method={"post"} + path={"/user/v1/password-reset-otp"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Send Password Reset Otp + +<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":{"username":{"type":"string","example":"John"}},"required":["username"],"title":"SendPasswordResetOTPDto"}}}}} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"Password reset link sent successfully."}}} +> + +</StatusCodes> + + + \ No newline at end of file diff --git a/docs/user-service/apis/user-controller-update-user.api.mdx b/docs/user-service/apis/user-controller-update-user.api.mdx index 049f9e0..21bdf0d 100644 --- a/docs/user-service/apis/user-controller-update-user.api.mdx +++ b/docs/user-service/apis/user-controller-update-user.api.mdx @@ -5,7 +5,7 @@ description: "Update User" sidebar_label: "Update User" hide_title: true hide_table_of_contents: true -api: eJzlWFuP27gV/isCn1rAzJAURVF+ai672EUDNMgkD8VgYBySh2MlunglerJew/+9oOSLfJl02+5T9yUZkzyH5/Lxo/htSbvCDkLZNj87Miefe+zetk3o2qrCbrFeOQgYB8mMrKCDGgN2PZk/bEkDNZI5WffYlY7MSIe/rMsOHZmHbo0zUjZkTlYQlmRG8FeoV1VczkWKMlM5RV0YyoVLKchMUSmU4pLnkjFGZqS3S6yBzLckbFbRrg9d2TyR3W523DlgA00Y9h72WiK4IdCXjR/HMLEPb1q3iSsuo3bY265cxYKQOflhiLtPoMPkqXzGJvFtl9gOIZTNUxJzT76VYZm40nvssAlJ11bYJ9C4yZhdh7ZOfImV61+RGbFtE7AJcX9YrarSDg24+9LHTbfX8bfmC9oQW9DFdoUS+zgbt38HYboSug42sSAB6/73eRireVWrGXlxIqZ4c8K15uY41lBWty3K+LcNNyf7AOH2RuBch31/c25VNrZ1t+2GzqF7fXu/Ee0vze5t32y+Z/vC7AjVeMJeSHN9O5cOYY+J68rhc2nxpsvd9DA+nJq8b+m+gWO7Ds2ZtOJQ+FOZT0WdlnBasGl5psWYpH5M9JjWJInHGQllGBji8x7V7z79Y0jFrvvQ1j8Oh+e/R/pw+F5owDNU61t4uajjwcXBYBLz21OMY9g3WjCc1It0LtL+PNRt8HDkzDE3hPr9SG+RH9Z1Dd0mGg0GySeEOnl/oL9zCnt3+jWQ17clNgk0CdarsElM6zZJ2UcmOyU2P1LsfYNLqJIPEAaInLfiYVJVoqQqbAqWaisVlYXLqc4EUMZ8kekiT3ObnTZ4IG8+ksfI5ScPRnF03iqa5jqnkuUF1cqlNM2FEsaLFAqcevjw+tOlCwlglAakOtWCyhQgXi5AsTAiLVJe6Cw/c3F/6QGUMFaYglrNkUqVWgo8zSiYXAhUiMCKkweSCnJunwmjIfOOGj9cappRba2mnFmA3BnQZlIGUkOFFx6kt6zQNqMGbUYl+BhB5igrUs0ywzLOpxFEZCyqsfUXjpzjkpmcFsYYKnkqaeGkoaitlSITBXIzcSSYkGT3uJvt79EBd2DBYV3afyJ0g9PhUPRh7fbX1xUU7/dzlzD8CauqPSAtgT4JS0yeOsR4kd5CXrvu4DkRom2vTs3/JfJycOAKk1NmvaASpKbGKkYzBZo5ywRnZx56tG3jFnYJjcUFVOu6KS99Cs9yC6Co4kZTCQpoIbykhTRZViiQWskJBLi+gFA8BBlzkuocBJXOclo4VFRnWcFtprnP7MTe4w08i4JLzaWlApinUgpBwXtNlXGpYYVLmSqmeZXNc1s9o1uUzcK1NfahtItvbff1MjmferDMptRYbeL3I6PaZIpyxbR3KbcinRSM3C/ha1ldBFeABKcYp0ykhkqVe2qMQWoccK0zr3N7VnR91XcvdZZzQ7X2jsrUFBSsSWnBwTvIC8bBnnXNLtu2Wtiq7dcdLtwaF6Fd2Pa5dFf5eZkLJXOqrGRUClTUCMaos7k0QnIs+Bmu100NXVfilSMHWSGNQGqVjIxSKAqeZ1ShcEJmOrcFnMVYQxdWy7bBK0+cF64QnnowOZU2d1Sneay7ZCZDJ1I3xUPT/ntC0RlXOo8EJQRSCUJQI3JPlVHKQ8qkQTuQjgdbVmWA0N6+A3+czP8x5MOPH0dz0g8ji1UHYQn1357i8Cvb1n8KaspykzEuNRUm01RmmNHCiJwqYLnNUp5brqeXIrs4ZZBz79KCUe9UTmVmUwqGI1VFIY12hcpBfP9StEay3HFOPY+XopCWQmQSmWcZcCvBiOmlOMXKH4fACqFrXvgCe7+f+1+R9w4NNF+gmUDP7Yf+ZKBLnUjRy5ymzKRUepRUp6mlUvicGxQ5qunnCzZPVdkvL/md6SJFZ6hkFqj03lBguaYpMqEYV95kU9wIfmGvtQZQ3FPuU0WlYZqaVHGqtWRWCp5Kpq+Q+zu+oXb7F0K/apt+/MQXjMX/zuETHwXJ/jWV9Gtrse/9uqo2rwZEBniK3R+WxbdEj3bdlWEzIAKG1TS0X7Eh84fHKH5ceB+xu5d3agzL1o2ajV0Oek9Ykjm5i4+Xu2d+N8Zxtx0Vn1180GH3PMpBk83vo3qB+9SnIZyebqvy77i5km32R+D1Oizbrvxt0ESGNKMu8vEk2/xwEJOmCsjDVMw4vOCOPo+/R+ni9HtQLE4/j3R/nD/qE6exvSxxGjiqEaehowhxGppoD6fBieRwtTJqCVcrzwdPusJ5eOuzYA4qwiSto3hwfOw+fpdUjpYHqB/NdrGNvh3au3/K3i/Lr/0Skg8VBN929RUrvv34+V3y+sPP0R92/TjIX7G9NAaDHhQ7v2r7UEMzIchzzJ65PeIr4K/hblVB2QzKTDdITyOax6d43Jcfa0pmZL5XMR9nZNn2Ia7bbg30+Lmrdrs4/MsaI99HoD9DV4KJmT5sI0Di347MPVT9pYC4PUl95C8f94LAX5PYuVuhHs5Hs5lUmszIV9yclNYJv/yHEby07eh+Iqcet45sOM6+Hb3QT9HBacWVfBlxdGSSD68/vf2JzIjZi631eCQ6+BZRCd/GmNoh1IEwhrEtqaB5WsNTXDs6jViAdWzglES+DiSy/yOW4mb9zvnkkG38N2Z302S7HSlqtzuuH6detDiS2Lg61vVxt9v9CzS6ccg= +api: eJzlWFuP27gV/isCn1rAzJAURVF+ai672EUDNMgkD8VgYBySh2MlunglerJew/+9oOSLfJl02+5T9yUZkzyH5/Lxo/htSbvCDkLZNj87Miefe+zetk3o2qrCbrFeOQgYB8mMrKCDGgN2PZk/bEkDNZI5WffYlY7MSIe/rMsOHZmHbo0zUjZkTlYQlmRG8FeoV1VczkWKMlM5RV0YyoVLKchMUSmU4pLnkjFGZqS3S6yBzLckbFbRrg9d2TyR3W523DlgA00Y9h72WiK4IdCXjR/HMLEPb1q3iSsuo3bY265cxYKQOflhjLtPoMPkqXzGJvFtl9gOIZTNUxKTT76VYZm40nvssAlJ1w4GjZuM2XVo68SXWLn+FZkR2zYBmxADgNWqKu3Qgbsvfdx1e51Aa76gDbEHXexXKLGPs3H7dxCmK6HrYBMrErDuf5+HsZxXxZqRFydiijcnXGtujmMNZXXboox/23Bzsg8Qbm8EznXY9zfnVmVjW3fbbugcute39xvh/tLs3vbN5nu2L8yOWI1H7IU017dz6RD2mLiuHD6XFl9wCXZE8OXUjGCzrsn8IVZwOLR1+4zkcbebHuCHEy72KNj3fOzwoZ+T7h16derMqQ/Tqk9rPK3otH6Tah1rc6zEJO/HGQllGFjl8/4gvPv0j0gRxK770NY/Duftvz8cw3l9ocDPUK1vQeyijgcXB4NJzG9PMY5h32jBcLgv0rlI+/NQt8HDkWfH3BDq9yMlRkpZ1zV0m2g0GCSfEOrk/YEyz2nv3enXwHffltgk0CRYr8ImMa3bJGUfye+U2PxIy/cNLqFKPkAYIHLeiodJVYmSqrApWKqtVFQWLqc6E0AZ80WmizzNbXba4IG8+UgeI/+fPBjF0XmraJrrnEqWF1Qrl9I0F0oYL1IocOrhw+tPly4kgFEakOpUCypTgHghAcXCiLRIeaGz/MzF/aUHUMJYYQpqNUcqVWop8DSjYHIhUCECK04eSCrIuX0mjIbMO2r8cBFqRrW1mnJmAXJnQJtJGUgNFV54kN6yQtuMGrQZleBjBJmjrEg1ywzLOJ9GEJGxqMbWXzhyjktmcloYY6jkqaSFk4aitlaKTBTIzcSRYEKS3eNutr97B9yBBYd1af+J0A1Oh0PRh7Xb33hXULzfz13C8CesqvaAtAT6JCwxeeoQw0hlV8hr1x08J0K07dWp+b9EXg4OXGFyyqwXVILU1FjFaKZAM2eZ4OzMQ4+2bdzCLqGxuIBqXTflpU/hWW4BFFXcaCpBAS2El7SQJssKBVIrOYEA1xcQiocgY05SnYOg0llOC4eK6iwruM0095md2Hu8gWdRcKm5tFQA81RKISh4r6kyLjWscClTxTSvsnluq2d0i7JZuLbGPpR28a3tvl4m51MPltmUGqtN/OZkVJtMUa6Y9i7lVqSTgpH7JXwtq4vgCpDgFOOUidRQqXJPjTFIjQOudeZ1bs+Krq/67qXOcm6o1t5RmZqCgjUpLTh4B3nBONizrtll21YLW7X9usOFW+MitAvbPpfuKj8vc6FkTpWVjEqBihrBGHU2l0ZIjgU/w/W6qaHrSrxy5CArpBFIrZKRUQpFwfOMKhROyEzntoCzGGvowmrZNnjlifPCFcJTDyan0uaO6jSPdZfMZOhE6qZ4aNp/Tyg640rnkaCEQCpBCGpE7qkySnlImTRoB9LxYMuqDBDa23fgj5P5P4Z8+PHjaE76YWSx6iAsof7bUxx+Zdv6T0FNWW4yxqWmwmSaygwzWhiRUwUst1nKc8v19FJkF6cMcu5dWjDqncqpzGxKwXCkqiik0a5QOYjvX4rWSJY7zqnn8VIU0lKITCLzLANuJRgxvRSnWPnjEFghdM0LX2Dv93P/K/LeoYHmCzQT6Ln90J8MdKkTKXqZ05SZlEqPkuo0tVQKn3ODIkc1/XzB5qkq++UlvzNdpOgMlcwCld4bCizXNEUmFOPKm2yKG8Ev7LXWAIp7yn2qqDRMU5MqTrWWzErBU8n0FXJ/xzfUbv9C6Fdt04+f+IKx+N85fOKjINm/ppJ+bS32vV9X1ebVgMgAT7H7w7L4lujRrrsybAZEwLCahvYrNmT+8BgFkwvvI3b3klCNYdm6Ueexy0EjCksyJ3fx8XL3zO/GOO62o0q0iw867J5HCWmy+X0UPHCf+jSE09NtVf4dN1dSz/4IvF6HZduVvw0yypBmlFI+nqSeHw4C1FQ0eZjqH6cX8uXvUe04/R5EjsmD+kD3x/mjpHEa2ysZp4GjgHEaOuoWp6GJXHEanKgUVyuj/HC18nzwJEWch7c+C+YgPEzSOuoNkyz2MsOgJkSwfIdjjkYH5B+ezBH7ZePbodv7l+39svzaLyH5UEHwbVdfkeTbj5/fJa8//Bz9YdePg/wV24trMChKEQirtg81NBO+PIfwmdsj3AL+Gu5WFZTNoO10g3g1gnt8mcd9+bHEZEbmeyH0cUaWbR/iuu3WQI+fu2q3i8O/rDHSf8T9M3QlmJjpwzbiJf7tyNxD1V9qkNuTWEj+8nGvD/w1iY28FerhuDSbSaXJjHzFzUmsndDNfxjBS9uO7ieK7HHrSI7j7NvRC/0UHZxWXAmgEUdHYvnw+tPbn8iMmL1eW48npINvEaTwbYypHUId+GMY25IKmqc1PMW1o9OIBVjHBk455evAKfs/Yilu1u+cXg7Zxn9jdjdNttuRsXa74/px6kWLI6eNq2NdH3e73b8An2yHfw== sidebar_class_name: "patch api-method" info_path: docs/user-service/apis/shiksha-platform custom_edit_url: null @@ -54,7 +54,7 @@ Update User <RequestSchema title={"Body"} - body={{"required":true,"description":"Exampls are given for creating user with different roles and different cutom fields.","content":{"application/json":{"schema":{"type":"object","properties":{"userData":{"type":"array","items":{"type":"object","properties":{"username":{"type":"string"},"name":{"type":"string"},"role":{"type":"string"},"dob":{"type":"string"},"email":{"type":"string"},"district":{"type":"string"},"state":{"type":"string"},"address":{"type":"string"},"pincode":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"tenantId":{"type":"string"},"status":{"type":"string"},"reason":{"type":"string"},"deviceId":{"type":"string"}},"required":["username","name","role","dob","email","district","state","address","pincode","createdAt","updatedAt","createdBy","updatedBy","tenantId","status","reason","deviceId"],"title":"UserDataDTO"}},"customFields":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"],"title":"CustomFieldDTO"}}},"required":["userData","customFields"],"title":"UserUpdateDTO"},"examples":{"teamLeader":{"summary":"Update Team Leader","description":"Description for when an empty body is used","value":{"name":"Snehal Patil","customFields":[{"fieldId":"6469c3ac-8c46-49d7-852a-00f9589737c5","value":["BR"]},{"fieldId":"b61edfc6-3787-4079-86d3-37262bf23a9e","value":["PAT"]},{"fieldId":"4aab68ae-8382-43aa-a45a-e9b239319857","value":["PS"]},{"fieldId":"a62bc2b9-c81e-463c-a135-ab722e6eea09","value":"32"},{"fieldId":"52b8a5fd-bf56-4280-8cc8-10caa7dba8b5","value":"male"},{"fieldId":"4fc098c5-bec5-4afc-a15d-093805b05119","value":"team_leader"},{"fieldId":"4dd140b7-9bbb-4134-9d4b-e8cc42529e1b","value":"2024"}]},"headers":{"academicYearId":""}},"student":{"summary":"Update Student","description":"Hello is used as the greeting","value":{"name":"Sourav 22ooa","customFields":[{"fieldId":"6469c3ac-8c46-49d7-852a-00f9589737c5","value":["BR"]},{"fieldId":"b61edfc6-3787-4079-86d3-37262bf23a9e","value":["PAT"]},{"fieldId":"4aab68ae-8382-43aa-a45a-e9b239319857","value":["PS"]},{"fieldId":"7adad9b7-0cf2-4a48-bc60-56a80dc02107","value":["second_chance_alumni"]},{"fieldId":"2f07caa6-61b8-4a6a-92f4-94b5596a4864","value":"18"},{"fieldId":"c81e50d4-87a2-4dc1-9de6-85591c581f5c","value":"female"},{"fieldId":"2914814c-2a0f-4422-aff8-6bd3b09d3069","value":["involved_in_domestic_work"]},{"fieldId":"f3fac0c3-bc8b-4260-8b56-1608fd31c237","value":"Shakil"},{"fieldId":"9a4ad601-023b-467f-bbbe-bda1885f87c7","value":["8"]},{"fieldId":"4f48571b-88fd-43b9-acb3-91afda7901ac","value":["school_closure_due_to_covid"]},{"fieldId":"ff472647-6c40-42e6-b200-dc74b241e915","value":["unmarried"]},{"fieldId":"da594b2e-c645-4a96-af15-6e2d24587c9a","value":["smartphone"]},{"fieldId":"d119d92f-fab7-4c7d-8370-8b40b5ed23dc","value":"no"}]},"headers":{"academicYearId":"851687bb-422e-4a22-b27f-6b66fa304bec"}},"facilitator":{"summary":"Update Facilitator","description":"Hello is used as the greeting","value":{"name":"Sourav1","email":"sourav_pratham@gmail.com","customFields":[{"fieldId":"6469c3ac-8c46-49d7-852a-00f9589737c5","value":["BR"]},{"fieldId":"b61edfc6-3787-4079-86d3-37262bf23a9e","value":["PAT"]},{"fieldId":"4aab68ae-8382-43aa-a45a-e9b239319857","value":["PS"]},{"fieldId":"57b50148-2b58-45e5-9b27-6a07c5317c18","value":"30"},{"fieldId":"a71fd390-fd67-45c3-ab1e-6994b8d967a2","value":"male"},{"fieldId":"cb407d11-f1c5-424c-a422-4755a1c4ab29","value":"facilitator"}]},"headers":{"academicYearId":"851687bb-422e-4a22-b27f-6b66fa304bec"}},"learner":{"summary":"Update Learner","description":"Hello is used as the greeting","value":{"name":"Debanjan","email":"debanjan@gmail.com","customFields":[{"fieldId":"6469c3ac-8c46-49d7-852a-00f9589737c5","value":["BR"]},{"fieldId":"b61edfc6-3787-4079-86d3-37262bf23a9e","value":["PAT"]},{"fieldId":"4aab68ae-8382-43aa-a45a-e9b239319857","value":["PS"]},{"fieldId":"3d23ef47-30b3-4fe4-833c-42f71be27e6b","value":"english"},{"fieldId":"90893edb-40ca-4ffb-a078-3e026016fb59","value":"21"},{"fieldId":"888aa61f-1f36-4b08-b361-8840c4213408","value":"male"}]},"headers":{"academicYearId":""}}}}}}} + body={{"required":true,"description":"Examples are given for creating user with different roles and different cutom fields.","content":{"application/json":{"schema":{"type":"object","properties":{"userData":{"type":"array","items":{"type":"object","properties":{"username":{"type":"string"},"name":{"type":"string"},"role":{"type":"string"},"dob":{"type":"string"},"email":{"type":"string"},"district":{"type":"string"},"state":{"type":"string"},"address":{"type":"string"},"pincode":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"tenantId":{"type":"string"},"status":{"type":"string"},"reason":{"type":"string"},"deviceId":{"type":"string"},"action":{"type":"string","enum":["add","remove"]}},"required":["username","name","role","dob","email","district","state","address","pincode","createdAt","updatedAt","createdBy","updatedBy","tenantId","status","reason","deviceId"],"title":"UserDataDTO"}},"customFields":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}},"required":["fieldId","value"],"title":"CustomFieldDTO"}}},"required":["userData","customFields"],"title":"UserUpdateDTO"},"examples":{"teamLeader":{"summary":"Update Team Leader","description":"Description for when an empty body is used","value":{"name":"Snehal Patil","customFields":[{"fieldId":"6469c3ac-8c46-49d7-852a-00f9589737c5","value":["BR"]},{"fieldId":"b61edfc6-3787-4079-86d3-37262bf23a9e","value":["PAT"]},{"fieldId":"4aab68ae-8382-43aa-a45a-e9b239319857","value":["PS"]},{"fieldId":"a62bc2b9-c81e-463c-a135-ab722e6eea09","value":"32"},{"fieldId":"52b8a5fd-bf56-4280-8cc8-10caa7dba8b5","value":"male"},{"fieldId":"4fc098c5-bec5-4afc-a15d-093805b05119","value":"team_leader"},{"fieldId":"4dd140b7-9bbb-4134-9d4b-e8cc42529e1b","value":"2024"}]},"headers":{"academicYearId":""}},"student":{"summary":"Update Student","description":"Hello is used as the greeting","value":{"name":"Sourav 22ooa","customFields":[{"fieldId":"6469c3ac-8c46-49d7-852a-00f9589737c5","value":["BR"]},{"fieldId":"b61edfc6-3787-4079-86d3-37262bf23a9e","value":["PAT"]},{"fieldId":"4aab68ae-8382-43aa-a45a-e9b239319857","value":["PS"]},{"fieldId":"7adad9b7-0cf2-4a48-bc60-56a80dc02107","value":["second_chance_alumni"]},{"fieldId":"2f07caa6-61b8-4a6a-92f4-94b5596a4864","value":"18"},{"fieldId":"c81e50d4-87a2-4dc1-9de6-85591c581f5c","value":"female"},{"fieldId":"2914814c-2a0f-4422-aff8-6bd3b09d3069","value":["involved_in_domestic_work"]},{"fieldId":"f3fac0c3-bc8b-4260-8b56-1608fd31c237","value":"Shakil"},{"fieldId":"9a4ad601-023b-467f-bbbe-bda1885f87c7","value":["8"]},{"fieldId":"4f48571b-88fd-43b9-acb3-91afda7901ac","value":["school_closure_due_to_covid"]},{"fieldId":"ff472647-6c40-42e6-b200-dc74b241e915","value":["unmarried"]},{"fieldId":"da594b2e-c645-4a96-af15-6e2d24587c9a","value":["smartphone"]},{"fieldId":"d119d92f-fab7-4c7d-8370-8b40b5ed23dc","value":"no"}]},"headers":{"academicYearId":"851687bb-422e-4a22-b27f-6b66fa304bec"}},"facilitator":{"summary":"Update Facilitator","description":"Hello is used as the greeting","value":{"name":"Sourav1","email":"sourav_pratham@gmail.com","customFields":[{"fieldId":"6469c3ac-8c46-49d7-852a-00f9589737c5","value":["BR"]},{"fieldId":"b61edfc6-3787-4079-86d3-37262bf23a9e","value":["PAT"]},{"fieldId":"4aab68ae-8382-43aa-a45a-e9b239319857","value":["PS"]},{"fieldId":"57b50148-2b58-45e5-9b27-6a07c5317c18","value":"30"},{"fieldId":"a71fd390-fd67-45c3-ab1e-6994b8d967a2","value":"male"},{"fieldId":"cb407d11-f1c5-424c-a422-4755a1c4ab29","value":"facilitator"}]},"headers":{"academicYearId":"851687bb-422e-4a22-b27f-6b66fa304bec"}},"learner":{"summary":"Update Learner","description":"Hello is used as the greeting","value":{"name":"Debanjan","email":"debanjan@gmail.com","customFields":[{"fieldId":"6469c3ac-8c46-49d7-852a-00f9589737c5","value":["BR"]},{"fieldId":"b61edfc6-3787-4079-86d3-37262bf23a9e","value":["PAT"]},{"fieldId":"4aab68ae-8382-43aa-a45a-e9b239319857","value":["PS"]},{"fieldId":"3d23ef47-30b3-4fe4-833c-42f71be27e6b","value":"english"},{"fieldId":"90893edb-40ca-4ffb-a078-3e026016fb59","value":"21"},{"fieldId":"888aa61f-1f36-4b08-b361-8840c4213408","value":"male"}]},"headers":{"academicYearId":""}}}}}}} > </RequestSchema> diff --git a/docs/user-service/apis/user-controller-verify-otp.api.mdx b/docs/user-service/apis/user-controller-verify-otp.api.mdx new file mode 100644 index 0000000..d6e8507 --- /dev/null +++ b/docs/user-service/apis/user-controller-verify-otp.api.mdx @@ -0,0 +1,71 @@ +--- +id: user-controller-verify-otp +title: "Verify Otp" +description: "Verify Otp" +sidebar_label: "Verify Otp" +hide_title: true +hide_table_of_contents: true +api: eJxtk01z4jAMhv8Ko3NYyh5z67Z76OwBpsBeGGZHJIK4OLErK7RZJv99RzafXbgEy7Ze6X3kAzhPjGJc81JCDotA/OQaYWct8Z89sdl0E/GQgUfGmoQ4QL5cZcD03lKQH67sID/EpWEqIRduKYPCNUKN6BZ6b00RRUZvwTUaC0VFNeo/6TxBDm79RoWoDmtJYijobu3WxtLVuSBsmi30GTjxd+MVhuruBhMe1f/bagNxg/U9oT676m15KijJH8XOqa8SrTIQI1o6TMT/jkY+zyfQ9ylj8K4JqcfvDw/6KSkUbLzapJfm08EerSmjb4NZW1AIm9baLpYkuFUOEZhq3V5OcoMEriapnML1LkSDUSrIYaSljvbjUYI8TP0E4v0ZcaCiZSPdTGGlWrHQOobidnTtJHrzizrIwKh8RVgSQwbJUnhspXJs/sZWYvk6Bq+XAfr5ibVPmE/AT/4fOV+WCe9lfaJ6iVxgXhE2zcbFgo9QZpXZhQoHU4uycVzDVw+fXhfPg8fpC2SgjqTg+NsDpNnGQmdbe1Fba4xuHFVv7L/JejZM6FNG3qJp4vix1b1EZhkbUNlx0j7RWWVQKcJ8CYfDGgMt2Pa9ht9b4i4x2yMbXGuLy5U+hoQiXx5gR522ld7lcK516HHbJoBf3mi/upqc6WQ2hwzWx7deu1LvMH6o//gBOSin2GOckhg7gMVm2+JWz6ac+vsHaYmFcQ== +sidebar_class_name: "post api-method" +info_path: docs/user-service/apis/shiksha-platform +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={"Verify Otp"} +> +</Heading> + +<MethodEndpoint + method={"post"} + path={"/user/v1/verify-otp"} + context={"endpoint"} +> + +</MethodEndpoint> + + + +Verify Otp + +<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":{"mobile":{"type":"string"},"otp":{"type":"string"},"hash":{"type":"string"},"reason":{"type":"string"},"username":{"type":"string"}},"required":["mobile","otp","hash","reason","username"],"title":"OtpVerifyDTO"}}}}} +> + +</RequestSchema> + +<StatusCodes + id={undefined} + label={undefined} + responses={{"200":{"description":"OTP validation Sucessfully"}}} +> + +</StatusCodes> + + + \ No newline at end of file diff --git a/swagger/user-service.json b/swagger/user-service.json index 64d7139..a83f139 100644 --- a/swagger/user-service.json +++ b/swagger/user-service.json @@ -600,6 +600,7 @@ "responses": { "201": { "description": "User created successfully" }, "403": { "description": "User already exist." }, + "409": { "description": "Duplicate data." }, "500": { "description": "Internal Server Error" } }, "tags": ["User"] @@ -621,7 +622,7 @@ ], "requestBody": { "required": true, - "description": "Exampls are given for creating user with different roles and different cutom fields.", + "description": "Examples are given for creating user with different roles and different cutom fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUpdateDTO" }, @@ -887,14 +888,13 @@ } }, "responses": { "201": { "description": "User list." } }, - "tags": ["User"], - "security": [{ "access-token": [] }] + "tags": ["User"] } }, "/user/v1/password-reset-link": { "post": { "operationId": "UserController_sendPasswordResetLink", - "summary": "Passwort reset", + "summary": "Password reset", "parameters": [], "requestBody": { "required": true, @@ -952,6 +952,15 @@ "security": [{ "access-token": [] }] } }, + "/user/v1/check": { + "post": { + "operationId": "UserController_checkUser", + "summary": "Check User", + "parameters": [], + "responses": { "201": { "description": "" } }, + "tags": ["User"] + } + }, "/user/v1/delete/{userId}": { "delete": { "operationId": "UserController_deleteUserById", @@ -973,11 +982,72 @@ "security": [{ "access-token": [] }] } }, + "/user/v1/send-otp": { + "post": { + "operationId": "UserController_sendOtp", + "summary": "Send Otp", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/OtpSendDTO" } + } + } + }, + "responses": { "200": { "description": "OTP sent successfully" } }, + "tags": ["User"] + } + }, + "/user/v1/verify-otp": { + "post": { + "operationId": "UserController_verifyOtp", + "summary": "Verify Otp", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/OtpVerifyDTO" } + } + } + }, + "responses": { "200": { "description": "OTP validation Sucessfully" } }, + "tags": ["User"] + } + }, + "/user/v1/password-reset-otp": { + "post": { + "operationId": "UserController_sendPasswordResetOTP", + "summary": "Send Password Reset Otp", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SendPasswordResetOTPDto" + } + } + } + }, + "responses": { + "200": { "description": "Password reset link sent successfully." } + }, + "tags": ["User"] + } + }, "/user/v1/cohortmember/create": { "post": { "operationId": "CohortMembersController_createCohortMembers", "summary": "Create Cohort Member", "parameters": [ + { + "name": "userId", + "required": true, + "in": "query", + "schema": { "type": "string" } + }, { "name": "deviceid", "in": "header", @@ -1082,6 +1152,12 @@ "required": true, "in": "path", "schema": { "type": "string" } + }, + { + "name": "userId", + "required": true, + "in": "query", + "schema": { "type": "string" } } ], "requestBody": { @@ -1128,15 +1204,29 @@ }, "/user/v1/cohortmember/bulkCreate": { "post": { - "operationId": "CohortMembersController_craeteBulkCohortMembers", - "summary": "Bluk Cohort Member Create", + "operationId": "CohortMembersController_createBulkCohortMembers", + "summary": "Bulk Cohort Member Create", "parameters": [ + { + "name": "userId", + "required": true, + "in": "query", + "description": "userId required", + "example": "123e4567-e89b-12d3-a456-426614174000", + "schema": { "type": "string" } + }, { "name": "academicyearid", "in": "header", + "required": true, "schema": { "type": "string" } }, - { "name": "tenantid", "in": "header", "schema": { "type": "string" } } + { + "name": "tenantid", + "in": "header", + "required": true, + "schema": { "type": "string" } + } ], "requestBody": { "required": true, @@ -1151,8 +1241,7 @@ "description": "Cohort Member has been created successfully." } }, - "tags": ["Cohort Member"], - "security": [{ "access-token": [] }] + "tags": ["Cohort Member"] } }, "/user/v1/cohort/cohortHierarchy/{cohortId}": { @@ -1267,7 +1356,7 @@ }, { "name": "userId", - "required": false, + "required": true, "in": "query", "example": "123e4567-e89b-12d3-a456-426614174000", "schema": { "type": "string" } @@ -1303,7 +1392,7 @@ }, { "name": "userId", - "required": false, + "required": true, "in": "query", "example": "123e4567-e89b-12d3-a456-426614174000", "schema": { "type": "string" } @@ -1648,6 +1737,23 @@ "tags": ["Auth"] } }, + "/user/v1/auth/rbac/token": { + "get": { + "operationId": "AuthRbacController_signInRbac", + "parameters": [ + { + "name": "tenantid", + "in": "header", + "description": "Tenant Id", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { "200": { "description": "" } }, + "tags": ["AuthRbac"], + "security": [{ "access-token": [] }] + } + }, "/user/v1/form/read": { "get": { "operationId": "FormsController_getFormData", @@ -1704,9 +1810,29 @@ "summary": "Get Tenants", "parameters": [], "responses": { - "201": { "description": "Tenant Data Fetch" }, + "201": { "description": "Tenant search successfully" }, "403": { "description": "Forbidden" } - } + }, + "tags": ["Tenant"] + } + }, + "/user/v1/tenant/search": { + "post": { + "operationId": "TenantController_searchTenants", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/TenantSearchDTO" } + } + } + }, + "responses": { + "201": { "description": "Tenant search successfully" }, + "403": { "description": "Forbidden" } + }, + "tags": ["Tenant"] } }, "/user/v1/tenant/create": { @@ -1716,7 +1842,7 @@ "parameters": [ { "name": "userId", - "required": false, + "required": true, "in": "query", "schema": { "type": "string" } } @@ -1730,12 +1856,13 @@ } }, "responses": { - "201": { "description": "Tenant Created Successfully" }, + "201": { "description": "Tenant created successfully" }, "403": { "description": "Forbidden" } - } + }, + "tags": ["Tenant"] } }, - "/user/v1/tenant/update": { + "/user/v1/tenant/update/{id}": { "patch": { "operationId": "TenantController_updateTenants", "summary": "Update Tenants", @@ -1743,12 +1870,12 @@ { "name": "id", "required": true, - "in": "query", + "in": "path", "schema": { "type": "string" } }, { "name": "userId", - "required": false, + "required": true, "in": "query", "schema": { "type": "string" } } @@ -1764,7 +1891,8 @@ "responses": { "201": { "description": "Tenant Data Fetch" }, "403": { "description": "Forbidden" } - } + }, + "tags": ["Tenant"] } }, "/user/v1/tenant/delete": { @@ -1775,6 +1903,12 @@ { "name": "id", "required": true, + "in": "path", + "schema": { "type": "string" } + }, + { + "name": "userId", + "required": true, "in": "query", "schema": { "type": "string" } } @@ -1782,7 +1916,8 @@ "responses": { "201": { "description": "Tenant Data Fetch" }, "403": { "description": "Forbidden" } - } + }, + "tags": ["Tenant"] } }, "/user/v1/academicyears/create": { @@ -2099,7 +2234,8 @@ "tenantId": { "type": "string" }, "status": { "type": "string" }, "reason": { "type": "string" }, - "deviceId": { "type": "string" } + "deviceId": { "type": "string" }, + "action": { "type": "string", "enum": ["add", "remove"] } }, "required": [ "username", @@ -2151,7 +2287,17 @@ "block": { "type": "string", "description": "Block" }, "role": { "type": "string", "description": "Role" }, "username": { "type": "string", "description": "User Name" }, - "userId": { "type": "string", "description": "User Id" } + "userId": { "type": "string", "description": "User Id" }, + "email": { + "description": "email Ids", + "type": "array", + "items": { "type": "string" } + }, + "status": { + "description": "status", + "type": "array", + "items": { "type": "string" } + } } }, "tenantCohortRoleMappingDto": { @@ -2244,6 +2390,30 @@ }, "required": ["userName", "newPassword"] }, + "OtpSendDTO": { + "type": "object", + "properties": { + "mobile": { "type": "string" }, + "reason": { "type": "string" } + }, + "required": ["mobile", "reason"] + }, + "OtpVerifyDTO": { + "type": "object", + "properties": { + "mobile": { "type": "string" }, + "otp": { "type": "string" }, + "hash": { "type": "string" }, + "reason": { "type": "string" }, + "username": { "type": "string" } + }, + "required": ["mobile", "otp", "hash", "reason", "username"] + }, + "SendPasswordResetOTPDto": { + "type": "object", + "properties": { "username": { "type": "string", "example": "John" } }, + "required": ["username"] + }, "CohortMembersDto": { "type": "object", "properties": { @@ -2357,7 +2527,27 @@ "customFields" ] }, - "BulkCohortMember": { "type": "object", "properties": {} }, + "BulkCohortMember": { + "type": "object", + "properties": { + "userId": { + "description": "The userIds of the cohort members", + "type": "array", + "items": { "type": "string" } + }, + "cohortId": { + "description": "The cohortIds of the cohort members", + "type": "array", + "items": { "type": "string" } + }, + "removeCohortId": { + "description": "The cohortIds to be removed from", + "type": "array", + "items": { "type": "string" } + } + }, + "required": ["userId", "cohortId", "removeCohortId"] + }, "CohortCreateDto": { "type": "object", "properties": { @@ -2743,58 +2933,84 @@ }, "required": ["title", "context", "contextType", "fields"] }, - "TenantCreateDto": { + "TenantFilters": { "type": "object", "properties": { - "name": { + "tenantId": { "type": "string", - "description": "Tenant name", - "default": "" + "description": "Tenant Id must be a (UUID)" + }, + "name": { "type": "string" }, + "domain": { "type": "string" }, + "status": { + "type": "array", + "description": "Status of the tenant", + "default": ["published"], + "items": { + "type": "string", + "enum": ["published", "draft", "archived"] + } }, - "domain": { + "createdBy": { "type": "string", - "description": "Domain Name", - "default": "" + "description": "The ID of the creator (UUID)" }, - "params": { - "type": "object", - "description": "Params", - "default": "" + "updatedBy": { + "type": "string", + "description": "The ID of the updater (UUID)" }, - "programImages": { - "description": "List of program images (URLs or other related strings)", - "type": "array", - "items": { "type": "string" } - } - }, - "required": ["name"] + "programHead": { "type": "string" } + } }, - "TenantUpdateDto": { + "TenantSearchDTO": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Tenant name", - "default": "" - }, - "domain": { - "type": "string", - "description": "Domain Name", - "default": "" + "limit": { + "type": "number", + "description": "Limit", + "minimum": 1, + "maximum": 200, + "default": 10 }, - "params": { - "type": "object", - "description": "Params", - "default": "" + "offset": { + "type": "number", + "description": "Offset", + "minimum": 0, + "maximum": 200, + "default": 0 }, - "programImages": { "type": "string" }, + "filters": { "$ref": "#/components/schemas/TenantFilters" } + }, + "required": ["limit", "offset"] + }, + "TenantCreateDto": { + "type": "object", + "properties": { + "name": { "type": "string" }, + "domain": { "type": "string" }, + "params": { "type": "object" }, + "programImages": { "type": "array", "items": { "type": "string" } }, + "description": { "type": "string" }, + "programHead": { "type": "string" } + }, + "required": ["name", "description", "programHead"] + }, + "TenantUpdateDto": { + "type": "object", + "properties": { + "name": { "type": "string" }, + "domain": { "type": "string" }, + "params": { "type": "object" }, + "programImages": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "status": { "type": "string", "description": "Status of the tenant", - "enum": ["active", "inactive", "archive"], - "default": "active" - } + "enum": ["published", "draft", "archived"], + "default": "published" + }, + "createdBy": { "type": "string" }, + "programHead": { "type": "string" } } }, "AcademicYearDto": {