changedOutput schema / (root)
Previous value: -nullNew value: +{
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "additionalProperties": {},
+ "description": "lookup_citation result.",
+ "properties": {
+ "also_at": {
+ "description": "Identical copies of the section (other register ids).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "also_at_note": {
+ "description": "Explains also_at.",
+ "type": "string"
+ },
+ "candidates": {
+ "description": "On ambiguous: the registers the citation could mean.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "canonical_id": {
+ "description": "Set when the register is a same-text copy of that register.",
+ "type": "string"
+ },
+ "citation": {
+ "description": "The citation as given (on unparsed).",
+ "type": "string"
+ },
+ "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 citation 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"
+ },
+ "parsed": {
+ "description": "The parse of the citation ({kind, canonical, ...})."
+ },
+ "register_id": {
+ "description": "The register the citation resolves to.",
+ "type": "string"
+ },
+ "related": {
+ "description": "Documents that cite or amend the section ({register_id, relation}); not its text."
+ },
+ "related_note": {
+ "description": "Explains related.",
+ "type": "string"
+ },
+ "renumbered_from": {
+ "description": "The old register, when the section was renumbered.",
+ "type": "string"
+ },
+ "resets": {
+ "description": "On daily_capacity_reached: when capacity resets (00:00 UTC).",
+ "type": "string"
+ },
+ "superseded_candidates": {
+ "description": "Candidates dropped because a current register replaces them.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "superseded_register_id": {
+ "description": "The register holding the prior text of this section.",
+ "type": "string"
+ },
+ "topics": {
+ "description": "Topics under a structured citation."
+ },
+ "truncated": {
+ "description": "The candidate scan hit its limit.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+}