Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: internetofwater/nldi-services
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 1.12.6
Choose a base ref
...
head repository: internetofwater/nldi-services
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: master
Choose a head ref
  • 16 commits
  • 4 files changed
  • 3 contributors

Commits on Jun 9, 2023

  1. Copy the full SHA
    22ea65b View commit details

Commits on Apr 4, 2024

  1. Copy the full SHA
    6d94963 View commit details
  2. Merge pull request #392 from internetofwater/master-dev

    change pipeline version being used from 2022-05-23-r1 to 2024-04-04-r0
    ewojtylko authored Apr 4, 2024
    Copy the full SHA
    29002dc View commit details
  3. Copy the full SHA
    bdfee6a View commit details
  4. Copy the full SHA
    2c89edd View commit details
  5. moving pipeline to rev2

    ewojtylko committed Apr 4, 2024
    Copy the full SHA
    59cefb5 View commit details

Commits on Apr 5, 2024

  1. Merge pull request #393 from internetofwater/master-dev

    moving pipeline to rev2
    ewojtylko authored Apr 5, 2024
    Copy the full SHA
    86d6176 View commit details
  2. Copy the full SHA
    339167e View commit details
  3. update to revision 4

    ewojtylko committed Apr 5, 2024
    Copy the full SHA
    133628d View commit details

Commits on Apr 8, 2024

  1. Copy the full SHA
    d0f5c3c View commit details
  2. Copy the full SHA
    b21dc3e View commit details

Commits on Sep 20, 2024

  1. Update README.md

    remove labs.waterdata from readme
    dblodgett-usgs authored Sep 20, 2024
    Copy the full SHA
    1b88229 View commit details
  2. Copy the full SHA
    6c6fb0d View commit details
  3. remove labs from pom

    dblodgett-usgs authored Sep 20, 2024
    Copy the full SHA
    ee98065 View commit details
  4. Merge pull request #395 from internetofwater/dblodgett-usgs-patch-1

    change labs.waterdata to api.water
    dblodgett-usgs authored Sep 20, 2024
    Copy the full SHA
    37fd544 View commit details
  5. Merge pull request #388 from dblodgett-usgs/master

    call out database configuration in nldi-db repo
    dblodgett-usgs authored Sep 20, 2024
    Copy the full SHA
    4b5a7ea View commit details
Showing with 27 additions and 23 deletions.
  1. +1 −1 .gitlab-ci.yml
  2. +24 −20 README.md
  3. +1 −1 docker-compose.yml
  4. +1 −1 pom.xml
2 changes: 1 addition & 1 deletion .gitlab-ci.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
include:
- project: "wma/nhgf/nldi/mirror-pipelines"
ref: "2022-05-23-r1"
ref: "2024-04-04-r4"
file:
- "nldi-services.yml"
44 changes: 24 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -3,35 +3,37 @@
[![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

- [Public API](#public-api)
- [Top Level Path](#top-level-path)
- [Up/Down Stream Navigation](#updown-stream-navigation)
- [Up/Down Stream Data](#updown-stream-data)
- [Query Parameters](#query-parameters)
- [Other Endpoints](#other-endpoints)
- [Development](#development)
- [Dependencies](#dependencies)
- [Docker Compose](#docker-compose)
- [Environment Variables](#environment-variables)
- [Testing](#testing)
- [Pipelines](#pipelines)
- [Test](#test)
- [Build](#build)
- [Deploy](#deploy)
- [Network Linked Data Index Services](#network-linked-data-index-services)
- [Table of Contents](#table-of-contents)
- [Public API](#public-api)
- [Top Level Path](#top-level-path)
- [Up/Down Stream Navigation](#updown-stream-navigation)
- [Up/Down Stream Data](#updown-stream-data)
- [Query Parameters](#query-parameters)
- [Other Endpoints](#other-endpoints)
- [Development](#development)
- [Dependencies](#dependencies)
- [Docker Compose](#docker-compose)
- [Environment Variables](#environment-variables)
- [Testing](#testing)
- [Pipelines](#pipelines)
- [Test](#test)
- [Build](#build)
- [Deploy](#deploy)

## Public API

The services are accessed via an HTTP GET request. All output is generated as JSON and GeoJSON.

### 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 <https://labs-beta.waterdata.usgs.gov/api/nldi/> and the production endpoint is <https://labs.waterdata.usgs.gov/api/nldi/>. 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 <https://labs-beta.waterdata.usgs.gov/api/nldi/> and the production endpoint is <https://api.water.usgs.gov/nldi/>. 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.

@@ -70,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

@@ -102,6 +104,8 @@ These test services will be accessible at <localhost:8080/nldi>. \
If you would like to build these images using a mirror url simply set a `DOCKER_MIRROR` environment variable or include
it as a build argument.

See the [nldi-db project](https://github.com/internetofwater/nldi-db) for instructions to use different configurations of the database.

### Environment Variables

To run the project (connecting to a separately running db instance) you will need to create the file application.yml in the project's root directory and add the following (normal defaults are filled in):
@@ -154,4 +158,4 @@ The build pipeline happens internally to the USGS and are triggered manually. Th

#### Deploy

Similar to the build pipeline, deploys are internal and triggered manually. The infrastructure components are managed with this pipeline and retrieve the Docker container from the previously mentioned container registry.
Similar to the build pipeline, deploys are internal and triggered manually. The infrastructure components are managed with this pipeline and retrieve the Docker container from the previously mentioned container registry..
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
@@ -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:
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
@@ -9,7 +9,7 @@


<name>nldi-services</name>
<url>https://labs.waterdata.usgs.gov/about-nldi/index.html</url>
<url>https://github.com/internetofwater/nldi-services</url>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>