From 6c7252cfd1ca042b7661d54dc0d51aacaef114bc Mon Sep 17 00:00:00 2001 From: kodster28 Date: Wed, 14 May 2025 06:42:59 -0500 Subject: [PATCH 1/3] [GraphQL] Add explorer iframe --- .../graphql-api/getting-started/explorer.mdx | 19 ++++++++++++++ .../graphql-api/getting-started/index.mdx | 25 ++++++++----------- 2 files changed, 30 insertions(+), 14 deletions(-) create mode 100644 src/content/docs/analytics/graphql-api/getting-started/explorer.mdx diff --git a/src/content/docs/analytics/graphql-api/getting-started/explorer.mdx b/src/content/docs/analytics/graphql-api/getting-started/explorer.mdx new file mode 100644 index 000000000000000..16031f799e68c87 --- /dev/null +++ b/src/content/docs/analytics/graphql-api/getting-started/explorer.mdx @@ -0,0 +1,19 @@ +--- +title: GraphQL explorer +pcx_content_type: reference +sidebar: + order: 1 +tableOfContents: false +--- + +Cloudflare provides a [GraphQL explorer](https://graphql.cloudflare.com/explorer) to learn more about the schema. + +
+ +
diff --git a/src/content/docs/analytics/graphql-api/getting-started/index.mdx b/src/content/docs/analytics/graphql-api/getting-started/index.mdx index 9090f2ce00fc0f2..711ca29efbbddf6 100644 --- a/src/content/docs/analytics/graphql-api/getting-started/index.mdx +++ b/src/content/docs/analytics/graphql-api/getting-started/index.mdx @@ -1,24 +1,24 @@ --- title: Get started -pcx_content_type: get-started +pcx_content_type: navigation sidebar: order: 11 - --- -import { Render } from "~/components" +import { Render } from "~/components"; Use these articles to get started with the Cloudflare GraphQL API: -* [Authentication][1] - walks you through the options and the steps required to +- [GraphQL Explorer][7] +- [Authentication][1] - walks you through the options and the steps required to set up your access to Cloudflare API successfully, -* [Querying basics][2] - brings simple query examples for you to start exploring +- [Querying basics][2] - brings simple query examples for you to start exploring the GraphQL API, -* [Introspect the GraphQL schema][3] - explains how-to surf the schema with +- [Introspect the GraphQL schema][3] - explains how-to surf the schema with GraphQL client, -* [Create a query in a GraphQL client][4] - describes how to build and run a +- [Create a query in a GraphQL client][4] - describes how to build and run a query against the Cloudflare GraphQL API in the GraphQL clients, -* [Use curl to query the GraphQL API][5] - walks you through running a query +- [Use curl to query the GraphQL API][5] - walks you through running a query against the Cloudflare GraphQL API from the command line. For examples of how to build your own GraphQL Analytics dashboard and query @@ -26,17 +26,14 @@ specific information, such as Firewall and Workers events, please refer to [Tutorials][6]. :::note[Data unavailability: Customer Metadata Boundary configuration] - + + ::: [1]: /analytics/graphql-api/getting-started/authentication/ - [2]: /analytics/graphql-api/getting-started/querying-basics/ - [3]: /analytics/graphql-api/getting-started/explore-graphql-schema/ - [4]: /analytics/graphql-api/getting-started/compose-graphql-query/ - [5]: /analytics/graphql-api/getting-started/execute-graphql-query/ - [6]: /analytics/graphql-api/tutorials/ +[7]: /analytics/graphql-api/explorer/ From 47067795cce839c3850b780cb03127dfafd051bd Mon Sep 17 00:00:00 2001 From: kodster28 Date: Wed, 14 May 2025 07:04:05 -0500 Subject: [PATCH 2/3] fix link --- .../docs/analytics/graphql-api/getting-started/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/analytics/graphql-api/getting-started/index.mdx b/src/content/docs/analytics/graphql-api/getting-started/index.mdx index 711ca29efbbddf6..3fa1b0e537ef98b 100644 --- a/src/content/docs/analytics/graphql-api/getting-started/index.mdx +++ b/src/content/docs/analytics/graphql-api/getting-started/index.mdx @@ -36,4 +36,4 @@ specific information, such as Firewall and Workers events, please refer to [4]: /analytics/graphql-api/getting-started/compose-graphql-query/ [5]: /analytics/graphql-api/getting-started/execute-graphql-query/ [6]: /analytics/graphql-api/tutorials/ -[7]: /analytics/graphql-api/explorer/ +[7]: /analytics/graphql-api/get-started/explorer/ From 02dac78d31ca066fa81b2572a02a4de19af16008 Mon Sep 17 00:00:00 2001 From: Kody Jackson Date: Wed, 14 May 2025 07:26:58 -0500 Subject: [PATCH 3/3] Update src/content/docs/analytics/graphql-api/getting-started/index.mdx --- .../docs/analytics/graphql-api/getting-started/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/analytics/graphql-api/getting-started/index.mdx b/src/content/docs/analytics/graphql-api/getting-started/index.mdx index 3fa1b0e537ef98b..65540cdda774eb5 100644 --- a/src/content/docs/analytics/graphql-api/getting-started/index.mdx +++ b/src/content/docs/analytics/graphql-api/getting-started/index.mdx @@ -36,4 +36,4 @@ specific information, such as Firewall and Workers events, please refer to [4]: /analytics/graphql-api/getting-started/compose-graphql-query/ [5]: /analytics/graphql-api/getting-started/execute-graphql-query/ [6]: /analytics/graphql-api/tutorials/ -[7]: /analytics/graphql-api/get-started/explorer/ +[7]: /analytics/graphql-api/getting-started/explorer/