Locations Endpoint - Return Aliases

[krowvin]

Requesting we add the location aliases to the location endpoint, something like:

curl -X 'GET' \
  'https://wm.swt.ds.usace.army.mil:8243/swt-data/locations/CATO?office=SWT' \
  -H 'accept: application/json;version=2'

Returns

{
  "office-id": "SWT",
  "name": "CATO",
  "latitude": 36.20388889,
  "longitude": -95.7066667,
  "active": true,
  "public-name": "Verdigris River near Catoosa, OK",
  "long-name": "Verdigris River near Catoosa, OK",
  "description": "Verdigris River near Catoosa, OK",
  "timezone-name": "US/Central",
  "location-kind": "STREAM_LOCATION",
  "nation": "US",
  "state-initial": "OK",
  "county-name": "Rogers",
  "nearest-city": "Catoosa, OK",
  "horizontal-datum": "NAD83",
  "published-longitude": 0,
  "published-latitude": 0,
  "vertical-datum": "NGVD29",
  "elevation": 0,
  "bounding-office-id": "SWT",
  "elevation-units": "ft"
}

The catalog DOES return these aliases, but the catalog is very slow at the moment compared to the above endpoint:

curl -X 'GET' \
  'https://cwms-data.usace.army.mil/cwms-data/catalog/LOCATIONS?office=SWT&like=CATO' \
  -H 'accept: application/json;version=2'

{
  "entries": [
    {
      "office": "SWT",
      "name": "CATO",
      "nearest-city": "Catoosa, OK",
      "public-name": "Verdigris River near Catoosa, OK",
      "long-name": "Verdigris River near Catoosa, OK",
      "description": "Verdigris River near Catoosa, OK",
      "kind": "STREAM_LOCATION",
      "time-zone": "US/Central",
      "latitude": 36.20388889,
      "longitude": -95.7066667,
      "published-latitude": 0,
      "published-longitude": 0,
      "horizontal-datum": "NAD83",
      "elevation": 0,
      "unit": "m",
      "vertical-datum": "NGVD29",
      "nation": "United States",
      "state": "OK",
      "county": "Rogers",
      "bounding-office": "SWT",
      "active": true,
      "aliases": [
        {
          "name": "Agency Aliases-CWMS Standard Naming",
          "value": "CATO"
        },
        {
          "name": "Agency Aliases-NWS Handbook 5 ID",
          "value": "CTOO2"
        },
        {
          "name": "Agency Aliases-DCP Platform ID",
          "value": "CE677A96"
        },
        {
          "name": "Agency Aliases-CWMS Legacy Naming",
          "value": "CATO"
        },
        {
          "name": "Agency Aliases-USGS Station Number",
          "value": "07178452"
        }
      ]
    }
  ],
  "page-size": 500,
  "total": 1
}

[MikeNeilson]

doesn't seem unreasonable to me. However, that would need to be a new "content-type" application/json;version=<date we decide> based on some recent decision we made.

Honestly a pretty good test of that concept.

[krowvin]

I might be misunderstanding your reasoning on creating a new version for that endpoint.

If it is backwards compatible, do the endpoints need new versions?

And if it's a question of breaking the endpoints,perhaps a flag to include aliases or not ? (For getAll)

Assuming you are going to date based versioning from semantic?

[MikeNeilson]

If it is backwards compatible, do the endpoints need new versions?

yes but we can make it the default without breaking anything. (There is also some consideration for input as we share the DTOs for writing data back and personally I think it makes sense to include alias support directly if we support output

Assuming you are going to date based versioning from semantic?

I am pushing that yes, see #959

[perrymanmd]

Question. Would adding the aliases to the locations endpoint make that endpoint as slow as the catalog endpoint? My assumption(!) is that joining with the location categories & groups creates the difference in performance, since everything else is largely the same (although with different names).

[MikeNeilson]

In light of recent decisions and work, an query parameter to include aliases, like we do for the data entry date seems appropriate. a new member that can be an empty list and thus not rendered, should be easy to add.

For the performance question from @perrymanmd, unlikely as it's the aliases for a single location.

[MikeNeilson]

alternatively we could just include the aliases, not like that should hurt anything.