@@ -22,6 +22,10 @@ Requests should be of the form:
...
@@ -22,6 +22,10 @@ Requests should be of the form:
### Request API Definitions
### Request API Definitions
*`command` : the command to issue to the server. The following commands are allowed:
*`command` : the command to issue to the server. The following commands are allowed:
* User-level Commands
*`login` - log in with the given credentials
*`user_info` - get the user information for the given user
* Constellation Management Commands
*`edit` - Edit a constellation. Read the constellation `"id"` from the given constellation object
*`edit` - Edit a constellation. Read the constellation `"id"` from the given constellation object
and return all pieces of the constellation object to the client for editing. Sets the state
and return all pieces of the constellation object to the client for editing. Sets the state
of the server to note that this user is editing this constellation.
of the server to note that this user is editing this constellation.
...
@@ -31,8 +35,6 @@ Requests should be of the form:
...
@@ -31,8 +35,6 @@ Requests should be of the form:
object and make the requested changes to the constellation.
object and make the requested changes to the constellation.
*`search` - Return a list of constellations matching the given constellation. Read all the data available
*`search` - Return a list of constellations matching the given constellation. Read all the data available
in the given constellation object and return a list of constellations that match (or are similar)
in the given constellation object and return a list of constellations that match (or are similar)
*`login` - log in with the given credentials
*`user_info` - get the user information for the given user
*`user` : the current user's information
*`user` : the current user's information
*`token` : the current session token
*`token` : the current session token
*`constellation` : all available parts of the constellation to enact the command over. If the interaction does not utilize a constellation, this may be omitted. The full specification for the constellation structure may be viewed [here]().
*`constellation` : all available parts of the constellation to enact the command over. If the interaction does not utilize a constellation, this may be omitted. The full specification for the constellation structure may be viewed [here]().