search

CS3219-AY2324S1 / ay2324s1-course-assessment-g11

ay2324s1-course-assessment-g11 created by GitHub Classroom
MIT License
3 stars 2 forks source link

Collaboration Service #44

Closed gycgabriel closed 1 year ago

gycgabriel commented 1 year ago

REST APIs: /rooms/join: Join an existing room using a token. Method: POST

/rooms/save Save text. Method: POST

/rooms/:roomId: Retrieve the status or metadata of a specific room. Method: GET

WebSocket Endpoints: localhost:5001 “/room/join", (room_id: string, user_id: string) "/room/update", (text: string) "/room/save", (text: string) "/room/load", ()

Readme: https://github.com/CS3219-AY2324S1/ay2324s1-course-assessment-g11/tree/collaboration-ts-migrate/services/collaboration-service#readme

gycgabriel commented 1 year ago

Any comments on API design, does it make sense?

ong6 commented 1 year ago

Any comments on API design, does it make sense?

I think overall it looks good, but how does a room get created (is it via load?)

gycgabriel commented 1 year ago

Any comments on API design, does it make sense?

I think overall it looks good, but how does a room get created (is it via load?)

From the join api

As long as both users (or more) join the same room_id, which can be a unique concatenation of both user_id or some output from matching service

Load and Save are some extra features I thought of, one-slot saves the text and loads the text