Skip to content

trendify-app/trendify-heimdall

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

49 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Heimdall

Heimdall serves as a platform for creating, and joining socket namespaces.

API | /api

All API requests require request body including the following... (potentially out of date, read source!)

{
  token: <access_token>
}
  • GET | /sessions

    • Description
      • List of sessions available to join
  • GET | /sessions/:id

    • Description
      • Information about a particular session
    • Returns
      • 401 - Failed to authenticate
      • 200 - Success
  • DELETE | /sessions/:id

    • Description
      • Delete a session
    • Returns
      • 401 - Failed to authenticate
      • 200 - Success
  • POST | /sessions/create

    • Description
      • Creates a session
    • Body
      {
        ...configurableOptions
      }
      
    • Returns
      • 401 - Failed to authenticate
      • 200 - Success
        • { room_id }
  • PUT | /sessions/join/:id

    • Description
      • Join a session
    • Returns
      • 401 - Failed to authenticate
      • 200 - Success
        {
          id:
          access_pass,
          creator_id
        }
        

Releases

No releases published

Packages

No packages published