Please fully document the squad api and the filters

[jscook2345]

If we can better understand the squad api and the filters available we can more easily query large amounts of resources using command-line programs instead of writing lots little squad-client based scripts.

[jscook2345]

cc: @amrohassaan

This is from our discussion earlier in our Google Hang Out.

I think we can avoid creating a new command in squad-client if we can better understand how to query the api with other tools like curl. This would allow us to not have to write a lot of one-off scripts to complete CI tasks within our pipelines.

[amrohassaan]

@jscook2345 thank you for creating this one issue and clarifying on #72 .
I've started rewriting the squad docs last week and it will be an incremental ongoing progress.
The pr is Linaro/squad#905
I think we probably will need to have dedicated section for filtering under the 'api' item.

[jscook2345]

@amrohassaan

For an example, I am partial do what id being done here: https://metacpan.org/pod/Pithub::Repos

Note that it is has both the api variables, but also a code-based example. Perhaps good for testing as well as docs?

[jscook2345]

PS, I'm happy to help add the code examples after the API examples are pushed up. More than happy to help! Thanks again!