changedInput schema / properties / datum / description
Previous value: -"Tidal datum reference plane. MLLW (default) is the US nautical chart datum. MSL = mean sea level; MHHW = mean higher high water (flooding reference)."New value: +"Datum the predicted heights are referenced to. MLLW (default) is the US nautical chart datum, and MHHW (mean higher high water) is the flooding reference; MHW, MTL, MSL, MLW, and DTL (diurnal tide level) are the other tidal planes. NAVD is NAVD88 and reads only where the station has an NAVD88 tie. STND is the station's own datum and is the plane that works where no tidal datum exists. CRD applies at Columbia River stations only. A datum this station does not carry comes back as datum_unavailable naming the ones it does."
changedInput schema / properties / datum / enum
Previous value: -[
- "MLLW",
- "MHHW",
- "MSL",
- "MTL",
- "MHW",
- "MLW",
- "CD",
- "STND"
-]New value: +[
+ "MLLW",
+ "MHHW",
+ "MHW",
+ "MTL",
+ "MSL",
+ "MLW",
+ "DTL",
+ "NAVD",
+ "STND",
+ "CRD"
+]
changedInput schema / properties / interval / description
Previous value: -"Prediction interval: hilo (default) returns only high and low tide events; 6min returns a continuous prediction curve at 6-minute intervals."New value: +"Prediction interval: hilo (default) returns only high and low tide events; 6min returns a continuous prediction curve at 6-minute intervals, and is served only by a reference station — a subordinate station has no 6-minute curve."
addedInput schema / properties / limit
Added value: +{
+ "description": "Maximum prediction rows to return on this page, for a caller that wants fewer than the response budget allows. Omit for the largest page that fits; a value larger than the budget allows does not widen the page.",
+ "maximum": 9007199254740991,
+ "minimum": 1,
+ "type": "integer"
+}
addedInput schema / properties / offset
Added value: +{
+ "default": 0,
+ "description": "Row offset into the matched prediction series, for reading a range whose rows do not fit one response. 0 (default) starts at the first row; pass the next_offset from a previous call to continue. An offset past the last row returns an empty page rather than an error.",
+ "maximum": 9007199254740991,
+ "minimum": 0,
+ "type": "integer"
+}
changedOutput schema / properties / error / properties / data / properties / reason / description
Previous value: -"Machine-readable failure mode. Declared by this tool: `station_not_found`: CO-OPS returned an error for the station ID — likely wrong type or invalid ID. `invalid_date_range`: begin_date/end_date is not a real calendar date or begin_date is after end_date `date_range_exceeded`: Requested date range exceeds the 1-year CO-OPS limit. `no_predictions`: Station exists but CO-OPS returned no prediction data for the date range. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `station_not_found`: CO-OPS returned an error for the station ID — likely wrong type or invalid ID. `invalid_date_range`: begin_date/end_date is not a real calendar date or begin_date is after end_date `date_range_exceeded`: Requested date range exceeds the 1-year CO-OPS limit. `no_predictions`: Station exists but CO-OPS returned no prediction data for the date range. `subordinate_no_6min`: interval=\"6min\" was requested for a subordinate station, whose predictions are high and low events derived from a reference station. `datum_unavailable`: The station does not carry the requested datum — NAVD reads only where the station has an NAVD88 tie, and CRD only on the Columbia River. Other values are possible when a failure originates below the handler."
changedOutput schema / properties / error / properties / data / properties / reason / examples
Previous value: -[
- "station_not_found",
- "invalid_date_range",
- "date_range_exceeded",
- "no_predictions"
-]New value: +[
+ "station_not_found",
+ "invalid_date_range",
+ "date_range_exceeded",
+ "no_predictions",
+ "subordinate_no_6min",
+ "datum_unavailable"
+]
addedOutput schema / properties / next_offset
Added value: +{
+ "anyOf": [
+ {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Offset to pass as offset on the next call, or null when this page reaches the last matched row. Absent when the whole matched series was returned."
+}
addedOutput schema / properties / notice
Added value: +{
+ "description": "What this page of the prediction series covers and how to reach the next one. Present only when the response is a page rather than the whole matched series.",
+ "type": "string"
+}
addedOutput schema / properties / page_offset
Added value: +{
+ "description": "Row offset this page starts at, echoed from the request. Absent when the whole matched series was returned.",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+}
changedOutput schema / properties / predictions / description
Previous value: -"Tide predictions for the requested date range."New value: +"Tide predictions for the requested date range — the whole series when it fits one response, otherwise the leading page starting at offset. rows_matched and next_offset report what a page left behind."
addedOutput schema / properties / rows_matched
Added value: +{
+ "description": "Prediction rows the requested date range matched, before the page was cut. Absent when the whole matched series was returned.",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+}
addedOutput schema / properties / rows_returned
Added value: +{
+ "description": "Prediction rows this page carries — the length of predictions. Absent when the whole matched series was returned.",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+}
addedOutput schema / properties / truncated
Added value: +{
+ "description": "True when this page stops short of the last matched row, so further rows remain at next_offset. False on the final page and on a page past the end. Absent when the whole matched series was returned.",
+ "type": "boolean"
+}