addedInput schema / properties / code
Added value: +{
+ "description": "Optional. The code the user named, so a number that exists in several codes returns the right one. An abbreviation or a name: \"CBC\", \"CRC\", \"CFC\", \"CMC\", \"CPC\", \"CEC\", \"CEBC\", \"CALGreen\", \"CHBC\", \"California Fire Code\". Omit when the user gave no code name.",
+ "type": "string"
+}
changedOutput schema / (root)
Previous value: -nullNew value: +{
+ "properties": {
+ "ambiguous": {
+ "description": "True when the number exists in more than one code. Pick by the code the user named and say which one you used; never merge them.",
+ "type": "boolean"
+ },
+ "applied_question_url": {
+ "description": "Where to send a user whose real question is whether a specific project complies.",
+ "type": "string"
+ },
+ "as_of": {
+ "description": "The date the codes were read as of (YYYY-MM-DD), or null for the current edition.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "browse_url": {
+ "type": "string"
+ },
+ "historical": {
+ "description": "True when this is NOT the current code. Say so to the user.",
+ "type": "boolean"
+ },
+ "matches": {
+ "items": {
+ "properties": {
+ "citation": {
+ "description": "Cite exactly this string.",
+ "type": "string"
+ },
+ "document_slug": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "document_title": {
+ "type": "string"
+ },
+ "edition": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "excerpt": {
+ "type": "string"
+ },
+ "excerpt_truncated": {
+ "description": "True when the excerpt is cut short. It is never the whole section.",
+ "type": "boolean"
+ },
+ "heading": {
+ "type": "string"
+ },
+ "kind": {
+ "description": "text: an excerpt of the section's own words. subsection_list: the section has no text of its own and `excerpt` lists its subsections. empty: no text.",
+ "enum": [
+ "text",
+ "subsection_list",
+ "empty"
+ ],
+ "type": "string"
+ },
+ "section_number": {
+ "type": "string"
+ },
+ "source_url": {
+ "description": "Link to the full section. Always show it to the user.",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "document_title",
+ "section_number",
+ "heading",
+ "citation",
+ "source_url",
+ "kind",
+ "excerpt",
+ "excerpt_truncated"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "message": {
+ "description": "Guidance when status is not_found or error.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "query": {
+ "properties": {
+ "code": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "code_edition": {
+ "enum": [
+ "current",
+ "2022",
+ "2019"
+ ],
+ "type": "string"
+ },
+ "jurisdiction": {
+ "type": "string"
+ },
+ "section": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "section",
+ "jurisdiction",
+ "code_edition"
+ ],
+ "type": "object"
+ },
+ "status": {
+ "description": "found: at least one section matched. not_found: nothing matched — do NOT paraphrase a section that was not returned. error: the lookup could not run.",
+ "enum": [
+ "found",
+ "not_found",
+ "error"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "status"
+ ],
+ "type": "object"
+}