Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(docs): Add correct usage of orFilters in search API docs #11082

Merged
merged 2 commits into from
Aug 5, 2024
Merged

fix(docs): Add correct usage of orFilters in search API docs #11082

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
11cbd8c
Add correct usage of orFilters in search API docs
gabe-lyons Aug 2, 2024
1f75ea8
Merge branch 'master' into gabe-lyons-patch-2
jayacryl Aug 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 25 additions & 7 deletions docs/how/search.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,24 +148,42 @@ The same GraphQL API that powers the Search UI can be used
for integrations and programmatic use-cases.

```
# Example query
{
searchAcrossEntities(
input: {types: [], query: "*", start: 0, count: 10, filters: [{field: "fieldTags", value: "urn:li:tag:Dimension"}]}
# Example query - search for datasets matching the example_query_text who have the Dimension tag applied to a schema field and are from the data platform looker
query searchEntities {
search(
input: {
type: DATASET,
query: "example_query_text",
orFilters: [
{
and: [
{
field: "fieldTags",
values: ["urn:li:tag:Dimension"]
},
{
field: "platform",
values: ["urn:li:dataPlatform:looker"]
}
]
}
],
start: 0,
count: 10
}
) {
start
count
total
searchResults {
entity {
urn
type
... on Dataset {
urn
type
name
platform {
name
}
name
}
}
}
Expand Down
Loading