这是indexloc提供的服务，不要输入任何密码
Skip to content

docs: document explain api (close #870) #3739

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 11 commits into from
Feb 3, 2020
Merged

docs: document explain api (close #870) #3739

merged 11 commits into from
Feb 3, 2020

Conversation

@marionschleifer
Copy link
Contributor

@marionschleifer marionschleifer commented Jan 18, 2020

Description

Document the /v1/graphql/explain endpoint.

Affected components

  • Docs

@marionschleifer marionschleifer added s/wip Status: This issue is a work in progress c/docs Related to docs labels Jan 18, 2020
@netlify
Copy link

netlify bot commented Jan 18, 2020 •
edited
Loading

Deploy preview for hasura-docs ready!

Built with commit 833b3e8

https://deploy-preview-3739--hasura-docs.netlify.com

@marionschleifer
Copy link
Contributor Author

marionschleifer commented Jan 18, 2020

@0x777 is there another expression we can use for the object that is returned from the API, other than "Postgres plan"? It's a little confusing because one value inside the returned JSON object is "plan".

@rikinsk I'm not sure if we should move this section under the GraphQL API, since the Explain API is part of the GraphQL API. The disadvantage of that would be that it's probably harder to find and to search for. Let me know your thoughts.

@rikinsk
Copy link
Member

rikinsk commented Jan 21, 2020

@marionschleifer The explain API should be its own thing, I dont think it belongs under the GraphQL API section as this is not user-facing like queries and mutations and will be confusing there.

@netlify
Copy link

netlify bot commented Jan 21, 2020 •
edited
Loading

Deploy preview for hasura-docs ready!

Built with commit 622896e

https://deploy-preview-3739--hasura-docs.netlify.com

@marionschleifer marionschleifer removed the s/wip Status: This issue is a work in progress label Jan 23, 2020
@marionschleifer
Copy link
Contributor Author

marionschleifer commented Jan 23, 2020

@0x777 @rikinsk please add your reviews 🙂

0x777
0x777 reviewed Jan 23, 2020
View reviewed changes
0x777
0x777 reviewed Jan 23, 2020
View reviewed changes
@0x777 0x777 merged commit 2b977bb into hasura:master Feb 3, 2020
@hasura-bot
Copy link
Contributor

hasura-bot commented Feb 3, 2020

Review app https://hge-ci-pull-3739.herokuapp.com is deleted

polRk pushed a commit to polRk/graphql-engine that referenced this pull request Feb 12, 2020
@marionschleifer @polRk
docs: document explain api (close hasura#870) (hasura#3739)
2a3f286
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@0x777 0x777 0x777 approved these changes

@rikinsk rikinsk Awaiting requested review from rikinsk

Assignees

No one assigned

Labels

c/docs Related to docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@marionschleifer @rikinsk @hasura-bot @0x777