Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggestions for objects API #25

Open
jiho opened this issue Nov 15, 2020 · 1 comment
Open

Suggestions for objects API #25

jiho opened this issue Nov 15, 2020 · 1 comment
Assignees

Comments

@jiho
Copy link
Contributor

jiho commented Nov 15, 2020

/object_set/{project_id}/query
Rename to /object_set/{project_id}/filter or /object_set/{project_id}/define.

Rename and reorder query parameters to

taxo -> taxon_ids
taxochild -> include_children
statusfilter -> status

samples -> sample_ids

depthmin -> depth_min
depthmax -> depth_max

MapS -> lat_min
MapN -> lat_max
MapW -> lon_min
MapE -> lon_max

fromdate -> date_min
todate -> date_max
month -> months

fromtime -> time_min
totime -> time_max
inverttime -> invert_time_minmax
daytime -> time_of_day

instrum -> instrument

filt_annot -> annotator_id
validfromdate -> datetime_annotated_min
validtodate -> datetime_annotated_max

freenum -> custom_numeric_field
freenumst -> custom_numeric_min
freenumend -> custom_numeric_max
freetxt -> custom_text_field
freetxtval -> custom_text_contains

Is it possible to document the content of each field from the API's documentation? (e.g. status can be "U", "V", "P", "D", etc.)

What is filt_last_annot?

Is validfromdate really only for validation date or just any annotation action (e.g. marking an object as dubious counts)? I am thinking the later, hence the change of name.

@grololo06
Copy link
Member

  • Of course it's possible to document more.
  • "filt_last_annot" is a filter on last annotator. unlike "filt_annot" which digs in annotation history as well.
  • True that validfromdate/validtodate toggles a filter on obj_head.classif_when, which is set as well when the object becomes dubious. The DB column might be misnamed...

@grololo06 grololo06 transferred this issue from ecotaxa/ecotaxa_front Sep 28, 2021
@grololo06 grololo06 removed their assignment Sep 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants