publish 0.1.0

.github/workflows/push.yaml

@@ -15,11 +15,11 @@ jobs:
     - name: install node
       uses: actions/setup-node@master
       with:
-        node-version: 10.15
+        node-version: 12.14
 
-    - name: yarn install
-      run: yarn install
+    - name: npm install
+      run: npm install
 
-    - name: yarn test
-      run: yarn test
+    - name: npm run test
+      run: npm run test
 

.gitignore

@@ -5,7 +5,6 @@ build
 dist
 cloudformation.yml
 ddd.js
-package-lock.json
 yarn.lock
 lerna-debug.log
 *.lerna_backup

.nvmrc

@@ -1 +1 @@
-12.13
+12.14

CHANGELOG.md

@@ -6,9 +6,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
-## [0.0.1] - 2019-12-19
+## [0.1.0] - 2020-03-20
 
-Initial release, forked from [sat-api](https://github.com/sat-utils/sat-api/tree/develop)
+Initial release, forked from [sat-api](https://github.com/sat-utils/sat-api/tree/develop).
+
+Compliant with STAC 0.9.0
 
 [Unreleased]: https://github.com/stac-utils/stac-api/compare/master...develop
 [0.0.1]: https://github.com/stac-utils/stac-api/tree/0.0.1

README.md

@@ -2,33 +2,40 @@
 
 ![](https://github.com/stac-utils/stac-api/workflows/Push%20Event/badge.svg)
 
-Stac-api is a STAC compliant Rest API for searching and serving metadata for geospatial data (including but not limited to satellite imagery).
+Stac-api is a STAC compliant Rest API for searching and serving metadata for geospatial data (including but not limited to satellite imagery). The STAC version supported by a given version of stac-api is shown in the table below. Additional information can be found in the [CHANGELOG](CHANGELOG.md)
 
-The STAC version supported by a given version of stac-api is shown in the table below. Additional information can be found in the [CHANGELOG](CHANGELOG.md)
-
-| sat-api | STAC  |
+| stac-api Version | STAC Version  |
 | -------- | ----  |
 | 0.1.0    | 0.9.x |
 
-## Deployed STAC APIs
+The following APIs are deployed instances of stac-api:
+
+| Name     | Version   | Description |
+| -------- | ----      | ----        |
+| [Earth Search](https://earth-search-v0.aws.element84.com/) | 0.9.0 | Catalog of some AWS Public Datasets |
+
+
+## Usage
+
+Stac-api is a RESTful API that returns JSON, see the [documentation](http://stac-utils.github.io/stac-api), or the /api endpoint which is a self-documenting OpenAPI document. Here are some additional tools that might prove useful:
+
+- [JSONView Chrome Extension](https://chrome.google.com/webstore/detail/jsonview/chklaanhfefbnpoihckbnefhakgolnmc?hl=en): Useful for exploring the API in the browser.
+- [sat-search](https://github.com/sat-utils/sat-search): A Python client library and CLI for searching a STAC compliant API
+- [sat-fetch](https://github.com/sat-utils/sat-fetch): A Python client library and CLI for fetching areas of interest and creating stacked clipped imagery from a STAC catalog that has Cloud-Optimized GeoTiff (COG) assets.
 
-The following APIs are deployed APIs using stac-api.
 
 ## Deployment
 
 This repository contains Node libraries for running the API, along with a [serverless](https://serverless.com/) configuration file for deployment to AWS.
 
-To deploy:
+To create your own deployment of stac-api, first clone the repository:
 
 ```
-$ yarn
-$ yarn build
-$ yarn run deploy
+$ git clone https://github.com/stac-utils/stac-api.git
+$ cd stac-api
 ```
 
-### Environment variables
-
-There are some environment variables used in the code. Some do not have defaults and must be set.
+There are some settings that should be reviewed and updated as needeed in the [serverless config file](serverless.yml), under provider->environment:
 
 | Name | Description | Default Value |
 | ---- | ----------- | ------------- |
@@ -37,62 +44,66 @@ There are some environment variables used in the code. Some do not have defaults
 | STAC_TITLE | Title of this catalog | STAC API |
 | STAC_DESCRIPTION | Description of this catalog | A STAC API |
 | STAC_DOCS_URL | URL to documentation | [https://stac-utils.github.io/stac-api](https://stac-utils.github.io/stac-api) |
-| STAC_API_URL | The root endpoint of this API to use for links | Inferred from request |
 | ES_BATCH_SIZE | Number of records to ingest in single batch | 500 |
 | LOG_LEVEL | Level for logging (CRITICAL, ERROR, WARNING, INFO, DEBUG) | INFO |
+| STAC_API_URL | The root endpoint of this API | Inferred from request |
 
+After reviewing the settings, build and deploy the project.
 
-## Development
+```
+$ npm install
+$ npm run build
+$ npm run deploy
+```
 
-The latest released version 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.
+This will create a CloudFormation stack in the `us-west-2` region called `stac-api-dev`. To change the region or the stage name (from `dev`) provide arguments to the deploy command (note the additional `--` in the command, required by `npm` to provide arguments):
 
-### Building local version
+```
+$ npm run deploy -- --stage mystage --region eu-central-1
+```
 
-    # Install dependencies in package.json
-    $ yarn
+Once deployed there is one final step - creating the indices and mappings in Elasticsearch. Invoke the Lambda function (either through the AWS Console or the AWS CLI) with a payload of:
 
-    # Run the build command in each of the packages (runs webpack)
-    $ yarn build
+```
+{
+    "create_indices": true
+}
+```
 
-    # To continually watch and build source files
-    $ yarn watch
+Stac-api is now ready to ingest data!
 
-    # To run tests for all packages
-    $ yarn test
+## Ingesting Data
 
-### Building API docs
+STAC Collections and Items are ingested by the `ingest` Lambda function, however this Lambda is not invoked directly by a user, it consumes records from the `stac-api-<stage>-queue` SQS. To add STAC Items or Collections to the queue, publish them to the SNS Topic `stac-api-<stage>-ingest`.
 
-    # To build API docs from the api spec
-    $ yarn build-api-docs
+STAC Collections should be ingested before Items that belong to that Collection. Items should have the `collection` field populated with the ID of an existing Collection.
 
-## About
+### Subscribing to SNS Topics
 
-[stac-api](https://github.com/stac-utils/stac-api) was forked from [stac-api](https://github.com/sat-utils/sat-api). The stac-api is for STAC versions 0.9.0+, while sat-api exists for versions of STAC prior to 0.9.0.
+Stac-api can also be subscribed to SNS Topics that publish complete STAC Items as their message. This provides a way to keep stac-api up to date with new data. Use the AWS Lambda console for the function `stac-api-<stage>-subscibe-to-sns` to subscribe to an SNS Topic for which you have the full ARN and permission to subscribe to. This could be an SNS Topic you created yourself to publish STAC records to, or a publicly available one, such as for [Sentinel](https://github.com/sat-utils/sat-stac-sentinel).
 
-### Unit Tests
-```
-$ yarn
-$ yarn test
-```
+### Ingest Errors
+
+Errors that occur during ingest will end up in the dead letter processing queue, where they are processed by the `stac-api-<stage>-failed-ingest` Lambda function. Currently all the failed-ingest Lambda does is log the error, see the CloudWatch log '/aws/lambda/stac-api-<stage>-failed-ingest' for errors.
+
+## Development
+
+The latest released version 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.
 
-### Integration Tests
-Navigate to the integration directory
-```
-$ cd ./tests/integration
-```
-Use the environment variable `DOCKER_NAME` to set your Docker host name.
-Normally `localhost`.
-```
-$ export DOCKER_NAME=localhost
-```
-The AWS-SDK library also requires fake key fields to create a connection so set.
-```
-$ export AWS_ACCESS_KEY_ID=none
-```
-```
-$ export AWS_SECRET_ACCESS_KEY=none
 ```
-To run the tests
+# Install dependencies in package.json
+$ npm install
+
+# Run the build command in each of the packages (runs webpack)
+$ npm run build
+
+# To run tests for all packages
+$ npm run test
+
+# To build API docs from the api spec
+$ npm run build-api-docs
 ```
-$ ./runIntegration.sh
-```
+
+## About
+
+[stac-api](https://github.com/stac-utils/stac-api) was forked from [stac-api](https://github.com/sat-utils/sat-api). The stac-api is for STAC versions 0.9.0+, while sat-api exists for versions of STAC prior to 0.9.0.