Merge pull request #167 from sat-utils/develop

release 0.2.4

Author: matthewhanson

CHANGELOG.md

@@ -6,6 +6,19 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [v0.2.4] - 2019-06-02
+
+### Added
+- Add `fields` filter to return only specific fields
+- Added SATAPI_URL environment variable for defining a custom root URL used for creating hierarchical links. Otherwise, the root URL will try to be inferred from the headers.
+- Gzip compression added for clients that support it (via `Accept-Encoding`)
+- Added SATAPI_ES_PRECISION environment variable to change the precision for underlying intersection geometry queries. This will have an adverse impact on performance and storage size. If changed after ingestion, a reindex operation will need to be performed. It defaults to '5mi' (5 miles).
+
+### Fixed
+- Fix datetime range to be inclusive (i.e., gte and lte)
+- Fixed `next` links to properly stringify geometries
+
+
 ## [v0.2.3] - 2019-01-29
 
 ### Fixed
@@ -84,6 +97,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Refactor and improve splitting
 
 [Unreleased]: https://github.com/sat-utils/sat-api/compare/master...develop
+[v0.2.4]: https://github.com/sat-utils/sat-api/compare/v0.2.3...v0.2.4
 [v0.2.3]: https://github.com/sat-utils/sat-api/compare/v0.2.2...v0.2.3
 [v0.2.2]: https://github.com/sat-utils/sat-api/compare/v0.2.1...v0.2.2
 [v0.2.1]: https://github.com/sat-utils/sat-api/compare/v0.2.0...v0.2.1

README.md

@@ -4,26 +4,21 @@
 
 Sat-api is a STAC compliant web API for searching and serving metadata for geospatial data (including but not limited to satellite imagery).
 
-Development Seed runs an instance of sat-api for the Landsat-8 and Sentinel-2 imagery that is [hosted on AWS](https://aws.amazon.com/earth/). You can access this at https://sat-api.developmentseed.org. 
+Development Seed runs an instance of sat-api for the Landsat-8 and Sentinel-2 imagery that is [hosted on AWS](https://aws.amazon.com/earth/). You can access this at https://sat-api.developmentseed.org using the [API documentation](http://sat-utils.github.io/sat-api/) for reference and examples.
 
 The STAC version supported by a given version of sat-api is shown in the table below. Additional information can be found in the [CHANGELOG](CHANGELOG.md)
 
 | sat-api | STAC  |
 | -------- | ----  |
-| 0.1.0    | 0.5.0 |
-| 0.2.x    | 0.6.0 |
-
-
-## Documentation
-
-The documentation includes information on the STAC spec, how to use the API, manage Elasticsearch, as well as how to deploy your own API on AWS. Access the documentation [here](docs/docs.md)
+| 0.1.0    | 0.5.x |
+| 0.2.x    | 0.6.x |
 
 
 ## Development
 
 Sat-api includes a number of NPM packages (in the packages/ directory) that are used to create and populate an instance of sat-api. See the [sat-utils org on NPM](https://www.npmjs.com/org/sat-utils) for the full list of packages. [Lerna](https://github.com/lerna/lerna) is used for for managing these packages.
 
-The latest version released is on the [master branch](https://github.com/sat-utils/sat-api/tree/master), and the latet development version is on the [develop](https://github.com/sat-utils/sat-api/tree/develop) branch.
+The latest version released is on the [master branch](https://github.com/sat-utils/sat-api/tree/master), and the latest development version is on the [develop](https://github.com/sat-utils/sat-api/tree/develop) branch.
 
 ### Building local version
 

docs/api.md

@@ -153,13 +153,14 @@ Retrieve Items matching filters. Intended as a shorthand API for simple queries.
 
 <h3 id="search-stac-items-by-simple-filtering.-parameters">Parameters</h3>
 
-|Parameter|In|Type|Required|Description|
+|Name|In|Type|Required|Description|
 |---|---|---|---|---|
 |bbox|query|array[number]|false|Only features that have a geometry that intersects the bounding box are|
 |time|query|string|false|Either a date-time or a period string that adheres to RFC3339. Examples:|
 |limit|query|integer|false|The optional limit parameter limits the number of items that are|
 |query|query|string|false|query for properties in items. Use the JSON form of the queryFilter used in POST.|
 |sort|query|[sort](#schemasort)|false|Allows sorting results by the specified properties|
+|fields|query|[fields](#schemafields)|false|Determines the shape of the features in the response|
 
 #### Detailed descriptions
 
@@ -388,7 +389,7 @@ retrieve items matching filters. Intended as the standard, full-featured query A
 
 <h3 id="search-stac-items-by-full-featured-filtering.-parameters">Parameters</h3>
 
-|Parameter|In|Type|Required|Description|
+|Name|In|Type|Required|Description|
 |---|---|---|---|---|
 |body|body|[searchBody](#schemasearchbody)|false|none|
 
@@ -1690,3 +1691,70 @@ null
 |crs|http://www.opengis.net/def/crs/OGC/1.3/CRS84|
 |trs|http://www.opengis.net/def/uom/ISO-8601/0/Gregorian|
 
+<h2 id="tocSfieldsfilter">fieldsFilter</h2>
+
+<a id="schemafieldsfilter"></a>
+
+```json
+{
+  "fields": {
+    "geometry": true,
+    "include": [
+      [
+        "eo:cloud_cover"
+      ]
+    ],
+    "exclude": [
+      [
+        "eo:sun_azimuth"
+      ]
+    ]
+  }
+}
+
+```
+
+*Determines the shape of the features in the response*
+
+### Properties
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|fields|[fields](#schemafields)|false|none|The geometry member determines whether the geometry is populated or is null. The include and exclude members specify an array of property names that are either  included or excluded from the result, respectively. If both include and exclude  are specified, include takes precedence. id and links are required feature properties and cannot be excluded.|
+
+<h2 id="tocSfields">fields</h2>
+
+<a id="schemafields"></a>
+
+```json
+{
+  "geometry": true,
+  "include": [
+    [
+      "eo:cloud_cover"
+    ]
+  ],
+  "exclude": [
+    [
+      "eo:sun_azimuth"
+    ]
+  ]
+}
+
+```
+
+*The geometry member determines whether the geometry is populated or is null. The
+include and exclude members specify an array of property names that are either 
+included or excluded from the result, respectively. If both include and exclude 
+are specified, include takes precedence.
+id and links are required feature properties and cannot be excluded.
+*
+
+### Properties
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|geometry|boolean|false|none|none|
+|include|[string]|false|none|none|
+|exclude|[string]|false|none|none|
+