Basins Endpoint Broken

[krowvin]

Automation Testing for CWMSjs - /Basins

Attempting the /cwms-data/basins endpoint from various means gives no results.

Presuming at least LRH has basins in there database I would expect to get something back.

Using Swagger / CURL default value for LRH returns

(Mimetype is set to pg+json?)

curl -X 'GET' \
  'https://cwms-data.usace.army.mil/cwms-data/basins?office=LRH' \
  -H 'accept: application/vnd.named+pg+json'

Using a normal mimetype (application/json) gives

curl -X 'GET' \
   'https://cwms-data.usace.army.mil/cwms-data/basins?office=LRH' \
   -H 'accept: application/json'

An empty string.
I would not expect there to be a version 2, but I tried it. But it also returns the empty string.

It is the same for other districts.

If the basins endpoint is not complete should we consider moving it out of PROD?

EDIT:
If this is an issue with districts not having data in the tables the endpoint looks at, can we consider adding the POST method to start getting data in without needing to use the SQL directly?

[rma-rripken]

Try NWDM. I won't say its useful, but its not empty.

{
  "name": "Grand R Basin",
  "graph": {
    "nodes": [
      {
        "name": "Grand_R_NWO-Node-0.0",
        "labels": [
          "EMPTY"
        ],
        "properties": {
          "streamName": [
            "Grand_R_NWO"
          ],
          "station": [
            0.0
          ],
          "bank": [
            "L"
          ]
        }
      },
      {
        "name": "LESD",
        "labels": [
          "Stream Location"
        ],
        "properties": {
          "streamName": [
            "Grand_R_NWO"
          ],
          "station": [
            5.0
          ],
          "bank": [
            "L"
          ]
        }
      },
      {
        "name": "SHHI",
        "labels": [
          "Stream Location"
        ],
        "properties": {
          "streamName": [
            "Grand_R_NWO"
          ],
          "station": [
            90.0
          ],
          "bank": [
            "L"
          ]
        }
      },
      {
        "name": "BOHA",
        "labels": [
          "Stream Location"
        ],
        "properties": {
          "streamName": [
            "Grand_R_NWO"
          ],
          "station": [
            100.0
          ],
          "bank": [
            "L"
          ]
        }
      },
      {
        "name": "Grand_R_NWO-Node-110.0",
        "labels": [
          "EMPTY"
        ],
        "properties": {
          "streamName": [
            "Grand_R_NWO"
          ],
          "station": [
            110.0
          ],
          "bank": [
            "L"
          ]
        }
      }
    ],
    "edges": [
      {
        "from": "Grand_R_NWO-Node-0.0",
        "to": "LESD",
        "labels": [
          "Stream"
        ],
        "undirected": false,
        "properties": {
          "streamName": [
            "Grand_R_NWO"
          ]
        }
      },
      {
        "from": "LESD",
        "to": "SHHI",
        "labels": [
          "Stream"
        ],
        "undirected": false,
        "properties": {
          "streamName": [
            "Grand_R_NWO"
          ]
        }
      },
      {
        "from": "SHHI",
        "to": "BOHA",
        "labels": [
          "Stream"
        ],
        "undirected": false,
        "properties": {
          "streamName": [
            "Grand_R_NWO"
          ]
        }
      },
      {
        "from": "BOHA",
        "to": "Grand_R_NWO-Node-110.0",
        "labels": [
          "Stream"
        ],
        "undirected": false,
        "properties": {
          "streamName": [
            "Grand_R_NWO"
          ]
        }
      }
    ]
  }
}{
  "name": "James R Basin",
  "graph": {
    "nodes": [],
    "edges": []
  }
}

[krowvin]

And I did suspect it was because it was empty.

If possible can we add a result payload of some kind stating it is empty? I realize looking at the payload you did find that might not be obvious given it's an object directly and not

{ "basins": [ ... ] } 

For example

And

Could we add a note to add POST for basins at some point on the roadmap? This would make it more approachable for districts to add basins and not have to use SQL.

Not sure on the process/approval of adding things to the dev roadmap and their priority. I know @DanielTOsborne and myself will be looking into this.

[rma-rripken]

I agree its not intuitive that you get back an empty result. Some of the other end-points probably also do that. But some ( like Location group and location category) will return 404 (Not Found).

[MikeNeilson]

Anyone with at least writer role in the project should be able to set the milestones. the Projects are a different story as GitHub decided to move those to the Org level (but it's still not impossible, just a smidge more work to get setup initially and than it's just managing tickets really.)

[DanielTOsborne]

I agree its not intuitive that you get back an empty result. Some of the other end-points probably also do that. But some ( like Location group and location category) will return 404 (Not Found).

And I did suspect it was because it was empty.

If possible can we add a result payload of some kind stating it is empty? I realize looking at the payload you did find that might not be obvious given it's an object directly and not

{ "basins": [ ... ] } 

I'm not familiar with the basins part of the API (I've never used it myself), but for some endpoints at least, like timeseries, the difference makes sense to distinguish between the item itself not existing, vs there being no dataset.

For example:
Timeseries exists, but has no values in the requested range/filtering options - empty result
Timeseries path itself does not exist - 404 204.

EDIT: 204 (No Content) would be the appropriate code IMO. I learned some additional information later that made it more clear to me that the 404 is just a bug.