changedInput schema / properties / agencies / description
Previous value: -"Filter to one or more agencies by Federal Register agency slug (e.g. \"environmental-protection-agency\")."New value: +"Filter to one or more agencies by Federal Register agency slug (e.g. \"environmental-protection-agency\") — lowercase kebab-case, not a name or acronym. Every row lists its agencies with their slugs; read agencies[].slug off a row here or in regulations_search_rules. One unrecognized slug fails the whole request."
changedInput schema / properties / closing_before / description
Previous value: -"Only rules whose comment period closes on or before this date, ISO 8601 (YYYY-MM-DD). Use to find deadlines you need to act on soon."New value: +"Only documents whose comment period closes on or before this date, ISO 8601 (YYYY-MM-DD), a real calendar day. Use to find deadlines you need to act on soon."
changedInput schema / properties / page / description
Previous value: -"Page number (1–50). The FR caps total_pages at 50; with per_page=100 this covers up to 5,000 open rules."New value: +"Page number, default 1. Pages run over the whole open window in closing-date order; totalPages and nextPage in the response say how far it goes."
changedInput schema / properties / page / maximum
Previous value: -50New value: +10000
changedInput schema / properties / per_page / description
Previous value: -"Results per page (2–100, default 20). The Federal Register API treats exactly 1 as its default page size instead of returning one result."New value: +"Documents per page (1–100, default 20)."
changedInput schema / properties / per_page / minimum
Previous value: -2New value: +1
changedInput schema / properties / query / description
Previous value: -"Full-text filter across open rules. Omit to list all rules currently open for comment."New value: +"Full-text filter across open documents. Omit to list every document currently open for comment."
addedInput schema / properties / type
Added value: +{
+ "description": "Document types to include: PRORULE (proposed rules), RULE (final rules that request comment, including direct final and interim final rules), NOTICE (information-collection and other notices with comment periods — a much larger set). Default, and when empty: [\"PRORULE\", \"RULE\"].",
+ "items": {
+ "enum": [
+ "PRORULE",
+ "RULE",
+ "NOTICE"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+}
changedOutput schema / anyOf
Previous value: -[
- {
- "not": {
- "required": [
- "error"
- ]
- },
- "required": [
- "asOf",
- "keyed",
- "results",
- "totalCount"
- ]
- },
- {
- "required": [
- "error"
- ]
- }
-]New value: +[
+ {
+ "not": {
+ "required": [
+ "error"
+ ]
+ },
+ "required": [
+ "asOf",
+ "keyed",
+ "results",
+ "totalCount",
+ "totalPages"
+ ]
+ },
+ {
+ "required": [
+ "error"
+ ]
+ }
+]
addedOutput schema / properties / cap
Added value: +{
+ "description": "The Federal Register document limit that was reached.",
+ "type": "number"
+}
changedOutput schema / properties / error / properties / data / properties / reason / description
Previous value: -"Machine-readable failure mode. Declared by this tool: `upstream_unavailable`: Federal Register returned a 5xx, timed out, or served an HTML error page. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `upstream_unavailable`: Federal Register returned a 5xx, timed out, or served an HTML error page. `invalid_filter`: The Federal Register rejected a filter value — most often an agency name or acronym passed where a slug belongs. Other values are possible when a failure originates below the handler."
changedOutput schema / properties / error / properties / data / properties / reason / examples
Previous value: -[
- "upstream_unavailable"
-]New value: +[
+ "upstream_unavailable",
+ "invalid_filter"
+]
addedOutput schema / properties / nextPage
Added value: +{
+ "description": "Page to request next — present only when documents remain past this page.",
+ "type": "number"
+}
changedOutput schema / properties / notice / description
Previous value: -"Guidance when nothing matched, or that comment counts are unavailable without a key."New value: +"Guidance when nothing matched, when the page is past the end, when the window was truncated, or that comment counts are unavailable without a key."
changedOutput schema / properties / results / description
Previous value: -"Rules open for comment (this page), closing soonest first."New value: +"Documents open for comment on this page, closing soonest first; documents closing the same day are ordered by document number."
changedOutput schema / properties / results / items / description
Previous value: -"One open-for-comment rule."New value: +"One document open for comment."
changedOutput schema / properties / results / items / properties / agencies / description
Previous value: -"Issuing agency names."New value: +"Issuing agencies."
addedOutput schema / properties / results / items / properties / agencies / items / additionalProperties
Added value: +false
addedOutput schema / properties / results / items / properties / agencies / items / description
Added value: +"One issuing agency."
addedOutput schema / properties / results / items / properties / agencies / items / properties
Added value: +{
+ "name": {
+ "description": "Agency name.",
+ "type": "string"
+ },
+ "slug": {
+ "description": "Federal Register agency slug — pass it back as the agencies filter. Null when the Federal Register lists the agency by raw name only, so it cannot be filtered on.",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+}
addedOutput schema / properties / results / items / properties / agencies / items / required
Added value: +[
+ "name",
+ "slug"
+]
changedOutput schema / properties / results / items / properties / agencies / items / type
Previous value: -"string"New value: +"object"
changedOutput schema / properties / results / items / properties / title / description
Previous value: -"Rule title."New value: +"Document title."
changedOutput schema / properties / results / items / properties / type / description
Previous value: -"Document type."New value: +"Document type — \"Proposed Rule\", \"Rule\", or \"Notice\"; \"Unknown\" when unlisted."
changedOutput schema / properties / shown / description
Previous value: -"Results returned on this page."New value: +"Documents returned on this page."
changedOutput schema / properties / totalCount / description
Previous value: -"Total rules open for comment matching the filters."New value: +"Documents open for comment matching the filters — the window the pages run over."
addedOutput schema / properties / totalPages
Added value: +{
+ "description": "Pages in the window at this per_page.",
+ "type": "number"
+}
changedOutput schema / properties / truncated / description
Previous value: -"True when matches exceed the FR 5,000-record navigation ceiling."New value: +"True when the Federal Register reported its 10,000-document maximum, so the window holds only the 10,000 most recently published matches."