Insomnia: [Feature Request] Search in GraphQL Documentation

Created on 6 Aug 2019  路  7Comments  路  Source: Kong/insomnia

First off, I want to say THANK YOU for adding in schema documentation! Huge win! I would just like to open this ticket and say it would make it even better if you supported search (really just need to match on type, query, mutation, and subscription names). That would be great! Huge win on adding the schema though!

accepted

Most helpful comment

Yes please, add this!

All 7 comments

馃憢 Thanks for opening your first issue! If you're reporting a 馃悶 bug, please make sure
you include steps to reproduce it. If you're requesting a feature 馃巵, please provide real
use cases that would benefit. 馃應

To help make this a smooth process, please be sure you have first read the
contributing guidelines.

Great suggestion, I totally forgot about search!

Just a reminder, since Search is kind of important. Schemas can get quite large, of course are very detailed, and also the names of actual Interfaces, for example, may not be as simple as expected, depending on GraphQL implementation.

A good search will find CardsSite when its interface for fragment is actually 'cards_cards_site', as a working example...

Insomnia is a very useful tool, and this will make it that much better. Especially for recommending it to help newcomers to GraphQL.

A p.s. - a quite good implementation you could look at is the explore or Playground in Gatsby.

As you can see in the picture, Documentation and Schema are usually separate tabs or links. What you've implemented so far would be called Schema, and that list as mentioned can get very large, not something to be scanned with any ease.

Thus, Documentation would be the interface that has Search. This way you can find what you need without needing to know up front the entire incantation for its name, and then you get also a nicely focused view, on just that item and its contents.

Cheers...

(here, the Documention/Schema panel has come in as an overlay from the right side, hidden to make maximum space for query and results, until you ask for it)

gridsome-playground

Sorry, that example GraphiQL picture and description is actually from Gridsome :)

Yes please, add this!

This would be awesome! It's available in GraphiQL & it is the main reason I not been able to switch over to insomnia :( Which sucks, as it's much better in many other ways! (The environment vars are awesome!)

Was this page helpful?
0 / 5 - 0 ratings