API reference sections
Schema
FederatedSearchPage
Type object
Shape
| Field | Type | Description |
|---|---|---|
| hitsrequired | array of FederatedSearchHit | |
| next_cursor | string or null | |
| updating_workspacesrequired | array of string | |
| request_seqrequired | integer (uint64, >= 0) | |
| corrected_query | string or null |
{
"hits": [
{
"hit": {
"workspace": "string",
"workspace_name": "string",
"document": "string",
"node": "string",
"document_kind": "",
"mime": "string",
"kind": "string",
"field": "string",
"title": "string",
"breadcrumb": "string",
"breadcrumb_spans": [
{
"start": 0,
"end": 0
}
],
"snippet": "string",
"spans": [
{
"start": 0,
"end": 0
}
],
"lifecycle": "live",
"trashed_at": 0,
"trashed_by": "string",
"score": 0,
"observed_modified_at_ms": 0,
"workspace_last_used_at_ms": 0
},
"source": "store"
}
],
"next_cursor": "string",
"updating_workspaces": [
"string"
],
"request_seq": 0,
"corrected_query": "string"
}The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.
Generated from contract version 1. Last updated .
