changedInput schema / properties / ao_number / description
Previous value: -"Specific advisory opinion number (e.g. \"2024-01\")."New value: +"Specific advisory opinion number (e.g. \"2024-01\"). Applies to advisory_opinions only: rejected with any other type, and with type omitted only advisory opinions are returned."
changedInput schema / properties / case_number / description
Previous value: -"Specific MUR or ADR case number."New value: +"Specific MUR, ADR, or administrative fine case number (e.g. \"8343\"). Applies to murs, adrs, and admin_fines: rejected with advisory_opinions or statutes, and with type omitted only those three types are returned."
changedInput schema / properties / from_hit / description
Previous value: -"Offset for pagination (0-indexed), counted within each document type rather than across them. Default 0. The search index serves a 10,000-result window, so from_hit plus hits_returned must be 10,000 or less — the ceiling here assumes hits_returned of 1."New value: +"Offset for pagination (0-indexed), counted within each document type rather than across them. Default 0. When a response is bounded, nextFromHit gives the value that continues each type. The search index serves a 10,000-result window, so from_hit plus hits_returned must be 10,000 or less — the ceiling here assumes hits_returned of 1."
changedInput schema / properties / hits_returned / description
Previous value: -"Results per page, applied per document type. Default 20, max 200. Bounded together with from_hit by the 10,000-result window."New value: +"Results per page, applied per document type. Default 20, max 200. A response is held to 100,000 bytes, so a page of large records can carry fewer, with nextFromHit naming where each type continues. Bounded together with from_hit by the 10,000-result window."
changedInput schema / properties / max_penalty_amount / description
Previous value: -"Maximum penalty amount in dollars. Filters enforcement cases (murs, adrs) only — other document types are returned unfiltered by it."New value: +"Maximum penalty amount in dollars. Applies to murs, adrs, and admin_fines (an administrative fine matches on its reason-to-believe or final-determination amount): rejected with advisory_opinions or statutes, and with type omitted only those three types are returned."
changedInput schema / properties / min_penalty_amount / description
Previous value: -"Minimum penalty amount in dollars. Filters enforcement cases (murs, adrs) only — other document types are returned unfiltered by it."New value: +"Minimum penalty amount in dollars. Applies to murs, adrs, and admin_fines (an administrative fine matches on its reason-to-believe or final-determination amount): rejected with advisory_opinions or statutes, and with type omitted only those three types are returned."
changedInput schema / properties / regulatory_citation / description
Previous value: -"CFR citation (e.g. \"11 CFR 112.4\")."New value: +"CFR citation in the form \"<title> CFR <part>.<section>\" (e.g. \"11 CFR 110.1\"; \"C.F.R.\", \"§\", and a suffix such as \"110.1(b)\" are accepted — a bare \"110.1\" is rejected as invalid_citation). One citation per value: \"11 CFR 110.1; 11 CFR 110.2\" is rejected, since only the first would be applied. Given with statutory_citation, matches a document that cites either one. On murs and adrs it cannot be combined with case_number, respondent, a penalty bound, or an open_date or close_date bound, which the search index would ignore. Applies to advisory_opinions, murs, and adrs: rejected with admin_fines or statutes, and with type omitted only those three types are returned."
changedInput schema / properties / respondent / description
Previous value: -"Respondent name (enforcement cases)."New value: +"Respondent name. Applies to enforcement cases (murs, adrs) only: rejected with any other type, and with type omitted only MURs and ADRs are returned."
changedInput schema / properties / statutory_citation / description
Previous value: -"U.S.C. citation (e.g. \"52 U.S.C. 30106\")."New value: +"U.S.C. citation in the form \"<title> U.S.C. <section>\" (e.g. \"52 U.S.C. 30104\"; \"USC\", \"§\", and a suffix such as \"30104(g)\" are accepted — a bare \"30104\" is rejected as invalid_citation). One citation per value: \"52 U.S.C. 30104, 52 U.S.C. 30118\" is rejected, since only the first would be applied. Given with regulatory_citation, matches a document that cites either one. On murs and adrs it cannot be combined with case_number, respondent, a penalty bound, or an open_date or close_date bound, which the search index would ignore. Applies to advisory_opinions, murs, and adrs: rejected with admin_fines or statutes, and with type omitted only those three types are returned."
changedInput schema / properties / type / description
Previous value: -"Document type filter. Omit to search all types. admin_fines is slow without a query or respondent filter."New value: +"Document type filter. Omit to search every type the other filters apply to — all five when only query is given. admin_fines can be slow without a query."
changedOutput schema / properties / error / properties / data / properties / reason / description
Previous value: -"Machine-readable failure mode. Declared by this tool: `missing_filter`: Called without any scoping filter at all. `date_filter_incomplete`: min_date or max_date given without both a type and a date_kind, or a date_kind given with neither bound. `date_kind_not_valid_for_type`: The requested date_kind is not a date this document type records. `legal_window_exceeded`: from_hit plus hits_returned exceeds the 10,000-result window the search index serves. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `missing_filter`: Called without any scoping filter at all. `date_filter_incomplete`: min_date or max_date given without both a type and a date_kind, or a date_kind given with neither bound. `date_kind_not_valid_for_type`: The requested date_kind is not a date this document type records. `filter_not_valid_for_type`: A type-specific filter was sent with a type it does not filter, or type-specific filters that no single document type accepts together — including a citation with case_number, respondent, a penalty bound, or an open_date or close_date bound on murs or adrs. `invalid_citation`: A citation is not in a form the search index parses, so upstream would ignore it and return the type unfiltered, or a value holds a second citation upstream would ignore. `legal_window_exceeded`: from_hit plus hits_returned exceeds the 10,000-result window the search index serves. Other values are possible when a failure originates below the handler."
changedOutput schema / properties / error / properties / data / properties / reason / examples
Previous value: -[
- "missing_filter",
- "date_filter_incomplete",
- "date_kind_not_valid_for_type",
- "legal_window_exceeded"
-]New value: +[
+ "missing_filter",
+ "date_filter_incomplete",
+ "date_kind_not_valid_for_type",
+ "filter_not_valid_for_type",
+ "invalid_citation",
+ "legal_window_exceeded"
+]
addedOutput schema / properties / nextFromHit
Added value: +{
+ "additionalProperties": {
+ "type": "number"
+ },
+ "description": "The from_hit that continues each document type with results held back, keyed by the value to pass as type (advisory_opinions, murs, adrs, admin_fines, statutes). Re-call with the same filters, that type, and this from_hit. Present only when truncated is true.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+}
changedOutput schema / properties / notice / description
Previous value: -"Guidance when the response carries no legal documents: how to broaden a search that matched nothing, or that from_hit ran past the end when documents did match."New value: +"Guidance on the page returned: how to broaden a search that matched nothing, that from_hit ran past the end when documents did match, or — when truncated is set — how each document type continues."
changedOutput schema / properties / results / description
Previous value: -"Legal document result set spanning advisory opinions, MURs, ADRs, admin fines, and statutes."New value: +"Legal document result set spanning advisory opinions, MURs, ADRs, admin fines, and statutes — only the types searched. Grouped by type in upstream order; when truncated is set, each type holds its first results up to the response budget."
changedOutput schema / properties / results / items / description
Previous value: -"Legal document record. The document_type field discriminates among advisory_opinion, mur, adr, admin_fine, and statute. Common fields include no (the identifier every type carries, and the one openfec_get_legal_document takes; advisory opinions repeat it as ao_no), name, document_type, document_count, and document_categories summarizing the related filings."New value: +"Legal document record. The document_type field discriminates among advisory_opinion, mur, adr, admin_fine, and statute. Common fields include no (the identifier every type carries, and the one openfec_get_legal_document takes; advisory opinions repeat it as ao_no), name, document_type, document_count and document_categories summarizing the related filings, and disposition_count and disposition_categories summarizing the dispositions."
addedOutput schema / properties / shown
Added value: +{
+ "description": "Results in this response. Present only when truncated is true.",
+ "type": "number"
+}
changedOutput schema / properties / totalCount / description
Previous value: -"Total matching legal documents across all types."New value: +"Total matching legal documents across the document types searched."
changedOutput schema / properties / total_count / description
Previous value: -"Total matching documents across all types."New value: +"Total matching documents across the types searched: the requested type, or with type omitted, every type the supplied filters apply to."
addedOutput schema / properties / truncated
Added value: +{
+ "description": "True when results upstream returned for this page were held back because the next one would take the response past its 100,000-byte budget. Absent when the page is complete, including a naturally short page and an offset past the end.",
+ "type": "boolean"
+}