changedOutput schema / (root)
Previous value: -nullNew value: +{
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "additionalProperties": {},
+ "description": "get_reg result.",
+ "properties": {
+ "also_at": {
+ "description": "Same-text copies of this register.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "authority": {
+ "description": "The document 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"
+ ]
+ },
+ "canonical_id": {
+ "description": "Set when this register is a same-text copy of that register.",
+ "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"
+ },
+ "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"
+ },
+ "note": {
+ "description": "A note on this result.",
+ "type": "string"
+ },
+ "notice": {
+ "description": "Terms notice: research use only, not legal advice.",
+ "type": "string"
+ },
+ "obligation_id": {
+ "description": "Echoed on error.",
+ "type": "string"
+ },
+ "obligations": {
+ "description": "The register's obligations (a manifest, not regulator text).",
+ "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_total": {
+ "description": "Length of the section's text in characters.",
+ "type": "number"
+ },
+ "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."
+ },
+ "mandatory_date": {
+ "description": "On an Update 18 revision: when it becomes mandatory.",
+ "type": "string"
+ },
+ "obligation_id": {
+ "description": "The obligation (section) id.",
+ "type": "string"
+ },
+ "other_version": {
+ "description": "On a dual-version section: the other version's obligation_id.",
+ "type": "string"
+ },
+ "section": {
+ "description": "The section designation or title.",
+ "type": "string"
+ },
+ "version": {
+ "description": "On a dual-version FHA section: \"in-force\" or \"update-18-optional\".",
+ "type": "string"
+ },
+ "will_truncate": {
+ "description": "The section exceeds one 24,000-char page.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "register_id": {
+ "description": "The register id.",
+ "type": "string"
+ },
+ "resets": {
+ "description": "On daily_capacity_reached: when capacity resets (00:00 UTC).",
+ "type": "string"
+ },
+ "status": {
+ "description": "E.g. current, superseded, unknown.",
+ "type": "string"
+ },
+ "superseded_by": {
+ "description": "The replacing register, or null.",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+}