search

CRREL / GRiD-API

9 stars 3 forks source link

Optional and filtered intersection returns #32

Closed chambbj closed 6 years ago

chambbj commented 6 years ago

Querying /aois can be quite slow when users have large numbers of AOIs, as GRiD is testing for intersections with assets on the backend. It may make good sense to make this optional, if a user simply wants an overview of their AOIs. They could then test for intersections in a subsequent call to /aois/{pk}, or perhaps by hitting the /products endpoint directly with their AOI geometry.

AlexMountain commented 6 years ago

Current plan is to have additional options for this available in v4, but they could probably be backported to v3 without much effort as another enhancement if there was interest. I'm including ways to omit geoms and intersections from all the product returns as they have the ability to be much larger or require more time to calculate. I'm also adding the ability to filter product intersections by type: pointcloud, raster, vector, mesh.

AlexMountain commented 6 years ago

This has been added as a feature to v3. The following query parameters have been added to the v3 AOI endpoints:

intersections: bool, whether or not to return the product intersections.
intersection_types: string, comma separated list of product types to return.  Returns all types by default.
intersection_geoms: bool, whether or not to return the geometries of the product intersections.

The following query parameters have been added to the v3 Product endpoints:

geoms: bool, whether or not to return the geometry of the product.
type: string, now accepts a comma separated list of product types to return.  Returns all types by default.

Defaults for these options should match the current v3 returns. These enhancements will be live with GRiD's 1.4.5 release.