Skip to content

Commit

Permalink
Updating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
woganmay committed May 3, 2018
1 parent ab64dc6 commit ecb95d4
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,20 @@ If you get stuck, ask for help in the support chat at: https://spectrum.chat/dom

#### Contributing

Issues and pull requests accepted, while I work on finishing the next major update (0.2.0), which will target all the current Domo APIs, including documentation.
Thanks for considering a contribution!

The purpose of this library is to wrap all the Domo endpoints as per the developer documentation, and account for any edge cases. The Helpers are for general-purpose streamlining of common operations (not specific logic for any single industry, framework or application).

Finally, this library is still under active development until it reaches a parity release with the Domo API. If you're having issues, please ask questions in the Spectrum chat (linked above), or lodge a GitHub issue. Pull requests will only be accepted if they're written in a consistent style with the existing code, and maintain parity with the [documented APIs](https://developer.domo.com/docs/api-status/api-status) provided by Domo.

| Capability | Service | Documentation |
| --- | :---: | :---: |
| DataSets | Complete | [Complete](http://domo-php.readthedocs.io/en/latest/services.html#datasets) |
| Groups | Complete | [Complete](http://domo-php.readthedocs.io/en/latest/services.html#groups) |
| Pages | Complete | [Complete](http://domo-php.readthedocs.io/en/latest/services.html#pages) |
| Users | Complete | [Complete](http://domo-php.readthedocs.io/en/latest/services.html#users) |
| Streams | Working | Working |
| Activity Log | Working | Working |
| DataSets | Complete | [Complete](http://domo-php.readthedocs.io/en/latest/services.html#datasets) (0.1.0) |
| Groups | Complete | [Complete](http://domo-php.readthedocs.io/en/latest/services.html#groups) (0.2.0) |
| Pages | Complete | [Complete](http://domo-php.readthedocs.io/en/latest/services.html#pages) (0.2.0) |
| Users | Complete | [Complete](http://domo-php.readthedocs.io/en/latest/services.html#users) (0.2.0) |
| Activity Log | Working | [Complete](http://domo-php.readthedocs.io/en/latest/services.html#activity-logs) (0.2.0) |
| Streams | Working | Working (0.2.1) |

#### Licensing

Expand Down
2 changes: 1 addition & 1 deletion docs/services.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The endpoint returns all the activity logs, sorted by event time descending. The

$entries = $client->API->Admin->getActivityLog();

To apply some filters, pass in an array of filters::
To filter the results, you've got the following options::

$filters = [
"user" => 12345,
Expand Down

0 comments on commit ecb95d4

Please sign in to comment.