changedOutput schema / (root)
Previous value: -nullNew value: +{
+ "properties": {
+ "applied_question_url": {
+ "type": "string"
+ },
+ "as_of": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "credits_charged": {
+ "type": "integer"
+ },
+ "hint": {
+ "description": "The search page's own notice about this query (a missing section, a zone code in the wrong city, a code the library does not hold, an address). Tell the user what it says.",
+ "type": [
+ "object",
+ "null"
+ ]
+ },
+ "historical": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "plans_url": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "query": {
+ "properties": {
+ "code_edition": {
+ "enum": [
+ "current",
+ "2022",
+ "2019"
+ ],
+ "type": "string"
+ },
+ "jurisdiction": {
+ "type": "string"
+ },
+ "query": {
+ "type": "string"
+ },
+ "sources": {
+ "items": {
+ "enum": [
+ "federal",
+ "state",
+ "local"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "query",
+ "jurisdiction",
+ "code_edition"
+ ],
+ "type": "object"
+ },
+ "results": {
+ "description": "Ranked best-first. Each excerpt is a short passage, never the whole section.",
+ "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": {
+ "type": "boolean"
+ },
+ "heading": {
+ "type": "string"
+ },
+ "section_number": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "source_url": {
+ "description": "Link to the full section. Always show it.",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "document_title",
+ "heading",
+ "citation",
+ "source_url",
+ "excerpt",
+ "excerpt_truncated"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "section_ref": {
+ "type": [
+ "object",
+ "null"
+ ]
+ },
+ "status": {
+ "description": "found / no_results: the search ran and 1 credit was charged (a search with no results still costs a credit). signin_required: the user must connect their GoCodebook account. credits_required: the account has no search credits left; plans_url is an informational page about GoCodebook plans. rate_limited / error: nothing ran and nothing was charged.",
+ "enum": [
+ "found",
+ "no_results",
+ "signin_required",
+ "credits_required",
+ "rate_limited",
+ "error"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "status"
+ ],
+ "type": "object"
+}