-
Notifications
You must be signed in to change notification settings - Fork 0
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
adi-lux
wants to merge
9
commits into
main
Choose a base branch
from
zotmeet-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
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
Signed-off-by: Adithya Anandsaikrishnan <anandsaikrishnan.adithya@gmail.com>
Signed-off-by: Adithya Anandsaikrishnan <anandsaikrishnan.adithya@gmail.com>
Signed-off-by: Adithya Anandsaikrishnan <anandsaikrishnan.adithya@gmail.com>
Signed-off-by: Adithya Anandsaikrishnan <anandsaikrishnan.adithya@gmail.com>
Signed-off-by: Adithya Anandsaikrishnan <anandsaikrishnan.adithya@gmail.com>
Signed-off-by: Adithya Anandsaikrishnan <anandsaikrishnan.adithya@gmail.com>
Signed-off-by: Adithya Anandsaikrishnan <anandsaikrishnan.adithya@gmail.com>
Signed-off-by: Adithya Anandsaikrishnan <anandsaikrishnan.adithya@gmail.com>
Signed-off-by: Adithya Anandsaikrishnan <anandsaikrishnan.adithya@gmail.com>
MinhxNguyen7
requested changes
Mar 14, 2024
There was a problem hiding this 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 takehost_id
andgroup_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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Transferred necessary information to documentation homepage.
Additionally, set up ZotMeet API Documentation within the Project route.
Also closes icssc/ZotMeet#70, once merged