addedInput schema / properties / array
Added value: +{
+ "description": "Name of one top-level array field of the record to page through by entry — usually one listed in withheld when the record was too large to return whole (e.g. \"dispositions\", \"documents\"). Returns that array's entries from offset while they fit the response budget, in slice, with the record's scalar fields. Omit to fetch the record itself.",
+ "minLength": 1,
+ "type": "string"
+}
addedInput schema / properties / offset
Added value: +{
+ "description": "Entry offset (0-indexed) into array. Requires array; defaults to 0 when array is given. Pass the next_offset a previous slice returned to continue.",
+ "maximum": 9007199254740991,
+ "minimum": 0,
+ "type": "integer"
+}
changedOutput schema / properties / attachedDocumentCount / description
Previous value: -"Number of related filings in the record documents array. Compare against the document_count openfec_search_legal reported for the same record."New value: +"Number of related filings in the record documents array — the full count, whether this response carries them in document, in a slice, or holds them back. Compare against the document_count openfec_search_legal reported for the same record."
changedOutput schema / properties / document / description
Previous value: -"The complete legal document record. Carries the full documents array that openfec_search_legal replaces with a count and category summary, and the complete commission_votes entries it reduces to a vote date and a truncated action, alongside the dispositions and the scalar and date fields (name, type, url, penalty and determination amounts, case dates). Fields present vary by document type."New value: +"The legal document record, fields as upstream sends them — the full documents array openfec_search_legal summarizes, the complete dispositions and commission_votes entries, and the scalar and date fields (name, type, url, penalty and determination amounts, case dates). Whole when it fits the 100,000-byte response budget; otherwise the scalar fields and the arrays that fit, with the rest in withheld. With array set, the record's non-array fields only — the entries are in slice. Fields present vary by document type."
changedOutput schema / properties / error / properties / data / properties / reason / description
Previous value: -"Machine-readable failure mode. Declared by this tool: `legal_document_not_found`: No legal document exists at the requested doc_type and document number. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `legal_document_not_found`: No legal document exists at the requested doc_type and document number. `array_not_in_record`: The array input names a field this record does not carry as an array. `offset_without_array`: offset was given without array, so there is no array for it to index. Other values are possible when a failure originates below the handler."
changedOutput schema / properties / error / properties / data / properties / reason / examples
Previous value: -[
- "legal_document_not_found"
-]New value: +[
+ "legal_document_not_found",
+ "array_not_in_record",
+ "offset_without_array"
+]
addedOutput schema / properties / notice
Added value: +{
+ "description": "How to continue: which arrays were held back and how to page them, where a slice continues, or that an offset ran past the end of its array.",
+ "type": "string"
+}
addedOutput schema / properties / slice
Added value: +{
+ "additionalProperties": false,
+ "description": "A run of the requested array. Present only when array was given.",
+ "properties": {
+ "array": {
+ "description": "The array these entries come from.",
+ "type": "string"
+ },
+ "entries": {
+ "description": "Entries from offset, as many as fit the response budget — at least one while offset is inside the array.",
+ "items": {
+ "description": "One entry, exactly as the record carries it."
+ },
+ "type": "array"
+ },
+ "next_offset": {
+ "description": "Offset that continues the array. Absent once the last entry is here.",
+ "type": "number"
+ },
+ "offset": {
+ "description": "Offset (0-indexed) of the first entry here.",
+ "type": "number"
+ },
+ "total": {
+ "description": "Entries in the whole array.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "array",
+ "offset",
+ "total",
+ "entries"
+ ],
+ "type": "object"
+}
addedOutput schema / properties / withheld
Added value: +{
+ "description": "Arrays held back from document because the whole record exceeds the 100,000-byte response budget, smallest first. Page through one by re-calling with array set to its name. Absent when document is the whole record.",
+ "items": {
+ "additionalProperties": false,
+ "description": "One array held back from document.",
+ "properties": {
+ "array": {
+ "description": "Name of the array field held back — pass it as array.",
+ "type": "string"
+ },
+ "bytes": {
+ "description": "Size of the whole array as JSON, in UTF-8 bytes.",
+ "type": "number"
+ },
+ "count": {
+ "description": "Entries in the array.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "array",
+ "count",
+ "bytes"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+}