{"openapi":"3.1.0","info":{"title":"Nishi Search API","version":"1.0.0","description":"Sovereign full-text search: a domain's docs + site pages, the nishi library, and the crawled open web. Integer BM25 (b=0.75), stemmed recall, phrase/boolean queries, did-you-mean. Zero third-party dependencies.","x-notes":"cid is a STRING: 63-bit content ids exceed JSON 2^53 safe-integer range."},"servers":[{"url":"https://nishifamily.com"}],"paths":{"/api/search":{"get":{"operationId":"search","summary":"Ranked full-text search","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string"},"description":"Query. Supports OR (default), +required, -excluded, \"quoted phrase\", and site:host field scoping (dot-suffix match); terms are stemmed for recall."},{"name":"scope","in":"query","required":false,"schema":{"type":"string","enum":["web","trusted"]},"description":"web = the broad crawled open-web corpus; trusted = resources clients flagged as good references; omit = this site's own corpus."},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":0},"description":"0-based results page, 20 per page."}],"responses":{"200":{"description":"Ranked results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}}}}}},"/api/doc":{"get":{"operationId":"getDoc","summary":"Fetch a document by content id","parameters":[{"name":"cid","in":"query","required":true,"schema":{"type":"string"},"description":"Decimal content id (string)."},{"name":"scope","in":"query","required":false,"schema":{"type":"string","enum":["web"]}}],"responses":{"200":{"description":"The document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Doc"}}}},"400":{"description":"bad_cid"},"404":{"description":"not_found"}}}},"/api/suggest":{"get":{"operationId":"suggest","summary":"Autocomplete term completions","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string"},"description":"Term prefix."},{"name":"scope","in":"query","required":false,"schema":{"type":"string","enum":["web"]}}],"responses":{"200":{"description":"Completions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Suggest"}}}}}}}},"components":{"schemas":{"Result":{"type":"object","properties":{"cid":{"type":"string"},"score":{"type":"integer"},"title":{"type":"string"},"snippet":{"type":"string"},"doc":{"type":"string"},"url":{"type":"string"},"host":{"type":"string"}},"required":["cid","score","title"]},"SearchResponse":{"type":"object","properties":{"v":{"type":"integer"},"query":{"type":"string"},"scope":{"type":"string"},"page":{"type":"integer"},"total":{"type":"integer"},"nresults":{"type":"integer"},"did_you_mean":{"type":"string"},"phrase_exact":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Result"}}},"required":["v","nresults","results"]},"Doc":{"type":"object","properties":{"v":{"type":"integer"},"found":{"type":"boolean"},"cid":{"type":"string"},"url":{"type":"string"},"truncated":{"type":"boolean"},"text":{"type":"string"}}},"Suggest":{"type":"object","properties":{"v":{"type":"integer"},"prefix":{"type":"string"},"suggestions":{"type":"array","items":{"type":"string"}}}}}}}