Home - nonduality345/Convos GitHub Wiki

Welcome to the Convos wiki!

Please use the links to the right to navigate the information on these pages.

The API endpoints are as follows:

/api/Convo

/api/Convo/{convoId}

/api/Convo/{convoId}/Message

/api/Convo/{convoId}/Message/{messageId}

The slashes in the paths above do not output in the links to the right, so to see information for the endpoint

/api/Convo/{convoId}/Message

Please use the link labeled as

api Convo {convoId} Message

Just a note on assumptions:

  • Every Convo only occurs between two users and only two users. For possible expansion, this could be opened up to have conversations among multiple users. Please see the section on possible improvements.

  • Deleting a Convo deletes the Convo for both users in the conversation. Please see the section on possible improvements for more information on how I would change this.

  • For authorization, in the future, an authorization framework like OAuth would be utilized to identify the calling client. For the purposes of this small example I am only passing in the user Id as a field in the header named X-Authorization. In a real world application, I would use an OAuth service to obtain an access token for the resources the user has access to and place it in this header, but for illustrative purposes, this header is only containing the user's id.