docs_search
Operation defined in Documentation
docs_searchv1.0.0experimental
Schema Definition
Search and filter DocBlocks by query, tag, or visibility.
Input Schema
{
"name": "DocsIndexInput",
"fields": {
"query": {
"typeName": "String_unsecure",
"isOptional": true
},
"tag": {
"typeName": "String_unsecure",
"isOptional": true,
"isArray": true
},
"visibility": {
"typeName": "String_unsecure",
"isOptional": true
},
"kind": {
"typeName": "String_unsecure",
"isOptional": true
},
"limit": {
"typeName": "Int_unsecure",
"isOptional": true
},
"offset": {
"typeName": "Int_unsecure",
"isOptional": true
}
}
}Output Schema
{
"name": "DocsIndexOutput",
"fields": {
"items": {
"typeName": "DocSummary",
"isOptional": true,
"isArray": true
},
"docs": {
"typeName": "DocSummary",
"isOptional": false,
"isArray": true
},
"total": {
"typeName": "Int_unsecure",
"isOptional": true
},
"nextOffset": {
"typeName": "Int_unsecure",
"isOptional": true
}
}
}Metadata
- Key
- docs_search
- Version
- 1.0.0
- Context
- Used by docs surfaces to list and filter DocBlocks without coupling to storage.
- Owners
- docs-platform
- Tags
- #docs#documentation#search#index
