Merge pull request #99 from dali-lab/dev

DEV TO RELEASE | Documentation updates
dali-lab · Feb 17, 2021 · 4bce1c6 · 4bce1c6
2 parents 135f47f + 24bbc5f
commit 4bce1c6
Show file tree

Hide file tree

Showing 8 changed files with 195 additions and 168 deletions.
diff --git a/README.md b/README.md
diff --git a/docs/PREDICTIONS-COUNTY.md b/docs/PREDICTIONS-COUNTY.md
@@ -0,0 +1,20 @@
+# County Predictions Data Operations
+
+## `GET /county-prediction`
+
+Returns county predictions objects that match specified query params.
+
+User can supply query params for:
+
+- `cleridPerDay`
+- `county`
+- `spbPerDay`
+- `state`
+- `trapCount`
+- `year`
+
+## `POST /county-prediction/query`
+
+Returns county predictions objects that match provided mongo query.
+
+User can supply mongo query in body.
diff --git a/docs/PREDICTIONS-RD.md b/docs/PREDICTIONS-RD.md
@@ -0,0 +1,20 @@
+# Ranger District Predictions Data Operations
+
+## `GET /rd-prediction`
+
+Returns ranger district predictions objects that match specified query params.
+
+User can supply query params for:
+
+- `cleridPerDay`
+- `rangerDistrict`
+- `spbPerDay`
+- `state`
+- `trapCount`
+- `year`
+
+## `POST /rd-prediction/query`
+
+Returns ranger district predictions objects that match provided mongo query.
+
+User can supply mongo query in body.
diff --git a/docs/ROUTES.md b/docs/ROUTES.md
@@ -1,7 +1,10 @@
 # Route Documentation
 
 - [Healthcheck](./HEALTHCHECK.md)
-- [Spot Data](./SPOTS.md)
+- [Spot Data County](./SPOTS-COUNTY.md)
+- [Spot Data Ranger District](./SPOTS-RD.md)
+- [Predictions Data County](./PREDICTIONS-COUNTY.md)
+- [Predictions Data Ranger District](./PREDICTIONS-RD.md)
 - [Summarized County Data](./SUMMARIZED-COUNTY.md)
 - [Summarized Ranger District Data](./SUMMARIZED-RD.md)
 - [Unsummarized Trapping Data](./UNSUMMARIZED.md)

diff --git a/docs/SPOTS-COUNTY.md b/docs/SPOTS-COUNTY.md
@@ -0,0 +1,20 @@
+# County Spot Data Operations
+
+## `GET /spot-data-county`
+
+Returns county spot data objects that match specified query params.
+
+User can supply query params for:
+
+- `county`
+- `fips`
+- `hostAc`
+- `spots`
+- `state`
+- `year`
+
+## `POST /spot-data-county/query`
+
+Returns county spot data objects that match provided mongo query.
+
+User can supply mongo query in body.
diff --git a/docs/SPOTS-RD.md b/docs/SPOTS-RD.md
@@ -0,0 +1,18 @@
+# Ranger District Spot Data Operations
+
+## `GET /spot-data-rangerdistrict`
+
+Returns ranger district spot data objects that match specified query params.
+
+User can supply query params for:
+
+- `rangerDistrict`
+- `spots`
+- `state`
+- `year`
+
+## `POST /spot-data-rangerdistrict/query`
+
+Returns ranger district spot data objects that match provided mongo query.
+
+User can supply mongo query in body.
diff --git a/docs/SPOTS.md b/docs/SPOTS.md
diff --git a/docs/USERS.md b/docs/USERS.md
@@ -33,3 +33,7 @@ Returns JWT auth token for user if salted and hashed version of password matches
 
 Expects authorization header with Bearer token.
 Returns 200 with no payload if auth header is valid. This route can be used on the automation server for verifying protected routes.
+
+## `GET /user/forgot-password/:email`
+
+Generates random new password for user with provided email (if a user object for that email exists). Sends email with this new password to the user's email. User can then check their email to get their new password and login.