changedOutput schema / (root)
Previous value: -nullNew value: +{
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "additionalProperties": {},
+ "description": "get_obligation 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_offset": {
+ "description": "Where this response starts in the section's text.",
+ "type": "number"
+ },
+ "chars_returned": {
+ "description": "Characters of text in this response.",
+ "type": "number"
+ },
+ "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."
+ },
+ "editorial": {
+ "description": "Reserved; summary is null (the text is not summarized)."
+ },
+ "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"
+ },
+ "figures": {
+ "description": "Figures stated in the text; empty when it states none.",
+ "items": {
+ "additionalProperties": {},
+ "properties": {
+ "as_written": {
+ "description": "The figure as written, when it differs.",
+ "type": "string"
+ },
+ "offset": {
+ "description": "Position in this response's text.",
+ "type": "number"
+ },
+ "unit": {
+ "description": "percent, currency, duration, ratio, age, day_of_period or temperature.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The figure as a number string, e.g. \"43\", \"50/50\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "next_offset": {
+ "description": "The next page's offset, or null when the section ends here.",
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "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})."
+ },
+ "paging": {
+ "additionalProperties": {},
+ "description": "Page N of M.",
+ "properties": {
+ "how": {
+ "description": "The server's paging note.",
+ "type": "string"
+ },
+ "next_offset": {
+ "description": "The next page's offset, or null at the end.",
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "page": {
+ "description": "This page's number, or null past the end.",
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "pages": {
+ "description": "Total pages at this page size.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "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"
+ },
+ "started_mid_section": {
+ "description": "Text before chars_offset is not in this response.",
+ "type": "boolean"
+ },
+ "status": {
+ "description": "E.g. current, superseded, unknown.",
+ "type": "string"
+ },
+ "superseded_by": {
+ "description": "The replacing register, or null.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "truncated": {
+ "description": "More text follows this response.",
+ "type": "boolean"
+ },
+ "verbatim": {
+ "description": "The regulator's exact text, between <<<BEGIN VERBATIM>>> and <<<END VERBATIM>>>.",
+ "type": "string"
+ },
+ "version": {
+ "description": "On a dual-version section: {label: in-force | update-18-optional, dates, note}."
+ },
+ "version_changes": {
+ "description": "With compare_versions: sentences Update 18 deletes and adds, or {error: \"single_version\"}."
+ }
+ },
+ "type": "object"
+}