[DOCUMENT-103] PuppetDB /facts endpoint lacks subquery documentation Created: 2014/05/29 Updated: 2015/03/26 Resolved: 2015/03/26
|Reporter:||Carl Caum||Assignee:||Nicholas Fagerlund|
|Remaining Estimate:||Not Specified|
|Time Spent:||Not Specified|
|Original Estimate:||Not Specified|
The PuppetDB v3 documentation for the /facts endpoint doesn't point out the endpoint supports subqueries.
|Comment by Nicholas Fagerlund [ 2014/07/11 ]|
So at this point, with the cleaned-up v4 and v3 docs for PuppetDB 2.1, it should generally be clear that subqueries work for all endpoints. Does that meet the needs of this ticket, or is there something else here I'm missing?
|Comment by Carl Caum [ 2014/07/11 ]|
But it doesn't talk about subqueries on the endpoint's page. I always get to that documentation through googling 'puppetdb api events' or nodes or something like that. So that page is the only one I have for reference of what subqueries are supported for a given endpoint. Does that makes sense?
|Comment by Nicholas Fagerlund [ 2015/03/12 ]|
After thinking about this some more, I'm still of the opinion that we shouldn't be adding duplicate info on subqueries to every endpoint page. Mostly because you can use subqueries on almost any query field — they're true peers of simple operators like = or <.
API documentation is abstract enough and complex enough that I don't think we WANT to make each page stand alone; part of keeping it maintainable and navigable is making sure that info is corralled in one place as much as possible. The info about subqueries should live on the operators page, and we make sure to link it in all the pages about endpoints that support query strings.