htm-community / hitc

HTM In The Cloud
GNU Affero General Public License v3.0
7 stars 7 forks source link

Updated README.md - clarified REST API urls #32

Closed ghost closed 8 years ago

ghost commented 8 years ago

I was a bit confused how to create a model. It turn out that "base" url had to be /models.

JonnoFTW commented 8 years ago

The documentation isn't correct because I updated the API after I wrote it. If you read the source code, it should be like this:

/models

POST: creates a model GET: list all models

/models/{guid}

PUT: run a list of data through the model DELETE: delete the model GET: get model information

/models/reset/{guid}

GET: reset the model

Note that models/run/{guid} isn't used any more.

rhyolight commented 8 years ago

@JonnoFTW If you approve of this PR, give it a :+1: and press the merge button. Also, if /models/run/{guid} isn't used anymore, we should remove it.