Thanks for the great module. I've been running through setting this up on and off over the past month or so, and noticed a few places where you could improve the documentation to make the learning curve less steep:

  1. Homepage: Point 1 - it would be good to add something showing how the scheme/host/path/username/password translate into the request URL - something like: [scheme]://[username]:[password]@[host][path]
  2. Homepage: Point 1 - looks to me like the $path variable has to include a leading slash
  3. Homepage: Point 1 - it would be good to show how you can add custom headers if you need to: in ___construct by modifying $this->headers
  4. Homepage: Point 2 - the syntax you use in Toggl module is cleaner, imho - using $schemas['foobar'] = (Object) array (...);
  5. Homepage: Point 3, part 1 - the naming scheme for the invoking functions is actually [schemaname]_rest_api_[resource]_[action] - but from the existing docs it looks like just [modulename]_[resource]_[action]

Hope that helps someone.

Thanks, David

Comments

Bevan’s picture

Bevan commented

Thanks David! This is great feedback. Patches are welcome. I can give you access to edit the project if you like.

dbassendine’s picture

dbassendine commented

Hi Bevan,

I'd be happy to update some of the documentation points if you'd like to give me access to edit the project page.

Thanks for the great module! David

Bevan’s picture

Bevan commented
Status: Active » Needs review

You should have access now. Please let me know (here) when you have made changes so that I can review.

Bevan’s picture

Bevan commented
Status: Needs review » Needs work