mirror of
https://github.com/supabase/supabase.git
synced 2026-10-06 01:45:10 +03:00
Charis
df4b1867b8
Add a top-level field to search docs globally. Right now this only
returns Markdown guides (not references, GitHub discussions, or partner
pages.
The full GraphQL schema at this point:
```
schema {
query: RootQueryType
}
type RootQueryType {
"""Get the GraphQL schema for this endpoint"""
schema: String!
"""Search the Supabase docs for content matching a query string"""
searchDocs(query: String!, limit: Int): SearchResultCollection
}
"""A collection of search results containing content from Supabase docs"""
type SearchResultCollection {
"""A list of edges containing nodes in this collection"""
edges: [SearchResultEdge!]!
"""The nodes in this collection, directly accessible"""
nodes: [SearchResult!]!
"""The total count of items available in this collection"""
totalCount: Int!
}
"""An edge in a collection of SearchResults"""
type SearchResultEdge {
"""The SearchResult at the end of the edge"""
node: SearchResult!
}
"""Document that matches a search query"""
interface SearchResult {
"""The title of the matching result"""
title: String
"""The URL of the matching result"""
href: String
"""The full content of the matching result"""
content: String
}
```
Towards DOCS-214
23 lines
615 B
TypeScript
23 lines
615 B
TypeScript
import { GraphQLInterfaceType, GraphQLString } from 'graphql'
|
|
|
|
export const GRAPHQL_FIELD_SEARCH_GLOBAL = 'searchDocs' as const
|
|
|
|
export const GraphQLInterfaceTypeSearchResult = new GraphQLInterfaceType({
|
|
name: 'SearchResult',
|
|
description: 'Document that matches a search query',
|
|
fields: {
|
|
title: {
|
|
type: GraphQLString,
|
|
description: 'The title of the matching result',
|
|
},
|
|
href: {
|
|
type: GraphQLString,
|
|
description: 'The URL of the matching result',
|
|
},
|
|
content: {
|
|
type: GraphQLString,
|
|
description: 'The full content of the matching result',
|
|
},
|
|
},
|
|
})
|