diff --git a/README.md b/README.md index f422199..bfeaff4 100755 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Spotless Check](https://github.com/internetofwater/nldi-services/actions/workflows/spotless.yml/badge.svg)](https://github.com/internetofwater/nldi-services/actions/workflows/spotless.yml) [![codecov](https://codecov.io/gh/internetofwater/nldi-services/branch/master/graph/badge.svg)](https://codecov.io/gh/internetofwater/nldi-services) -This repository houses code behind the Network Linked Data Index (NLDI) API [(Swagger Docs)](https://labs.waterdata.usgs.gov/api/nldi/swagger-ui/index.html). The NLDI is hosted as part of the [USGS Waterdata Labs](https://labs.waterdata.usgs.gov/index.html), a set of new capabilities being developed by the USGS Water Mission Area. +This repository houses code behind the Network Linked Data Index (NLDI) API [(Swagger Docs)](https://api.water.usgs.gov/nldi/swagger-ui/index.html). ## Table of Contents @@ -31,9 +31,9 @@ The services are accessed via an HTTP GET request. All output is generated as JS ### Top Level Path -The root path for the NLDI services is `/api/nldi` and follows the hostname under which it is hosted. For example, the QA public endpoint is and the production endpoint is . The root path will not return any information. Instead, utilize the sub-paths mentioned in the [Swagger documention](https://labs.waterdata.usgs.gov/api/nldi/swagger-ui/index.html) or the examples below. +The root path for the NLDI services is `/api/nldi` and follows the hostname under which it is hosted. For example, the QA public endpoint is and the production endpoint is . The root path will not return any information. Instead, utilize the sub-paths mentioned in the [Swagger documention](https://api.water.usgs.gov/nldi/swagger-ui/index.html) or the examples below. -The [/api/nldi/linked-data](https://labs.waterdata.usgs.gov/api/nldi/linked-data/) endpoint will give you the valid data source names for the other endpoints. There is also a health check at `/about/health` and version information at `/about/info`. +The [/api/nldi/linked-data](https://api.water.usgs.gov/nldi/linked-data/) endpoint will give you the valid data source names for the other endpoints. There is also a health check at `/about/health` and version information at `/about/info`. In general, the API uses hypermedia to help discover options from a given endpoint. A summary of these options follows. @@ -72,7 +72,7 @@ Navigations accept query parameters to further refine/restrict the navigation be ### Other Endpoints -The NLDI includes additional helper endpoints that will be documented here at a later date. See the [Swagger documentation](https://labs.waterdata.usgs.gov/api/nldi/swagger-ui/index.html) and [NLDI landing page](https://labs.waterdata.usgs.gov/about-nldi/index.html) for more. +The NLDI includes additional helper endpoints that will be documented here at a later date. See the [Swagger documentation](https://api.water.usgs.gov/nldi/swagger-ui/index.html) and [NLDI intro page](https://waterdata.usgs.gov/blog/nldi-intro/) for more. ## Development diff --git a/docker-compose.yml b/docker-compose.yml index def4f14..66899ff 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -23,7 +23,7 @@ nldiDbUsername: read_only_user nldiDbPassword: changeMe nldiDbName: nldi - pygeoapiUrl: "https://labs.waterdata.usgs.gov/api/nldi/pygeoapi/" + pygeoapiUrl: "https://api.water.usgs.gov/nldi/pygeoapi/" networks: - nldi nldi-db: diff --git a/pom.xml b/pom.xml index 2771327..67693e3 100644 --- a/pom.xml +++ b/pom.xml @@ -9,7 +9,7 @@ nldi-services - https://labs.waterdata.usgs.gov/about-nldi/index.html + https://github.com/internetofwater/nldi-services UTF-8