Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ZotMeet Getting Started + API Specification #13

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Conversation

adi-lux
Copy link

@adi-lux adi-lux commented Mar 13, 2024

Description

Transferred necessary information to documentation homepage.
Additionally, set up ZotMeet API Documentation within the Project route.
Also closes icssc/ZotMeet#70, once merged

adi-lux and others added 9 commits March 11, 2024 19:20
Signed-off-by: Adithya Anandsaikrishnan <[email protected]>
Signed-off-by: Adithya Anandsaikrishnan <[email protected]>
Signed-off-by: Adithya Anandsaikrishnan <[email protected]>
Signed-off-by: Adithya Anandsaikrishnan <[email protected]>
Signed-off-by: Adithya Anandsaikrishnan <[email protected]>
Signed-off-by: Adithya Anandsaikrishnan <[email protected]>
Signed-off-by: Adithya Anandsaikrishnan <[email protected]>
@adi-lux adi-lux added the documentation Improvements or additions to documentation label Mar 13, 2024
@adi-lux adi-lux requested a review from MinhxNguyen7 March 13, 2024 11:49
@adi-lux adi-lux self-assigned this Mar 13, 2024
@adi-lux adi-lux requested a review from a team as a code owner March 13, 2024 11:49
@adi-lux adi-lux linked an issue Mar 13, 2024 that may be closed by this pull request
Copy link
Member

@MinhxNguyen7 MinhxNguyen7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Generally speaking, there are some unnecessary enpoints. I think that you modeled every operation every major entity, which is way too many.
  • Also, this seems to imply that we'll have a public API, which we definitely won't. This should, then, be a specification of the interface of form actions we define in server.ts files. You just need to indicate that more clearly.
  • GET /users doesn't seem to be necessary.
  • GET /meetings should only take host_id and group_id. I don't think we should be looking for meetings any other way.
  • What's a meeting's "shared-availability"? If that's everyone's availabilities, then it should just be /meetings/{id}/availabilities, I'd say.
  • GET /groups does not seem necessary.

@alexanderl19 alexanderl19 added the docs:addition New documentation needed label May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs:addition New documentation needed documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ZotMeet Getting Started Docs Write an API Specification
3 participants