Feature/issue 39

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 ### Deprecated 
 ### Removed
+    - Issue 39 - Clean up code, removed comments and unused parameters
 ### Fixed
 ### Security
 

docker-compose.yml

@@ -56,5 +56,4 @@ services:
       AWS_SECRET_ACCESS_KEY: fakeSecretAccessKey
       AWS_DEFAULT_REGION: us-west-2
 networks:
-  # The presence of these objects is sufficient to define them
   hydrocron: {}

docker/Dockerfile

@@ -2,7 +2,6 @@
 ARG FUNCTION_DIR="/function"
 
 FROM public.ecr.aws/lambda/python:3.10 as build_image
-# Include global arg in this stage of the build
 ARG FUNCTION_DIR
 ENV BUILD_DIR=/hydrocron
 
@@ -23,7 +22,6 @@ COPY docker/docker-entrypoint.sh ${FUNCTION_DIR}/bin/docker-entrypoint.sh
 RUN chmod 755 ${FUNCTION_DIR}/bin/docker-entrypoint.sh
 
 FROM public.ecr.aws/lambda/python:3.10
-# Include global arg in this stage of the build
 ARG FUNCTION_DIR
 WORKDIR ${FUNCTION_DIR}
 

docs/examples.md

@@ -4,7 +4,7 @@
 
 Search for a single river reach by reach ID.
 
-    /timeseries?feature=Reach&reach_id=73111000545&output=geojson&start_time=2023-06-04T00:00:00&end_time=2023-06-10T00:00:00&fields=feature_id,time_str,wse,geometry
+    /timeseries?feature=Reach&feature_id=73111000545&output=geojson&start_time=2023-06-04T00:00:00&end_time=2023-06-10T00:00:00&fields=feature_id,time_str,wse,geometry
 
 Will return geojson, eg:
 

docs/overview.md

@@ -1,11 +1,9 @@
 # Overview
 
-Hydrocron has two main API endpoints:
+Hydrocron has a main API endpoint:
 
 - [timeseries/](/timeseries) which returns all of the timesteps for a single feature ID, and
 
-- timeseriesSubset/ which returns all of the timesteps for all of the features within a given GeoJSON polygon (not yet released)
-
 ## Feature ID
 
 The main timeseries endpoint allows users to search by feature ID.