-
Notifications
You must be signed in to change notification settings - Fork 3k
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
refactor(graphql): GraphQL Public API Refactor + Documentation #3278
refactor(graphql): GraphQL Public API Refactor + Documentation #3278
Conversation
...com/linkedin/datahub/graphql/types/dashboard/mappers/DashboardUpdateInputSnapshotMapper.java
Show resolved
Hide resolved
rm combined.graphql | ||
touch combined.graphql | ||
echo "Generating combined GraphQL schema..." | ||
echo "# Auto Generated During Docs Build" >> combined.graphql |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why not just do a single >
and drop the rm
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just consistency w/ the lines below?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We finally have a public API! Really excited to see how the community responds.
This PR refactors the GraphQL API mainly addressing conventional consistency concerns. It also adds a bunch of new GraphQL API documentation! Rendered:
Also introduced auto-generated GraphQL Schema Reference documentation. These files are not checked in, but instead generated at build time.
Changes
- entity.graphql: all CRUD operations against a given entity type (create, update, get, list)
- search.graphql: all search and browse related graphql models
- app.graphql: all UI specific graphql models (e.g. appConfig)
- TagUpdateInput -> TagAssociationInput
- TermUpdateInput -> TermAssociationInput
- TagUpdate -> TagUpdateInput
- PolicyUpdate -> PolicyUpdateInput
Breaking GraphQL API changes:
Validated all changes locally.
Coming soon
Let us know which you'd like to see on our Slack :)
Checklist