Skip to content

Docs_Service_Search

@api · extends Tiger_Service_Service

Docs_Service_Search — /api search for the docs (powers the ⌘K launcher on both surfaces).

scope=public (default) searches PUBLIC docs and is guest-allowed (the docs are public). scope=admin searches ADMIN docs (the in-app help center) and is admin-only. Each hit gets a ready-to-use, surface-correct url.

Called as { module:'docs', service:'search', method:'query', q:'…', scope:'public'|'admin' }.

Methods

query()

query(array $params): void

Search the docs and return ranked, surface-correct hits over /api.

  • $params array — the request payload (q, optional scope = public|admin)