From aa1524f787fb821ea8e6a61d6f0afce12ade5211 Mon Sep 17 00:00:00 2001 From: Lucas Tortora <85233773+lucas-tortora@users.noreply.github.com> Date: Tue, 12 Nov 2024 11:40:14 -0300 Subject: [PATCH] task(devx): Re-added GraphQL docs (#3959) * task(devx): Re-added GraphQL docs * task(devx): fix link * fix link --- .../{_graphql-migration.mdx => graphql-migration.mdx} | 0 .../developer/getting-started/getting-started.mdx | 11 +++-------- .../{_graphql-rpc.mdx => graphql-rpc.mdx} | 0 .../developer/{_graphql-rpc.mdx => graphql-rpc.mdx} | 2 +- docs/content/references/iota-api.mdx | 10 +++++----- .../{_iota-graphql.mdx => iota-graphql.mdx} | 8 ++++---- docs/content/sidebars/references.js | 4 ++-- 7 files changed, 15 insertions(+), 20 deletions(-) rename docs/content/developer/advanced/{_graphql-migration.mdx => graphql-migration.mdx} (100%) rename docs/content/developer/getting-started/{_graphql-rpc.mdx => graphql-rpc.mdx} (100%) rename docs/content/developer/{_graphql-rpc.mdx => graphql-rpc.mdx} (98%) rename docs/content/references/{_iota-graphql.mdx => iota-graphql.mdx} (75%) diff --git a/docs/content/developer/advanced/_graphql-migration.mdx b/docs/content/developer/advanced/graphql-migration.mdx similarity index 100% rename from docs/content/developer/advanced/_graphql-migration.mdx rename to docs/content/developer/advanced/graphql-migration.mdx diff --git a/docs/content/developer/getting-started/getting-started.mdx b/docs/content/developer/getting-started/getting-started.mdx index d1beaeceee3..1596b9d378e 100644 --- a/docs/content/developer/getting-started/getting-started.mdx +++ b/docs/content/developer/getting-started/getting-started.mdx @@ -16,16 +16,11 @@ The guides in this section will guide you as you start your IOTA Rebased journey by [setting up your development environment](iota-environment.mdx), and then move on to [install IOTA](install-iota.mdx). +## GraphQL queries -[//]: # (## GraphQL queries) +Use the GraphQL service for IOTA RPC to interact with on-chain data. -[//]: # () - -[//]: # (Use the GraphQL service for IOTA RPC to interact with on-chain data. ) - -[//]: # () - -[//]: # (Go to [Query IOTA RPC with GraphQL](getting-started/graphql-rpc.mdx).) +Go to [Query IOTA RPC with GraphQL](graphql-rpc.mdx). ## What's Next? diff --git a/docs/content/developer/getting-started/_graphql-rpc.mdx b/docs/content/developer/getting-started/graphql-rpc.mdx similarity index 100% rename from docs/content/developer/getting-started/_graphql-rpc.mdx rename to docs/content/developer/getting-started/graphql-rpc.mdx diff --git a/docs/content/developer/_graphql-rpc.mdx b/docs/content/developer/graphql-rpc.mdx similarity index 98% rename from docs/content/developer/_graphql-rpc.mdx rename to docs/content/developer/graphql-rpc.mdx index 9fb700c8685..6232f00f2a3 100644 --- a/docs/content/developer/_graphql-rpc.mdx +++ b/docs/content/developer/graphql-rpc.mdx @@ -247,7 +247,7 @@ It is an error to apply both a `first` and a `last` limit. ### Examples -To see these principles put into practice, consult the examples for [paginating forwards](getting-started/graphql-rpc.mdx#paginating-checkpoints-forward-five-at-a-time-page-forward) and [paginating backwards](getting-started/graphql-rpc.mdx#paginating-checkpoints-backwards-five-at-a-time-page-back) in the getting started guide. +To see these principles put into practice, consult the examples for [paginating forwards](getting-started/graphql-rpc.mdx#paginating-checkpoints-forward-five-at-a-time) and [paginating backwards](getting-started/graphql-rpc.mdx#paginating-checkpoints-backwards-five-at-a-time) in the getting started guide. ## Limits diff --git a/docs/content/references/iota-api.mdx b/docs/content/references/iota-api.mdx index 9fd2bb0fa22..ac1d15e9f42 100644 --- a/docs/content/references/iota-api.mdx +++ b/docs/content/references/iota-api.mdx @@ -2,13 +2,13 @@ title: IOTA RPC --- -[//]: # (:::info) +:::info -[//]: # () -[//]: # (The IOTA RPC is upgrading from JSON-RPC to GraphQL. See [GraphQL for IOTA RPC](../developer/_graphql-rpc.mdx) for more information.) -[//]: # () -[//]: # (:::) +The IOTA RPC is upgrading from JSON-RPC to GraphQL. See [GraphQL for IOTA RPC](../developer/graphql-rpc.mdx) for more information. + + +::: _IOTAJSON_ is a JSON-based format with restrictions that allow IOTA to align JSON inputs more closely with Move call arguments. diff --git a/docs/content/references/_iota-graphql.mdx b/docs/content/references/iota-graphql.mdx similarity index 75% rename from docs/content/references/_iota-graphql.mdx rename to docs/content/references/iota-graphql.mdx index 6c60bcff812..1e1ca11bf4c 100644 --- a/docs/content/references/_iota-graphql.mdx +++ b/docs/content/references/iota-graphql.mdx @@ -5,7 +5,7 @@ description: GraphQL is a public service for the IOTA RPC that enables you to ef GraphQL for the IOTA RPC is a public service that enables interacting with the IOTA [network](https://iota.io/networkinfo). -To get started with GraphQL for the IOTA RPC, check out the [Getting Started](../developer/getting-started/_graphql-rpc.mdx) guide. If you'd like to learn more about the concepts used in the GraphQL service, check out the [GraphQL](../developer/_graphql-rpc.mdx) for IOTA RPC concepts page. +To get started with GraphQL for the IOTA RPC, check out the [Getting Started](../developer/getting-started/graphql-rpc.mdx) guide. If you'd like to learn more about the concepts used in the GraphQL service, check out the [GraphQL](../developer/graphql-rpc.mdx) for IOTA RPC concepts page. ## Key Types @@ -19,6 +19,6 @@ All GraphQL API elements are accessible via the left sidebar, the following are ## Related links -- [GraphQL migration](../developer/advanced/_graphql-migration.mdx): Migrating to GraphQL guides you through migrating IOTA RPC projects from JSON-RPC to GraphQL. -- [GraphQL quick-start](../developer/getting-started/_graphql-rpc.mdx): Querying IOTA RPC with GraphQL gets you started using GraphQL to query the IOTA RPC for on-chain data. -- [GraphQL concepts](../developer/_graphql-rpc.mdx): GraphQL for IOTA RPC examines the elements of GraphQL that you should know to get the most from the service. +- [GraphQL migration](../developer/advanced/graphql-migration.mdx): Migrating to GraphQL guides you through migrating IOTA RPC projects from JSON-RPC to GraphQL. +- [GraphQL quick-start](../developer/getting-started/graphql-rpc.mdx): Querying IOTA RPC with GraphQL gets you started using GraphQL to query the IOTA RPC for on-chain data. +- [GraphQL concepts](../developer/graphql-rpc.mdx): GraphQL for IOTA RPC examines the elements of GraphQL that you should know to get the most from the service. diff --git a/docs/content/sidebars/references.js b/docs/content/sidebars/references.js index 142c82dc1a0..72e04fe7835 100644 --- a/docs/content/sidebars/references.js +++ b/docs/content/sidebars/references.js @@ -18,7 +18,7 @@ const references = [ id: 'references/iota-api', }, items: [ - /*{ + { type: 'category', label: 'GraphQL', link: { @@ -31,7 +31,7 @@ const references = [ dirName: 'references/iota-api/iota-graphql/reference', }, ], - },*/ + }, { type: 'link', label: 'JSON-RPC',