changedInput schema / properties / filter / description
Previous value: -"OData $filter expression (e.g., \"state eq 'TX' and declarationDate ge '2024-01-01T00:00:00.000Z'\"). String values in single quotes."New value: +"OData $filter expression (e.g., \"state eq 'TX' and declarationDate ge '2024-01-01T00:00:00.000Z'\"). String values in single quotes. For a list of values use field in ('a','b'): OpenFEMA rejects filters nested more than 100 levels deep (about 90 chained and/or comparisons) and request URLs past about 8,900 characters."
changedInput schema / properties / limit / description
Previous value: -"Maximum records to return (1–10000, default 100)."New value: +"Maximum records to return (1–10000, default 100). A page also stops at 100,000 characters of records; when either bound leaves matching records out, next_offset names the offset to continue from."
changedInput schema / properties / offset / description
Previous value: -"Pagination offset (default 0)."New value: +"Pagination offset (default 0). Pass the previous page’s next_offset to continue."
changedOutput schema / properties / error / properties / data / properties / reason / description
Previous value: -"Machine-readable failure mode. Declared by this tool: `unknown_dataset`: The dataset name is not in the OpenFEMA dataset catalog. `dataset_not_served`: The OpenFEMA dataset catalog lists the dataset, but OpenFEMA answers its API endpoint with a 404 page. `catalog_unavailable`: The OpenFEMA dataset catalog could not be read, so the dataset API version is unknown. `invalid_filter`: OpenFEMA rejected the filter expression — an unknown field, a value of the wrong type or range, or unparseable syntax. `invalid_select`: OpenFEMA rejected the select list — an unknown field or unparseable syntax. `invalid_orderby`: OpenFEMA rejected the orderby expression — an unknown field or unparseable syntax. `invalid_odata_syntax`: OpenFEMA could not parse the request and did not say whether filter, select, or orderby was at fault. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `unknown_dataset`: The dataset name is not in the OpenFEMA dataset catalog. `dataset_not_served`: The OpenFEMA dataset catalog lists the dataset, but OpenFEMA answers its API endpoint with a 404 page, or the version is past its deprecation date and returns no records. `catalog_unavailable`: The OpenFEMA dataset catalog could not be read, so the dataset API version is unknown. `invalid_filter`: OpenFEMA rejected the filter expression — an unknown field, a value of the wrong type or range, or unparseable syntax. `invalid_select`: OpenFEMA rejected the select list — an unknown field or unparseable syntax. `invalid_orderby`: OpenFEMA rejected the orderby expression — an unknown field or unparseable syntax. `invalid_odata_syntax`: OpenFEMA could not parse the request and did not say whether filter, select, or orderby was at fault. `request_too_long`: The request URL, mostly the filter after percent-encoding, is longer than the roughly 8,900 characters OpenFEMA accepts. `filter_too_complex`: The filter nests more than 100 levels deep, the most OpenFEMA allows; every and/or adds a level. Other values are possible when a failure originates below the handler."
changedOutput schema / properties / error / properties / data / properties / reason / examples
Previous value: -[
- "unknown_dataset",
- "dataset_not_served",
- "catalog_unavailable",
- "invalid_filter",
- "invalid_select",
- "invalid_orderby",
- "invalid_odata_syntax"
-]New value: +[
+ "unknown_dataset",
+ "dataset_not_served",
+ "catalog_unavailable",
+ "invalid_filter",
+ "invalid_select",
+ "invalid_orderby",
+ "invalid_odata_syntax",
+ "request_too_long",
+ "filter_too_complex"
+]
addedOutput schema / properties / next_offset
Added value: +{
+ "description": "Offset of the next page: offset plus returned_count. Present only while matching records remain past this page; pass it as offset to continue.",
+ "type": "number"
+}
changedOutput schema / properties / notice / description
Previous value: -"Guidance on an empty page — filter advice when nothing matches, or the total and last valid offset when offset is at or past the end."New value: +"Paging guidance — the offset to continue from and whether limit or the response budget ended the page, filter advice when nothing matches, or the total and last valid offset when offset is at or past the end — plus OpenFEMA’s notice when the dataset version is deprecated."
changedOutput schema / properties / rows / description
Previous value: -"Records returned from the dataset. Field names depend on the queried dataset."New value: +"Records from offset onward, bounded by limit and by 100,000 characters of records. Field names depend on the queried dataset."