changedOutput schema / (root)
Previous value: -nullNew value: +{
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "additionalProperties": {},
+ "description": "search_regs result.",
+ "properties": {
+ "cited": {
+ "description": "When the query is a citation: {citation, register_ids}."
+ },
+ "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"
+ },
+ "guidance": {
+ "description": "On a refusal or empty search: the server's explanation.",
+ "type": "string"
+ },
+ "handbook": {
+ "description": "When the query names a whole handbook: its outline."
+ },
+ "hint": {
+ "description": "On an error: the server's explanation.",
+ "type": "string"
+ },
+ "note": {
+ "description": "A note on this result.",
+ "type": "string"
+ },
+ "notice": {
+ "description": "Terms notice: research use only, not legal advice.",
+ "type": "string"
+ },
+ "reason": {
+ "description": "With empty results: empty_query, no_match or no_match_above_threshold.",
+ "type": "string"
+ },
+ "resets": {
+ "description": "On daily_capacity_reached: when capacity resets (00:00 UTC).",
+ "type": "string"
+ },
+ "results": {
+ "description": "Ranked sections, highest rank_score first (may be empty).",
+ "items": {
+ "additionalProperties": {},
+ "properties": {
+ "also_at": {
+ "description": "Same-text copies dropped from the list."
+ },
+ "authority": {
+ "description": "The document and section title.",
+ "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"
+ ]
+ },
+ "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."
+ },
+ "excerpt": {
+ "description": "A verbatim fragment near the match; not the whole rule.",
+ "type": "string"
+ },
+ "mandatory_date": {
+ "description": "On an Update 18 revision: when it becomes mandatory.",
+ "type": "string"
+ },
+ "match": {
+ "description": "all_terms or partial.",
+ "type": "string"
+ },
+ "missing_terms": {
+ "description": "On partial: the query terms this section lacks.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "obligation_id": {
+ "description": "The obligation (section) id.",
+ "type": "string"
+ },
+ "obligation_type": {
+ "description": "note or index: not rule text.",
+ "type": "string"
+ },
+ "other_version": {
+ "description": "On a dual-version section: the other version's obligation_id.",
+ "type": "string"
+ },
+ "rank_score": {
+ "description": "The score results are ordered by.",
+ "type": "number"
+ },
+ "register_id": {
+ "description": "The register id.",
+ "type": "string"
+ },
+ "section": {
+ "description": "The section title.",
+ "type": "string"
+ },
+ "section_status": {
+ "description": "\"deleted\": a deleted-section stub.",
+ "type": "string"
+ },
+ "section_status_date": {
+ "description": "Date of section_status.",
+ "type": "string"
+ },
+ "special_program": {
+ "description": "The special program this section belongs to (ranked x0.5).",
+ "type": "string"
+ },
+ "version": {
+ "description": "On a dual-version FHA section: \"in-force\" or \"update-18-optional\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+}