changedOutput schema / (root)
Previous value: -nullNew value: +{
+ "properties": {
+ "correctedQuery": {
+ "description": "Set only when nothing matched the query and these are results for a corrected spelling of it.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "hits": {
+ "items": {
+ "properties": {
+ "componentName": {
+ "type": "string"
+ },
+ "componentSlug": {
+ "description": "Pass to get_component or get_doc_page.",
+ "type": "string"
+ },
+ "section": {
+ "description": "The documentation section, on a doc hit; null on a component hit.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "snippet": {
+ "description": "The matching text, with the site's highlight markup stripped.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "title": {
+ "type": "string"
+ },
+ "type": {
+ "description": "A control, or a page of its documentation.",
+ "enum": [
+ "component",
+ "doc"
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "Absolute URL of the page, for citing.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "title",
+ "componentSlug",
+ "componentName",
+ "url"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "query": {
+ "description": "The query as it was searched.",
+ "type": "string"
+ },
+ "total": {
+ "description": "How many results matched, which may be more than were returned.",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "query",
+ "total",
+ "hits"
+ ],
+ "type": "object"
+}