Skip to content

V1 - #926

Merged
ldecicco-USGS merged 13 commits into
DOI-USGS:mainfrom
ldecicco-USGS:v1
Sep 9, 2026
Merged

V1#926
ldecicco-USGS merged 13 commits into
DOI-USGS:mainfrom
ldecicco-USGS:v1

Conversation

@ldecicco-USGS

Copy link
Copy Markdown
Collaborator

Let's get v1 ready to roll as soon as the announcement comes out.

@ldecicco-USGS

Copy link
Copy Markdown
Collaborator Author
image

So if needed, it reverts to v0, and then on.exit goes back to v1.

And in this screenshot, a user can specify v0 if they need to:

image

@ehinman

ehinman commented Sep 1, 2026

Copy link
Copy Markdown
Collaborator

I will review by the end of the week, thanks!

Comment thread R/read_waterdata_ts_meta.R Outdated
#' #'
#' See also Details below for more information.
#' @param end_utc `r get_ogc_params("time-series-metadata")$end_utc`
#' @param end_utc Deprecated in v1. Use "end" instead.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Move these to the bottom, just above the dot dot dots?

@ehinman

ehinman commented Sep 4, 2026

Copy link
Copy Markdown
Collaborator

I need help understanding something. Are begin and end automatically converted to UTC?

I decided to try using an offset to pull data:

cont <- read_waterdata_continuous(monitoring_location_id = "USGS-07227500", time = "2026-09-04T13:00:00-05:00/..")

This pulled several records with the time column being in UTC (so time values ranging from 18:00 to 19:45 as of this writing, which makes sense)

I then tried this same offset in ts_meta and nothing came back:

ts <- read_waterdata_ts_meta(monitoring_location_id = "USGS-07227500", end = "2026-09-04T13:00:00-05:00/..")

Am I misunderstanding something? Related: I did a quick search for an example using a time offset and didn't see one for the water data APIs. I think this would be helpful.

@ehinman

ehinman commented Sep 4, 2026

Copy link
Copy Markdown
Collaborator

Maybe @mikemahoney218-usgs has more details on this ^^ or where I'm going wrong.

@mikemahoney218-usgs

Copy link
Copy Markdown
Contributor

The time series metadata endpoint only updates once per day, so it generally won't have the most up-to-date information on when the most recent record is from

"state_name is deprecated starting in v1 of the Water Data APIs.
Use the function read_waterdata_combined_meta instead.
Reverting to v0 version of Water Data APIs."
)

@ehinman ehinman Sep 4, 2026 •

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a planned date for when they'll be removed entirely? If we have a date, might be handy to put here.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

~June, but I'm trying to thread the needle of not freaking people out about V0 (which is mostly a non-event) before WaterServices is decommissioned (which is a much bigger event) -- so we haven't announced more specifics than that yet. (I also haven't thought about it a ton yet, either)

@ehinman ehinman left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These changes look good @ldecicco-USGS. I ran some tests on them and the warnings popped up as expected with helpful information. My only optional suggestion is to move the state_name, begin_utc and end_utc inputs to the bottom of the list, so that they're less obvious.

Merge branch 'main' of github.com:DOI-USGS/dataRetrieval into v1

# Conflicts:
#	README.md

This branch had an error being deployed

1 failed (outdated) and 1 active deployments
CI_config — a3fda312 Deployed Sep 9, 2026 by ldecicco-USGS via macos-latest (release) #987
github-pages — d8888bac Deployed Aug 28, 2026 by ldecicco-USGS via deploy #419
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants