fishbaseapi icon indicating copy to clipboard operation
fishbaseapi copied to clipboard

Query-able fields?

Open sckott opened this issue 11 years ago • 9 comments

@cboettig what fields should users be allowed to query? since you're more familiar with the data...

Right now, I've set it up so that users can query on any field. Do you think this is best? Or do you think only certain fields should be exposed to query on? If we do limit to only some fields can be queried on that does make it a little easier to solve https://github.com/ropensci/fishbaseapi/issues/7 because we don't have to account for any field queried.

note that this is different from what gets returned (All fields unless there some reason not to)

sckott avatar Feb 04 '15 18:02 sckott

@cboettig pinging you again so we can get this done - i think we should go with limiting what fields can be queried on, agreed? then add more as needed

sckott avatar Feb 07 '15 00:02 sckott

Okay, I think that makes sense; I'll need to go through the functions I have so far and see what fields we query on currently; it's a relatively tiny subset though (usually SpecCode or Species & Genus).

cboettig avatar Feb 07 '15 00:02 cboettig

okay, cool, yeah, I don't want to break anything

sckott avatar Feb 07 '15 00:02 sckott

@cboettig from #18 seems like you're saying we should restrict queryable fields to species, genus, and speccode - should I implement that now?

sckott avatar Feb 09 '15 18:02 sckott

@sckott Let's wait till we've done a few more endpoints to be sure that will work. e.g. looks like it will work for species table, but not for common names or synonyms, where we need to able to query on the common name or synonym itself.

cboettig avatar Feb 09 '15 18:02 cboettig

right, ok

sckott avatar Feb 09 '15 18:02 sckott

@cboettig updating the docs a bit - since the query-able fields are unlimited right now, I'm only putting in the fields always avail. (limit, offset, fields), and a few other fields that are most likely to be queried on

e.g. http://docs.fishbaseapi.apiary.io/#reference/list-species

sckott avatar Mar 09 '15 23:03 sckott

Nice, looks good. yeah, that makes sense for now

On Mon, Mar 9, 2015 at 4:08 PM Scott Chamberlain [email protected] wrote:

@cboettig https://github.com/cboettig updating the docs a bit - since the query-able fields are unlimited right now, I'm only putting in the fields always avail. (limit, offset, fields), and a few other fields that are most likely to be queried on

e.g. http://docs.fishbaseapi.apiary.io/#reference/list-species

— Reply to this email directly or view it on GitHub https://github.com/ropensci/fishbaseapi/issues/8#issuecomment-77964048.

cboettig avatar Mar 09 '15 23:03 cboettig

in the more general discussion area on top in apiary, I can explain that

many query params are possible...see output fields for options...but this may change in the future

sckott avatar Mar 09 '15 23:03 sckott