Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

embed graphiQL Console in the query-dashboards-workbench #59

Open
YANG-DB opened this issue Jan 10, 2023 · 1 comment
Open

embed graphiQL Console in the query-dashboards-workbench #59

YANG-DB opened this issue Jan 10, 2023 · 1 comment
Assignees

Comments

@YANG-DB
Copy link
Member

YANG-DB commented Jan 10, 2023

In the query workbench plugin (https://github.com/opensearch-project/dashboards-query-workbench)
Add a new GraphQL tab in addition to SQL/PPL/GraphQL query workbench which will contain the next open-
source component https://github.com/graphql/graphiql console

@YANG-DB YANG-DB converted this from a draft issue Jan 10, 2023
@ps48 ps48 self-assigned this Jan 17, 2023
@ps48
Copy link
Member

ps48 commented Jan 17, 2023

As of now, Graphiql provides three high level react components as follows:

The GraphiQLProvider components renders multiple context providers that encapsulate all state management
The GraphiQLInterface component renders the UI that makes up GraphiQL
The GraphiQL component is a combination of both the above components

To use the GraphiQL component, only requirement is to provide a graphql compatible endpoint. To add this to a Dashboards plugins we can create a pass through via node-hapi to the OpenSearch simple-scema endpoint.

Ref: https://github.com/graphql/graphiql/tree/main/packages/graphiql#usage

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Todo
Development

No branches or pull requests

3 participants