changedOutput schema / (root)
Previous value: -nullNew value: +{
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "additionalProperties": {},
+ "description": "find_in_section result.",
+ "properties": {
+ "alias_note": {
+ "description": "Explains resolved_from_alias.",
+ "type": "string"
+ },
+ "authority": {
+ "description": "The document and section title as published.",
+ "type": "string"
+ },
+ "canonical_citation": {
+ "description": "The citation in the regulator's style (e.g. \"4000.1 II.A.5.d\", \"B3-3.3-07\"), or null.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "canonical_id": {
+ "description": "Set when this register is a same-text copy of that register.",
+ "type": "string"
+ },
+ "chars_total": {
+ "description": "The section's total length.",
+ "type": "number"
+ },
+ "content_hash": {
+ "description": "Hash of the stored text.",
+ "type": "string"
+ },
+ "coverage_tier": {
+ "description": "How completely the corpus holds the document.",
+ "type": "string"
+ },
+ "currency": {
+ "description": "null, or a version/status signal {kind, headline, detail, effective_date, mandatory_date, expires_on, as_of, links}; kind e.g. dual-version, pending, revision-pending, superseded, superseded-in-part, modified-by, expired."
+ },
+ "effective_date": {
+ "description": "Effective date, or null.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "error": {
+ "description": "Present only on an error or refusal: not_found, ambiguous, unparsed, empty_terms, unknown_playbook, unknown_reference, offset_out_of_range, daily_capacity_reached.",
+ "type": "string"
+ },
+ "fallback": {
+ "description": "On daily_capacity_reached: where the full corpus can be downloaded.",
+ "type": "string"
+ },
+ "fetched_at": {
+ "description": "When the source was retrieved.",
+ "type": "string"
+ },
+ "guidance": {
+ "description": "On a refusal or empty search: the server's explanation.",
+ "type": "string"
+ },
+ "hint": {
+ "description": "On an error: the server's explanation.",
+ "type": "string"
+ },
+ "matches_note": {
+ "description": "How total_matches became passages_available.",
+ "type": "string"
+ },
+ "merged_into_lists": {
+ "description": "Matching paragraphs merged into lists with their lead-in.",
+ "type": "number"
+ },
+ "merged_into_tables": {
+ "description": "Matching paragraphs merged into whole tables.",
+ "type": "number"
+ },
+ "note": {
+ "description": "A note on this result.",
+ "type": "string"
+ },
+ "notice": {
+ "description": "Terms notice: research use only, not legal advice.",
+ "type": "string"
+ },
+ "obligation_id": {
+ "description": "The obligation (section) id.",
+ "type": "string"
+ },
+ "other_version": {
+ "description": "On a dual-version section: the other version ({obligation_id, version, dates})."
+ },
+ "passages": {
+ "description": "Matching verbatim passages, in section order.",
+ "items": {
+ "additionalProperties": {},
+ "properties": {
+ "canonical_citation": {
+ "description": "The citation in the regulator's style (e.g. \"4000.1 II.A.5.d\", \"B3-3.3-07\"), or null.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "chars": {
+ "description": "The passage's length.",
+ "type": "number"
+ },
+ "continues_at": {
+ "description": "Offset where the table continues, when table_complete is false.",
+ "type": "number"
+ },
+ "heading": {
+ "description": "The nearest heading above (verbatim), or null.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "heading_path": {
+ "description": "Every heading above, joined by \" > \", or null.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "list_included": {
+ "description": "The passage ends in a colon and includes the list it introduces.",
+ "type": "boolean"
+ },
+ "matched_terms": {
+ "description": "The terms this passage matched.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "offset": {
+ "description": "Where the passage starts in the section's text.",
+ "type": "number"
+ },
+ "table": {
+ "description": "The passage is a whole table.",
+ "type": "boolean"
+ },
+ "table_complete": {
+ "description": "false when the table may continue past the passage.",
+ "type": "boolean"
+ },
+ "table_layout": {
+ "description": "\"flattened\": the source lost its table layout; cells may not line up.",
+ "type": "string"
+ },
+ "verbatim": {
+ "description": "The regulator's exact text.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "passages_available": {
+ "description": "Passages the matches make (tables and lists merged).",
+ "type": "number"
+ },
+ "passages_returned": {
+ "description": "Passages in this response.",
+ "type": "number"
+ },
+ "register_id": {
+ "description": "The register (source document) id.",
+ "type": "string"
+ },
+ "resets": {
+ "description": "On daily_capacity_reached: when capacity resets (00:00 UTC).",
+ "type": "string"
+ },
+ "resolved_from_alias": {
+ "description": "The retired obligation id requested; its text is now at obligation_id.",
+ "type": "string"
+ },
+ "section": {
+ "description": "The section designation.",
+ "type": "string"
+ },
+ "snapshot_id": {
+ "description": "The stored source snapshot.",
+ "type": "string"
+ },
+ "source_url": {
+ "description": "The regulator's URL for the document.",
+ "type": "string"
+ },
+ "status": {
+ "description": "E.g. current, superseded, unknown.",
+ "type": "string"
+ },
+ "superseded_by": {
+ "description": "The replacing register, or null.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "terms": {
+ "description": "Per-term match counts.",
+ "items": {
+ "additionalProperties": {},
+ "properties": {
+ "expanded_to": {
+ "description": "Spellings and abbreviations it expanded to."
+ },
+ "paragraphs": {
+ "description": "Paragraphs containing it.",
+ "type": "number"
+ },
+ "term": {
+ "description": "The term as given.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "toc_omitted": {
+ "description": "The section's table-of-contents line was omitted.",
+ "type": "boolean"
+ },
+ "total_matches": {
+ "description": "Matching paragraphs.",
+ "type": "number"
+ },
+ "truncated": {
+ "description": "More passages matched than were returned.",
+ "type": "boolean"
+ },
+ "version": {
+ "description": "On a dual-version section: {label: in-force | update-18-optional, dates, note}."
+ }
+ },
+ "type": "object"
+}