API Documentation

[bcoov]

29 is a good start to understanding how to use the API, but more detailed API documentation is sorely needed. Specifically what values/fields are required (if any) when performing operations to the various endpoints.

[sfitzpa4]

What operations are you trying to do on these endpoints, an example perhaps?

[sfitzpa4]

Here's an updated Endpoints Doc API.Endpoints.docx

[bcoov]

I was hoping for something resembling typical API documentation (The GitHub API docs are a good example)

So for authenticating, I'd expect something like this:

Authentication

To authenticate a user, perform a POST to the /users/token/ endpoint.

• Required Headers
  • "Content-Type": "application/x-www-form-urlencoded"
• Required parameters (where format is: "param1=value1&param2=value2&...")
  • "username": username for the user to authenticate
  • "password": that user's password

The reply to this operation will include a "success" element indicating "true" or "false on whether the authentication succeeded. If it did, there will also be a "token" element, whose value is the authentication token to be passed with future HTTP operations to indicate an authenticated operation.

[sfitzpa4]

API Documentation is found in the Dev branch here