[PR #4626] [MERGED] feat: one click graphql document generation from docs #4879

New issue

Closed

opened 2026-03-17 02:22:29 +03:00 by kerem · 0 comments

kerem commented

2026-03-17 02:22:29 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/hoppscotch/hoppscotch/pull/4626
Author: @anwarulislam
Created: 12/18/2024
Status: ✅ Merged
Merged: 1/30/2025
Merged by: @jamesgeorge007

Base: next ← Head: feat/gql-insert-query

📝 Commits (10+)

d1cc3be feat: revamped graphql schema docs
dd2a01c feat: explorer composable added
e2ad716 feat: added insert query button
1481add feat: added insert argument button
94e02b4 chore: clean up sidebar
4ab1122 feat: insert graphql query
31169ff feat: insert new operation if query is empty
8a2ec3d chore: fix types
3f4800e feat: graphql docs explorer completed
f4383f3 chore: update argument component

📊 Changes

34 files changed (+2014 additions, -371 deletions)

View changed files

📝 packages/hoppscotch-common/locales/en.json (+7 -1)
📝 packages/hoppscotch-common/package.json (+2 -0)
📝 packages/hoppscotch-common/src/components.d.ts (+27 -1)
➕ packages/hoppscotch-common/src/components/app/Markdown.vue (+35 -0)
➕ packages/hoppscotch-common/src/components/graphql/Argument.vue (+88 -0)
➕ packages/hoppscotch-common/src/components/graphql/Arguments.vue (+20 -0)
➕ packages/hoppscotch-common/src/components/graphql/DefaultValue.vue (+34 -0)
➕ packages/hoppscotch-common/src/components/graphql/Directives.vue (+21 -0)
➕ packages/hoppscotch-common/src/components/graphql/DocExplorer.vue (+95 -0)
➕ packages/hoppscotch-common/src/components/graphql/EnumValues.vue (+79 -0)
➕ packages/hoppscotch-common/src/components/graphql/ExplorerSection.vue (+61 -0)
📝 packages/hoppscotch-common/src/components/graphql/Field.vue (+63 -75)
➕ packages/hoppscotch-common/src/components/graphql/FieldDocumentation.vue (+61 -0)
➕ packages/hoppscotch-common/src/components/graphql/FieldLink.vue (+48 -0)
➕ packages/hoppscotch-common/src/components/graphql/Fields.vue (+48 -0)
➕ packages/hoppscotch-common/src/components/graphql/ImplementsInterfaces.vue (+26 -0)
📝 packages/hoppscotch-common/src/components/graphql/Query.vue (+51 -20)
📝 packages/hoppscotch-common/src/components/graphql/RequestOptions.vue (+5 -0)
➕ packages/hoppscotch-common/src/components/graphql/SchemaDocumentation.vue (+105 -0)
➕ packages/hoppscotch-common/src/components/graphql/SchemaSearch.vue (+355 -0)

...and 14 more files

📄 Description

Closes HP-305 #4371

This PR revamp the old schema browser system. And added a new documentation explorer. Added feature to generate GraphQL queries from documentation.

Features Added

Navigate and manage the GraphQL schema using the new Documentation Explorer.
Dynamically add fields to the GraphQL query.
Manage multiple operations (query, mutation, subscription) within a single query.
Maintain cursor position after query modifications.

Known Bug

If we navigate through All Schema Types in the explorer and try to build query, the query might not be valid as the stack order is not correct.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/hoppscotch/hoppscotch/pull/4626 **Author:** [@anwarulislam](https://github.com/anwarulislam) **Created:** 12/18/2024 **Status:** ✅ Merged **Merged:** 1/30/2025 **Merged by:** [@jamesgeorge007](https://github.com/jamesgeorge007) **Base:** `next` ← **Head:** `feat/gql-insert-query` --- ### 📝 Commits (10+) - [`d1cc3be`](https://github.com/hoppscotch/hoppscotch/commit/d1cc3be59290d80c3acea1f5f7b79da12b96d9ef) feat: revamped graphql schema docs - [`dd2a01c`](https://github.com/hoppscotch/hoppscotch/commit/dd2a01cd365d864834a6c70e855670d7d9842e83) feat: explorer composable added - [`e2ad716`](https://github.com/hoppscotch/hoppscotch/commit/e2ad71611d83b323f439cd5962e03646c1a49098) feat: added insert query button - [`1481add`](https://github.com/hoppscotch/hoppscotch/commit/1481adda44fcabee647dda08c0683404ace88668) feat: added insert argument button - [`94e02b4`](https://github.com/hoppscotch/hoppscotch/commit/94e02b4acfdda4b7e72067a971f4d39c8055a325) chore: clean up sidebar - [`4ab1122`](https://github.com/hoppscotch/hoppscotch/commit/4ab1122cf2b3e38c474b4c3dc1604456f99732b7) feat: insert graphql query - [`31169ff`](https://github.com/hoppscotch/hoppscotch/commit/31169ff8d8cbdf52b48168fd8c3cc721a3a78e69) feat: insert new operation if query is empty - [`8a2ec3d`](https://github.com/hoppscotch/hoppscotch/commit/8a2ec3d826a51e2e1f5e3a229263e6180f6c458e) chore: fix types - [`3f4800e`](https://github.com/hoppscotch/hoppscotch/commit/3f4800e90cecee8a8f26a56b984c25a39c4648f0) feat: graphql docs explorer completed - [`f4383f3`](https://github.com/hoppscotch/hoppscotch/commit/f4383f36d7d9527767e5b42f6f103ec21257eae0) chore: update argument component ### 📊 Changes **34 files changed** (+2014 additions, -371 deletions) <details> <summary>View changed files</summary> 📝 `packages/hoppscotch-common/locales/en.json` (+7 -1) 📝 `packages/hoppscotch-common/package.json` (+2 -0) 📝 `packages/hoppscotch-common/src/components.d.ts` (+27 -1) ➕ `packages/hoppscotch-common/src/components/app/Markdown.vue` (+35 -0) ➕ `packages/hoppscotch-common/src/components/graphql/Argument.vue` (+88 -0) ➕ `packages/hoppscotch-common/src/components/graphql/Arguments.vue` (+20 -0) ➕ `packages/hoppscotch-common/src/components/graphql/DefaultValue.vue` (+34 -0) ➕ `packages/hoppscotch-common/src/components/graphql/Directives.vue` (+21 -0) ➕ `packages/hoppscotch-common/src/components/graphql/DocExplorer.vue` (+95 -0) ➕ `packages/hoppscotch-common/src/components/graphql/EnumValues.vue` (+79 -0) ➕ `packages/hoppscotch-common/src/components/graphql/ExplorerSection.vue` (+61 -0) 📝 `packages/hoppscotch-common/src/components/graphql/Field.vue` (+63 -75) ➕ `packages/hoppscotch-common/src/components/graphql/FieldDocumentation.vue` (+61 -0) ➕ `packages/hoppscotch-common/src/components/graphql/FieldLink.vue` (+48 -0) ➕ `packages/hoppscotch-common/src/components/graphql/Fields.vue` (+48 -0) ➕ `packages/hoppscotch-common/src/components/graphql/ImplementsInterfaces.vue` (+26 -0) 📝 `packages/hoppscotch-common/src/components/graphql/Query.vue` (+51 -20) 📝 `packages/hoppscotch-common/src/components/graphql/RequestOptions.vue` (+5 -0) ➕ `packages/hoppscotch-common/src/components/graphql/SchemaDocumentation.vue` (+105 -0) ➕ `packages/hoppscotch-common/src/components/graphql/SchemaSearch.vue` (+355 -0) _...and 14 more files_ </details> ### 📄 Description Closes HP-305 #4371 This PR revamp the old schema browser system. And added a new documentation explorer. Added feature to generate GraphQL queries from documentation. ### Features Added - Navigate and manage the GraphQL schema using the new Documentation Explorer. - Dynamically add fields to the GraphQL query. - Manage multiple operations (query, mutation, subscription) within a single query. - Maintain cursor position after query modifications. ### Known Bug - If we navigate through `All Schema Types` in the explorer and try to build query, the query might not be valid as the stack order is not correct. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>