-
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.
Event service Api documentation (#24)
* chore : docusauras api setup * Rename notification.json to notification-service.json * Update docusaurus.config.ts * fix: resolved package errors * feat : added event service apis * chore : removed wrong file * chore : added updated file * chore : formatted code * chore : resolved comments --------- Co-authored-by: Manoj L <[email protected]>
- Loading branch information
1 parent
149df69
commit 309092b
Showing
6 changed files
with
1,389 additions
and
1 deletion.
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: event-controller-create | ||
| title: "Create Events" | ||
| description: "Create Events" | ||
| sidebar_label: "Create Events" | ||
| hide_title: true | ||
| hide_table_of_contents: true | ||
| api: eJztW/9P4zgW/1ci/3QrJTRJv1AqnU6zlF2hGwYOmB3dVOjkJk7xTGJ3badMr5f//WQ7SZ0vpSmwO8wKhBDU7z0/2+/zvpjnDaBLxKDAlJyHYALOVoiIU0oEo3GM2H8ChqBAwAZLyGCCBGIcTGYbQGCCwASkHLHzENiAod9TzFAIJoKlyAaYgAn4PUVsDWwQIh4wvJSTgAn4qHis64LDBjy4RwkEkw1A32CyjKVkz++jwXB07KDxydzx/LDvwMFw5Az80cgbeMcD13VBlt3pqREXP9NwLUXUNQkoEYgIOQSXyxgHarG9L1wqszHmFuulnJjOv6BAyBUzuTUCI65GsZB6lWRcMEwWjcVpMttYyI36xVIbCzIb8HvKxNRk2ifzRnJYJosp//YecwtzC1pcz4SKmcJDJtkl/j1lKLHwkqeJFdKYMotjYUlTsK2AEo4CgUTKLBjiJeYBJgsLxVgcSQWUJrdq2ub0iKQJmMwAJTEmcstoFKnf7uqqqa2zlBxTs5wxswHm10jKDYQ89n0rrVAbAqW5ZDaAqaBnRJr/flEGbVMQF5CJKRRI4KSD5dxIcqukN1fqu/7AcfuON7713Ikrv9X2krC7+DMSHiQ8phoo+yW/LyhNqfrMyiElkCywSENTV5Imc8SaEqHQlIZEb3w0dMf9wdDrD8bj0cnJQMosCF9OpLaqK0ZXOERs/+ovFb1VMpib8JnSRNvnBUICk8UH9GBInFMaI0haDNQgN+RFMObSsBI9OkUC4lg5p1aVciFWQWdI2oCUxWAC7oVY8kmvlw8cBTTp5dKBDbAMCPmfDg7lSmAcX0YqADzuLXEHHBb6nU9N1U4G/ok/8o4zW+vYVYokNvf+saVlMpxx/kDZAWqWHDZ4YFigSxKvS6wv8+P/FREZTbu4oSaLpIhgGoviqDMzrs7kpupNMdRvm/rOLqJVoXxuAlNBQXYnLQh+eycEIiHKg9uj2LmA36wtuQkg15U20SKpNIuqpFYpM4CiyHXHcOz4w+O+MxiNQmc+Pj52ojCMRnAQBV5fAfckQoE7hE44gnNnMJgjZx7BgYMgQpGPonGETsCd2rSAshCTRQeVrre0HQFSSgeZ9vIi5Z3cu6QzTTTGKx2+QgTj205efEtqHoPvqkUvMBc6lbspQs9+ie1sHQKEyXimI9FhsxVMHeaSITtImRLZKb4XxM2ozNQYIgG6kobLSNN/NkkqlhGphJMEazABIcSxzHAxEYitYAwm3gFe0pC0Oz8qpnhA6Gu8bmZHv5RCzI3UXJmp2T6YnxeUpmkZPkmuLIRrfhl9Quhrc9umcM0tGllq1MS3Z/ftoXRKenrIGFR7JlDSApxMZzanlIS4SECaqcx2uHI2uShUmtYKxukOw/p8SEATO7LYqmYyR5VbgEgok+OmhqVmWanaPpm/SbLHhbYtzvqfNQT1CCJ0Dq1nNsLEmbnf2V2dLTJMDG+txDCG2pEZoq/rYNoGISTgFIrW2qutAJD0VigZzLWrRJhddJZ1UUixIsosVngKXTXxmuj69uXFXaOEq05iFj52vdyolAzVEqGa0RspuJk8G0lvI1m166ljLVOsBX4zdFeCZhnV7ErA2RUq2p161Q23+dTSAConaNjOqbp8UKevrKY8HAXJUrzOd6fS4/28NkIRT5MEMummzzSbOvLH2Zplsdw6FFroABFbZOcLye8A2sjzi4G2e4FdpX2zAHtiiV6p0LeFeLWc1rcoZlWsP6mVt9oJeX7Vw9aK1AqRtyWqF126cqoXTiopbit/qrnafylNjlLe+9I7OfFdbzgeDd3hP5YP4d8/vxun6OtI/Dt13//r9mr+yf91cX55vfwwTVbHX3ZUPNvsdnZXTy1bJq5liNsEUad7tVxGb2VrTrInzWgGycdjn+c7/tDY9DIVwmRhpIs7A6XprQMqbVXdF/Z9bzyf94cOHB+HzgCGkTPvu0Nn7rtDfzyKUN93Gy46k461HUSXQbEV/FAIm6zPgHFVTCcoGyxvcH6D84vCmbaZI/Dd1wRgfXF7eABu5TsQujtk7MRtG/0rAm1+B/49ULu98QX/pOKepSH4AfHy44W/ikVuQ8nBADJYn4OhiphuMNqyvCHpr4OkHyHyqETjk7oZO7z0q/M9JWlsyng8Y6zRvyK8vKWLz0sXd/yL4GVwm1/+1oBr3sbO9B3rHxgV66dbRfYhQH1KkdfG+xzAHlLmtfC8AfcNuH8GcJ8WhJ8FVZ04PSGotjM+KRftHlZfDw5/4ITzVUPgu8euqkk+pUJr4X0WLDrVaG/I+Ksj408LDh8oqZvibuNvI+5k7e2Mb+b96sy7zOgOsBpygNGQJ9oM2WMyTeJXZEVvafz3SOM7mXKW6U4QvpTnqeb2Xa+lMUn1qegnE6HF0yBAnEdprDuxBq7bZDknKxjj0MofMVhz+Yohs8GwnVhGERhbN4itELPOGKNMdakIKLdklndM5FbdaBUzR7luwLinctOXlKuWJyjuwQT0lF06HLEVDpD+q7fyeuVbEK6mz89EPqS43j7BODOasV6rw34BqNV6FFuR1qAxvHWtP77SHt/sSzc73dtGXxTBnZvBq13EnutW8fqybb0vBf5tr63nuzu7ZnccYGvP6w7aF7qer2RnoNoqpbvfMImoCTdtWheQwAVK2mB0ev1xar27OpeREjGuP/SOpNLysRQMhHJ7tnILCVRa5u+96h6k/YmRQN9EbxlDrB5+5G382rnMQMW5FMiUqnhyfu1i7mxwL13SZAY2mznk6COLs0x+rJ+UyX7NEHM4jyVwc7uu6VK++wJ/K56a/WQ13561qvwVrc3HbUVmDeRzsxVkWE4svV9mg3sEFeRmm5zrVM/r3Jq9lpPm2zMpq3TAV5c3t8AG8/wNW0Il0gGDsolP/lQnT9XalPWrzzYghmSRwoWk1TLl1/8BNfvsxw== | ||
| sidebar_class_name: "post api-method" | ||
| info_path: docs/event-service/apis/event-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 Events"} | ||
| > | ||
| </Heading> | ||
|
|
||
| <MethodEndpoint | ||
| method={"post"} | ||
| path={"/event-service/event/v1/create"} | ||
| context={"endpoint"} | ||
| > | ||
|
|
||
| </MethodEndpoint> | ||
|
|
||
|
|
||
|
|
||
| Create Events | ||
|
|
||
| <Heading | ||
| id={"request"} | ||
| as={"h2"} | ||
| className={"openapi-tabs__heading"} | ||
| children={"Request"} | ||
| > | ||
| </Heading> | ||
|
|
||
| <ParamsDetails | ||
| parameters={[{"name":"userId","required":true,"in":"query","description":"UserId Required","schema":{"example":"123e4567-e89b-12d3-a456-426614174000"}}]} | ||
| > | ||
|
|
||
| </ParamsDetails> | ||
|
|
||
| <RequestSchema | ||
| title={"Body"} | ||
| body={{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","description":"title","example":"Sample Event"},"shortDescription":{"type":"string","description":"Short Description","example":"This is a sample event"},"description":{"type":"string","description":"Description","example":"Lorem ipsum dolor sit amet, consectetur adipiscing elit."},"eventType":{"type":"string","enum":["online","offline"],"description":"Event Type","example":"online"},"isRestricted":{"type":"string","description":"isRestricted","example":true},"autoEnroll":{"type":"string","description":"autoEnroll","example":true},"startDatetime":{"type":"string","description":"Start Datetime","example":"2024-03-18T10:00:00"},"endDatetime":{"type":"string","description":"End Datetime","example":"2024-03-18T10:00:00"},"location":{"type":"string","description":"Location","example":"Event Location"},"longitude":{"type":"number","description":"Latitude","example":18.508345134886994},"latitude":{"type":"number","description":"Latitude","example":18.508345134886994},"onlineProvider":{"type":"string","description":"Online Provider","example":"Zoom"},"isMeetingNew":{"type":"boolean","description":"isMeetingNew","example":false},"meetingDetails":{"description":"Online Meeting Details","example":{"url":"https://example.com/meeting","id":"meeting-id"},"allOf":[{"type":"object","properties":{"id":{"type":"string","description":"Meeting ID","example":94292617},"url":{"type":"string","description":"Meeting url","example":"https://example.com/meeting"},"password":{"type":"string","description":"Meeting password","writeOnly":true},"providerGenerated":{"type":"string","description":"providerGenerated","default":false}},"required":["id","url","password","providerGenerated"],"title":"MeetingDetailsDto"}]},"maxAttendees":{"type":"number","description":"Max Attendees","example":100},"attendees":{"type":"object","description":"Attendees","example":["eff008a8-2573-466d-b877-fddf6a4fc13e","e9fec05a-d6ab-44be-bfa4-eaeef2ef8fe9"]},"recordings":{"type":"object","description":"Recordings","example":{"url":"https://example.com/recording"}},"status":{"type":"string","description":"Status","example":"live"},"idealTime":{"type":"string","description":"idealTime","example":120},"registrationStartDate":{"type":"string","description":"registrationStartDate","example":"2024-03-18T10:00:00"},"registrationEndDate":{"type":"string","description":"registrationEndDate","example":"2024-03-18T10:00:00"},"isRecurring":{"type":"string","description":"isRecurring","example":true},"recurrencePattern":{"description":"recurrencePattern","example":{"frequency":"daily","interval":1},"allOf":[{"type":"object","properties":{"frequency":{"type":"string","enum":["daily","weekly"],"description":"Frequency","example":"daily"},"interval":{"type":"number","description":"Interval","example":1,"default":1},"daysOfWeek":{"description":"Days of Week","example":[1,3,5],"type":"array","items":{"type":"string"}},"endCondition":{"description":"End Condition","example":{"type":"endDate","value":"2024-03-18T10:00:00Z"},"allOf":[{"type":"object","properties":{"type":{"type":"string","description":"Type of end condition","example":"endDate"},"value":{"type":"string","description":"Value of end condition","example":"2024-03-18T10:00:00Z | 5"}},"required":["type","value"],"title":"EndCondition"}]}},"required":["frequency","interval","daysOfWeek","endCondition"],"title":"RecurrencePatternDto"}]},"metaData":{"type":"object","description":"Event meta data","example":""},"erMetaData":{"type":"object","description":"Meta data for recurring events","example":""}},"required":["title","shortDescription","description","eventType","isRestricted","autoEnroll","startDatetime","endDatetime","location","longitude","latitude","onlineProvider","isMeetingNew","meetingDetails","maxAttendees","attendees","recordings","status","idealTime","registrationStartDate","registrationEndDate","isRecurring","recurrencePattern","metaData","erMetaData"],"title":"CreateEventDto"},"examples":{"RecurringOnlineDailyByEndDate":{"summary":"Example for RecurringOnlineDailyByEndDate","description":"Detailed example for RecurringOnlineDailyByEndDate","value":{"title":"Sample OnlineDailyByEndDate Event","shortDescription":"This is a sample event","description":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.","eventType":"online","isRestricted":true,"autoEnroll":true,"startDatetime":"2024-12-18T10:00:00Z","endDatetime":"2024-12-18T11:00:00Z","onlineProvider":"Zoom","isMeetingNew":false,"meetingDetails":{"url":"https://zoom.us/j/99201586505?pwd=ZA8uek6tYu0LQTPbW2GgIORpNDmv7j","id":"meeting-id"},"attendees":[],"recordings":{"url":"https://zoom.com/recording"},"status":"live","isRecurring":true,"recurrencePattern":{"frequency":"daily","interval":1,"endCondition":{"type":"endDate","value":"2024-12-25T11:00:00Z"},"recurringStartDate":"2024-03-18T10:00:00Z"},"metaData":{"cohortId":"3218bb35-a87d-4adf-b305-b205286fe320"},"erMetaData":{}}},"RecurringOnlineDailyByOccurrences":{"summary":"Example for RecurringOnlineDailyByOccurrences","description":"Detailed example for RecurringOnlineDailyByOccurrences","value":{"title":"Sample OnlineDailyByOccurrences Event","shortDescription":"This is a sample event","description":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.","eventType":"online","isRestricted":true,"autoEnroll":true,"startDatetime":"2024-12-18T10:00:00Z","endDatetime":"2024-12-18T11:00:00Z","onlineProvider":"Zoom","isMeetingNew":false,"meetingDetails":{"url":"https://zoom.us/j/99201586505?pwd=ZA8uek6tYu0LQTPbW2GgIORpNDmv7j","id":"meeting-id"},"attendees":[],"recordings":{"url":"https://zoom.com/recording"},"status":"live","isRecurring":true,"recurrencePattern":{"frequency":"daily","interval":1,"endCondition":{"type":"occurrences","value":"20"},"recurringStartDate":"2024-03-18T10:00:00Z"},"metaData":{"cohortId":"3218bb35-a87d-4adf-b305-b205286fe320"},"erMetaData":{}}},"RecurringOfflineDailyByEndDate":{"summary":"Example for RecurringOfflineDailyByEndDate","description":"Detailed example for RecurringOfflineDailyByEndDate","value":{"title":"Sample OfflineDailyByEndDate Event","shortDescription":"This is a sample event","description":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.","eventType":"offline","isRestricted":true,"autoEnroll":true,"startDatetime":"2024-12-18T10:00:00Z","endDatetime":"2024-12-18T11:00:00Z","location":"Kothrud","attendees":[],"recordings":{"url":"https://zoom.com/recording"},"status":"live","isRecurring":true,"recurrencePattern":{"frequency":"daily","interval":1,"endCondition":{"type":"endDate","value":"2024-12-25T11:00:00Z"},"recurringStartDate":"2024-03-18T10:00:00Z"},"metaData":{"cohortId":"3218bb35-a87d-4adf-b305-b205286fe320"},"erMetaData":{}}},"RecurringOfflineDailyByOccurrence":{"summary":"Example for RecurringOfflineDailyByOccurrence","description":"Detailed example for RecurringOfflineDailyByOccurrence","value":{"title":"Sample OfflineDailyByOccurrence Event","shortDescription":"This is a sample event","description":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.","eventType":"offline","isRestricted":true,"autoEnroll":true,"startDatetime":"2024-12-18T10:00:00Z","endDatetime":"2024-12-18T11:00:00Z","location":"Kothrud","attendees":[],"recordings":{"url":"https://zoom.com/recording"},"status":"live","isRecurring":true,"recurrencePattern":{"frequency":"daily","interval":1,"endCondition":{"type":"occurrences","value":"20"},"recurringStartDate":"2024-03-18T10:00:00Z"},"metaData":{"cohortId":"3218bb35-a87d-4adf-b305-b205286fe320"},"erMetaData":{}}},"RecurringOnlineWeeklyByEndDate":{"summary":"Example for RecurringOnlineWeeklyByEndDate","description":"Detailed example for RecurringOnlineWeeklyByEndDate","value":{"title":"Sample OnlineWeeklyByEndDate Event","shortDescription":"This is a sample event","description":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.","eventType":"online","isRestricted":true,"autoEnroll":true,"startDatetime":"2024-12-18T10:00:00Z","endDatetime":"2024-12-18T11:00:00Z","onlineProvider":"Zoom","isMeetingNew":false,"meetingDetails":{"url":"https://zoom.us/j/99201586505?pwd=ZA8uek6tYu0LQTPbW2GgIORpNDmv7j","id":"meeting-id"},"attendees":[],"recordings":{"url":"https://example.com/recording"},"status":"live","isRecurring":true,"recurrencePattern":{"frequency":"weekly","interval":1,"daysOfWeek":[3,5],"endCondition":{"type":"endDate","value":"2024-12-25T11:00:00Z"},"recurringStartDate":"2024-12-18T10:00:00Z"},"metaData":{},"erMetaData":{}}},"RecurringOnlineWeeklyByOccurrences":{"summary":"Example for RecurringOnlineWeeklyByOccurrences","description":"Detailed example for RecurringOnlineWeeklyByOccurrences","value":{"title":"Sample OnlineWeeklyByOccurrences Event","shortDescription":"This is a sample event","description":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.","eventType":"online","isRestricted":true,"autoEnroll":true,"startDatetime":"2024-12-18T10:00:00Z","endDatetime":"2024-12-18T11:00:00Z","onlineProvider":"Zoom","isMeetingNew":false,"meetingDetails":{"url":"https://zoom.us/j/99201586505?pwd=ZA8uek6tYu0LQTPbW2GgIORpNDmv7j","id":"meeting-id"},"attendees":[],"recordings":{"url":"https://example.com/recording"},"status":"live","isRecurring":true,"recurrencePattern":{"frequency":"weekly","interval":1,"daysOfWeek":[3,5],"endCondition":{"type":"occurrences","value":"20"},"recurringStartDate":"2024-12-18T10:00:00Z"},"metaData":{},"erMetaData":{}}},"RecurringOfflineWeeklyByEndDate":{"summary":"Example for RecurringOfflineWeeklyByEndDate","description":"Detailed example for RecurringOfflineWeeklyByEndDate","value":{"title":"Sample Event","shortDescription":"This is a sample event","description":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.","eventType":"offline","isRestricted":true,"autoEnroll":true,"startDatetime":"2024-12-18T10:00:00Z","endDatetime":"2024-12-18T11:00:00Z","location":"Kothrud","attendees":[],"recordings":{"url":"https://example.com/recording"},"status":"live","isRecurring":true,"recurrencePattern":{"frequency":"weekly","interval":1,"daysOfWeek":[3,5],"endCondition":{"type":"endDate","value":"2024-12-25T11:00:00Z"},"recurringStartDate":"2024-12-18T10:00:00Z"},"metaData":{},"erMetaData":{}}},"RecurringOfflineWeeklyByOccurrence":{"summary":"Example for RecurringOfflineWeeklyByOccurrence","description":"Detailed example for RecurringOfflineWeeklyByOccurrence","value":{"title":"Sample Event","shortDescription":"This is a sample event","description":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.","eventType":"offline","isRestricted":true,"autoEnroll":true,"startDatetime":"2024-12-18T10:00:00Z","endDatetime":"2024-12-18T11:00:00Z","location":"Kothrud","attendees":[],"recordings":{"url":"https://example.com/recording"},"status":"live","isRecurring":true,"recurrencePattern":{"frequency":"weekly","interval":1,"daysOfWeek":[3,5],"endCondition":{"type":"occurrences","value":"20"},"recurringStartDate":"2024-12-18T10:00:00Z"},"metaData":{},"erMetaData":{}}},"NonRecurringOffline":{"summary":"Example for NonRecurringOffline","description":"Detailed example for NonRecurringOffline","value":{"title":"Sample Event","shortDescription":"This is a sample event","description":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.","eventType":"offline","isRestricted":true,"autoEnroll":true,"startDatetime":"2024-12-18T10:00:00Z","endDatetime":"2024-12-18T11:00:00Z","location":"Kothrud","attendees":[],"recordings":{"url":"https://example.com/recording"},"status":"live","isRecurring":false,"metaData":{},"erMetaData":{}}},"NonRecurringOnline":{"summary":"Example for NonRecurringOnline","description":"Detailed example for NonRecurringOnline","value":{"title":"Sample NonRecurringOnline Event","shortDescription":"This is a sample event","description":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.","eventType":"online","isRestricted":true,"autoEnroll":true,"startDatetime":"2024-12-18T10:00:00Z","endDatetime":"2024-12-18T11:00:00Z","onlineProvider":"Zoom","isMeetingNew":false,"meetingDetails":{"url":"https://zoom.us/j/99201586505?pwd=ZA8uek6tYu0LQTPbW2GgIORpNDmv7j","id":"meeting-id"},"attendees":[],"recordings":{"url":"https://example.com/recording"},"status":"live","isRecurring":false,"metaData":{},"erMetaData":{}}}}}}}} | ||
| > | ||
|
|
||
| </RequestSchema> | ||
|
|
||
| <StatusCodes | ||
| id={undefined} | ||
| label={undefined} | ||
| responses={{"201":{"description":"Event created successfully"},"400":{"description":"Invalid request body"},"500":{"description":"Internal Server Error"}}} | ||
| > | ||
|
|
||
| </StatusCodes> | ||
|
|
||
|
|
||
|
|
Oops, something went wrong.