changedInput schema / properties / facet / description
Previous value: -"Restrict the response to one facet by ID (e.g. \"stateid\"). Use with values_offset to page a facet whose values were truncated. Omit to get every facet."New value: +"Restrict the response to one facet by ID (e.g. \"stateid\"). Use with values_offset to page a facet whose values were truncated, or with values_query to find a value in it. Omit to get every facet."
changedInput schema / properties / values_offset / description
Previous value: -"Index of the first facet value to return, applied to every facet in the response. Use the value named in a truncation hint to continue past the cap."New value: +"Index of the first facet value to return, applied to every facet in the response. Use the value named in a truncation hint to continue past the cap. With values_query, indexes the matching values."
addedInput schema / properties / values_query
Added value: +{
+ "description": "Keep only the facet values whose id, name, or alias contains this text, ignoring case (e.g. \"palo verde\" on plantCode). A plain substring match, not a pattern or a ranked search. Applied to every facet in the response, before values_offset and the cap. Leading and trailing whitespace is ignored. Omit to list every value.",
+ "minLength": 1,
+ "type": "string"
+}
changedOutput schema / properties / error / properties / data / properties / reason / description
Previous value: -"Machine-readable failure mode. Declared by this tool: `upstream_invalid_response`: EIA returned an unusable response body or a missing route or data envelope. `upstream_unavailable`: EIA answered with a retryable HTTP service failure. `route_not_found`: Route does not exist in the EIA taxonomy. `route_not_queryable`: Route is a category node with sub-routes, not a queryable leaf. `facet_not_found`: The facet input names an ID the route does not expose. `facet_unavailable`: The facet input names a facet whose value list EIA did not return after retries. `rate_limited`: EIA rate limit hit on the route metadata request, or on the value list the facet input names. `upstream_unreachable`: EIA could not be reached (connection refused or reset, DNS failure) on the route metadata request or the route-tree build. A value list the facet input names fails as facet_unavailable instead. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `upstream_invalid_response`: EIA returned an unusable response body or a missing route or data envelope. `upstream_unavailable`: EIA answered with a retryable HTTP service failure. `upstream_timeout`: EIA did not answer the route metadata request or the route-tree build in time: one attempt passed 45 s, or the call passed its 56 s deadline across retries. A value list that times out is named in unavailable_facets instead. `route_not_found`: Route does not exist in the EIA taxonomy. `route_not_queryable`: Route is a category node with sub-routes, not a queryable leaf. `facet_not_found`: The facet input names an ID the route does not expose. `facet_unavailable`: The facet input names a facet whose value list EIA did not return after retries. `rate_limited`: EIA rate limit hit on the route metadata request, or on the value list the facet input names. `upstream_unreachable`: EIA could not be reached (connection refused or reset, DNS failure) on the route metadata request or the route-tree build. A value list the facet input names fails as facet_unavailable instead. Other values are possible when a failure originates below the handler."
changedOutput schema / properties / error / properties / data / properties / reason / examples
Previous value: -[
- "upstream_invalid_response",
- "upstream_unavailable",
- "route_not_found",
- "route_not_queryable",
- "facet_not_found",
- "facet_unavailable",
- "rate_limited",
- "upstream_unreachable"
-]New value: +[
+ "upstream_invalid_response",
+ "upstream_unavailable",
+ "upstream_timeout",
+ "route_not_found",
+ "route_not_queryable",
+ "facet_not_found",
+ "facet_unavailable",
+ "rate_limited",
+ "upstream_unreachable"
+]
changedOutput schema / properties / facets / items / properties / value_count / description
Previous value: -"Total values this facet has upstream, independent of the returned window."New value: +"Total values this facet has upstream, independent of the returned window and of values_query."
changedOutput schema / properties / facets / items / properties / values / description
Previous value: -"Valid values for this facet dimension, starting at values_offset and capped at EIA_FACET_VALUE_CAP."New value: +"Valid values for this facet dimension, starting at values_offset and capped at EIA_FACET_VALUE_CAP. With values_query, only the matching values, in upstream order."
addedOutput schema / properties / facets / items / properties / values_matched
Added value: +{
+ "description": "Values of this facet whose id, name, or alias contains values_query — what values_offset indexes and values_truncated is measured against. One ID listed under two historical names counts twice. Present only when values_query is set.",
+ "type": "number"
+}
changedOutput schema / properties / facets / items / properties / values_truncated / description
Previous value: -"True when values stops short of value_count. Call eia_describe_route again with this facet ID and values_offset set to values_offset + values.length for the next page."New value: +"True when values stops short of values_matched when values_query is set, otherwise of value_count. Call eia_describe_route again with this facet ID, the same values_query, and values_offset set to values_offset + values.length for the next page."
changedOutput schema / properties / notice / description
Previous value: -"Default-frequency date-range context, composed with guidance for exhausted facet windows or unavailable facet values."New value: +"Default-frequency date-range context, composed with guidance for exhausted facet windows, a values_query no value matched, or unavailable facet values."
addedOutput schema / properties / values_query
Added value: +{
+ "description": "The values_query each facet was narrowed by, as matched after trimming. Absent when no values_query was sent.",
+ "type": "string"
+}