From c8d288671ec130335e58df8c29d1f2e194af4178 Mon Sep 17 00:00:00 2001 From: Arthur Hanson Date: Fri, 29 Mar 2024 11:50:11 -0700 Subject: [PATCH] 15552 graphql docs (#15578) * 15552 update query * 15552 update query * 15552 update query * Update docs/integrations/graphql-api.md Co-authored-by: Jeremy Stretch --------- Co-authored-by: Jeremy Stretch --- docs/integrations/graphql-api.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/integrations/graphql-api.md b/docs/integrations/graphql-api.md index a078bb82a..724e4e73d 100644 --- a/docs/integrations/graphql-api.md +++ b/docs/integrations/graphql-api.md @@ -54,7 +54,11 @@ For more detail on constructing GraphQL queries, see the [Graphene documentation The GraphQL API employs the same filtering logic as the UI and REST API. Filters can be specified as key-value pairs within parentheses immediately following the query name. For example, the following will return only sites within the North Carolina region with a status of active: ``` -{"query": "query {site_list(region:\"north-carolina\", status:\"active\") {name}}"} +query { + site_list(filters: {region: "us-nc", status: "active"}) { + name + } +} ``` In addition, filtering can be done on list of related objects as shown in the following query: @@ -63,7 +67,7 @@ In addition, filtering can be done on list of related objects as shown in the fo device_list { id name - interfaces(enabled: true) { + interfaces(filters: {enabled: true}) { name } }