changedInput schema / properties / item_query / description
Previous value: -"Commodity name to profile (e.g. \"maize\", \"wheat\", \"coffee green\")."New value: +"Commodity name to profile (e.g. \"maize\", \"wheat\", \"coffee green\"). Matched by relevance; the 5 best-matching items are folded into one profile, so a broad name such as \"milk\" is narrowed — the response discloses how many items matched in total."
addedOutput schema / properties / itemsTruncated
Added value: +{
+ "description": "True when the commodity name matched more items than the profile folded in — the profile then covers only the most relevant few.",
+ "type": "boolean"
+}
changedOutput schema / properties / notice / description
Previous value: -"Names any required domain that was not indexed, or other partial-result context."New value: +"Names any required domain that was not indexed, item-resolution truncation, mixed units in the rankings, or other partial-result context."
addedOutput schema / properties / production_trend
Added value: +{
+ "description": "The annual production series for the resolved commodity, summed over countries and items per year and ordered oldest-first. Aggregated in SQL over the complete filtered match, so it is not affected by the canvas staging cap.",
+ "items": {
+ "additionalProperties": false,
+ "description": "One annual trend point.",
+ "properties": {
+ "flags": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Distinct data-quality flags across the summed observations, comma-separated and sorted — commonly A=Official, B=time-series break, E=Estimated, I=Imputed, M=Missing (value cannot exist), T=Unofficial, X=from an international organization, plus others FAOSTAT defines per domain; treat any unrecognized flag as informational, never assume official. Null when no summed observation carried a flag. More than one flag means the total mixes data qualities."
+ },
+ "observations": {
+ "description": "Observations summed into value — read it alongside value, since a change in coverage moves the total independently of production.",
+ "type": "number"
+ },
+ "unit": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Unit of measure for value; null when unspecified. Points are grouped by unit, so a year can appear once per unit rather than summing incomparable quantities."
+ },
+ "value": {
+ "description": "Production summed across every country and resolved item reporting that year.",
+ "type": "number"
+ },
+ "year": {
+ "description": "Observation year.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "year",
+ "value",
+ "observations",
+ "unit",
+ "flags"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+}
addedOutput schema / properties / resolvedItemMatches
Added value: +{
+ "description": "Total items the commodity query matched in QCL, before the 5-item profile cap.",
+ "type": "number"
+}
changedOutput schema / properties / table_name / description
Previous value: -"Canvas table holding the merged production+trade observations (present when spilled)."New value: +"Canvas table holding the staged observations — production plus trade when the trade domain (TCL) is indexed, production only when it is not (present when spilled). The notice names which of the two the table holds."
changedOutput schema / properties / top_exporters / description
Previous value: -"Top exporters by export quantity (empty when trade is not indexed)."New value: +"Top exporters by summed export quantity (empty when trade is not indexed)."
removedOutput schema / properties / top_exporters / items / properties / flag
Removed value: -{
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Data-quality flag — commonly A=Official, B=time-series break, E=Estimated, I=Imputed, M=Missing (value cannot exist), T=Unofficial, X=from an international organization, plus others FAOSTAT defines per domain; treat any unrecognized flag as informational, never assume official. Null when unflagged."
-}
addedOutput schema / properties / top_exporters / items / properties / flags
Added value: +{
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Distinct data-quality flags across the summed observations, comma-separated and sorted — commonly A=Official, B=time-series break, E=Estimated, I=Imputed, M=Missing (value cannot exist), T=Unofficial, X=from an international organization, plus others FAOSTAT defines per domain; treat any unrecognized flag as informational, never assume official. Null when no summed observation carried a flag. More than one flag means the total mixes data qualities."
+}
addedOutput schema / properties / top_exporters / items / properties / observations
Added value: +{
+ "description": "Observations summed into value — one per resolved item reporting that year.",
+ "type": "number"
+}
changedOutput schema / properties / top_exporters / items / properties / unit / description
Previous value: -"Unit of measure; null when unspecified."New value: +"Unit of measure for value; null when unspecified. Rows are grouped by unit, so values in different units are never summed together — a country can appear once per unit."
changedOutput schema / properties / top_exporters / items / properties / value / description
Previous value: -"Export quantity in the latest year present."New value: +"Export quantity summed across the resolved items for this country, in its latest reporting year."
changedOutput schema / properties / top_exporters / items / properties / year / description
Previous value: -"The latest year the ranking is drawn from."New value: +"This country's own latest year with data, computed per country — a country whose series ends earlier still ranks, at its own last reported year."
changedOutput schema / properties / top_exporters / items / required
Previous value: -[
- "area_code",
- "area",
- "value",
- "unit",
- "year",
- "flag"
-]New value: +[
+ "area_code",
+ "area",
+ "value",
+ "observations",
+ "unit",
+ "year",
+ "flags"
+]
changedOutput schema / properties / top_importers / description
Previous value: -"Top importers by import quantity (empty when trade is not indexed)."New value: +"Top importers by summed import quantity (empty when trade is not indexed)."
removedOutput schema / properties / top_importers / items / properties / flag
Removed value: -{
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Data-quality flag — commonly A=Official, B=time-series break, E=Estimated, I=Imputed, M=Missing (value cannot exist), T=Unofficial, X=from an international organization, plus others FAOSTAT defines per domain; treat any unrecognized flag as informational, never assume official. Null when unflagged."
-}
addedOutput schema / properties / top_importers / items / properties / flags
Added value: +{
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Distinct data-quality flags across the summed observations, comma-separated and sorted — commonly A=Official, B=time-series break, E=Estimated, I=Imputed, M=Missing (value cannot exist), T=Unofficial, X=from an international organization, plus others FAOSTAT defines per domain; treat any unrecognized flag as informational, never assume official. Null when no summed observation carried a flag. More than one flag means the total mixes data qualities."
+}
addedOutput schema / properties / top_importers / items / properties / observations
Added value: +{
+ "description": "Observations summed into value — one per resolved item reporting that year.",
+ "type": "number"
+}
changedOutput schema / properties / top_importers / items / properties / unit / description
Previous value: -"Unit of measure; null when unspecified."New value: +"Unit of measure for value; null when unspecified. Rows are grouped by unit, so values in different units are never summed together — a country can appear once per unit."
changedOutput schema / properties / top_importers / items / properties / value / description
Previous value: -"Import quantity in the latest year present."New value: +"Import quantity summed across the resolved items for this country, in its latest reporting year."
changedOutput schema / properties / top_importers / items / properties / year / description
Previous value: -"The latest year the ranking is drawn from."New value: +"This country's own latest year with data, computed per country — a country whose series ends earlier still ranks, at its own last reported year."
changedOutput schema / properties / top_importers / items / required
Previous value: -[
- "area_code",
- "area",
- "value",
- "unit",
- "year",
- "flag"
-]New value: +[
+ "area_code",
+ "area",
+ "value",
+ "observations",
+ "unit",
+ "year",
+ "flags"
+]
changedOutput schema / properties / top_producers / description
Previous value: -"Top producers by production value (countries only)."New value: +"Top producers by summed production (countries only)."
removedOutput schema / properties / top_producers / items / properties / flag
Removed value: -{
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Data-quality flag — commonly A=Official, B=time-series break, E=Estimated, I=Imputed, M=Missing (value cannot exist), T=Unofficial, X=from an international organization, plus others FAOSTAT defines per domain; treat any unrecognized flag as informational, never assume official. Null when unflagged."
-}
addedOutput schema / properties / top_producers / items / properties / flags
Added value: +{
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Distinct data-quality flags across the summed observations, comma-separated and sorted — commonly A=Official, B=time-series break, E=Estimated, I=Imputed, M=Missing (value cannot exist), T=Unofficial, X=from an international organization, plus others FAOSTAT defines per domain; treat any unrecognized flag as informational, never assume official. Null when no summed observation carried a flag. More than one flag means the total mixes data qualities."
+}
addedOutput schema / properties / top_producers / items / properties / observations
Added value: +{
+ "description": "Observations summed into value — one per resolved item reporting that year.",
+ "type": "number"
+}
changedOutput schema / properties / top_producers / items / properties / unit / description
Previous value: -"Unit of measure; null when unspecified."New value: +"Unit of measure for value; null when unspecified. Rows are grouped by unit, so values in different units are never summed together — a country can appear once per unit."
changedOutput schema / properties / top_producers / items / properties / value / description
Previous value: -"Production value in the latest year present."New value: +"Production summed across the resolved items for this country, in its latest reporting year."
changedOutput schema / properties / top_producers / items / properties / year / description
Previous value: -"The latest year the ranking is drawn from."New value: +"This country's own latest year with data, computed per country — a country whose series ends earlier still ranks, at its own last reported year."
changedOutput schema / properties / top_producers / items / required
Previous value: -[
- "area_code",
- "area",
- "value",
- "unit",
- "year",
- "flag"
-]New value: +[
+ "area_code",
+ "area",
+ "value",
+ "observations",
+ "unit",
+ "year",
+ "flags"
+]
changedOutput schema / properties / trend_points / description
Previous value: -"Count of production trend observations analyzed for the resolved commodity. Capped at the 50,000-row staging limit — when truncated is true this is a floor, not the true count."New value: +"Total production observations aggregated into production_trend. Exact — the aggregation runs over the complete filtered match, not a capped page."
changedOutput schema / properties / truncated / description
Previous value: -"True when the producer ranking / trend and/or the staged canvas table were drawn from a set capped at the 50,000-row staging limit — treat the profile as a PARTIAL view and query faostat_query_observations directly (partitioned by year) for the complete series."New value: +"True when the STAGED CANVAS TABLE hit the 50,000-row staging cap and is therefore a PREFIX of the merged observation set — re-query faostat_query_observations partitioned by year to stage the rest. The rankings and production_trend above are SQL aggregates over the complete match and stay exact either way."
changedOutput schema / required
Previous value: -[
- "item_query",
- "resolved_items",
- "top_producers",
- "top_exporters",
- "top_importers",
- "trend_points",
- "spilled",
- "truncated",
- "resolvedItemCodes"
-]New value: +[
+ "item_query",
+ "resolved_items",
+ "top_producers",
+ "top_exporters",
+ "top_importers",
+ "production_trend",
+ "trend_points",
+ "spilled",
+ "truncated",
+ "resolvedItemCodes",
+ "resolvedItemMatches",
+ "itemsTruncated"
+]