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

documentation: Improve the deprecation messages surrounding the GraphQLClient methods. #693

Closed
berngp opened this issue Oct 12, 2021 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@berngp
Copy link
Contributor

berngp commented Oct 12, 2021

What are you missing in the docs

The @Deprecated("The RequestExecutor should be provided while creating the implementation.", ReplaceWith("Example: new DefaultGraphQLClient(url, requestExecutor);")) points toDefaultGraphQLClient, which is deprecated as well.
We need to suggest either CustomGraphQLClient, CustomReactiveGraphQLClient and WebClientGraphQLClient.

Creating a guide on when to use each of the clients mentioned above will help as well as provide examples of migrating from the deprecated method calls to the new clients.

@berngp berngp added the documentation Improvements or additions to documentation label Oct 12, 2021
@berngp berngp self-assigned this Oct 12, 2021
@paulbakker
Copy link
Collaborator

I think the guide is already there: https://netflix.github.io/dgs/advanced/java-client/#usage

@berngp
Copy link
Contributor Author

berngp commented Nov 10, 2021

I think we are just missing a simple change in the GraphQLClient.kt file. Right now it reads...

graphql-dgs-client/src/main/kotlin/com/netflix/graphql/dgs/client/GraphQLClient.kt
59:    @Deprecated("The RequestExecutor should be provided while creating the implementation.", ReplaceWith("Example: new DefaultGraphQLClient(url, requestExecutor);"))
62:    @Deprecated("The RequestExecutor should be provided while creating the implementation.", ReplaceWith("Example: new DefaultGraphQLClient(url, requestExecutor);"))
116:    @Deprecated("The RequestExecutor should be provided while creating the implementation.", ReplaceWith("Example: new DefaultGraphQLClient(url, requestExecutor);"))
123:    @Deprecated("The RequestExecutor should be provided while creating the implementation.", ReplaceWith("Example: new DefaultGraphQLClient(url, requestExecutor);"))

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants