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

Update the SmallRye GraphQL Extension documentation #17847

Merged
merged 1 commit into from
Jun 11, 2021
Merged

Update the SmallRye GraphQL Extension documentation #17847

merged 1 commit into from
Jun 11, 2021

Conversation

phillip-kruger
Copy link
Member

@phillip-kruger phillip-kruger commented Jun 10, 2021

Fix #17827

Showing some large Film and Hero DTOs using lots of “dumb” accessors, when replacing them with public fields would work just as well and make the docs shorter and easier to read.

I have changed this to rather use Objects with public fields with a note that Objects with private fields and public getters/setter will also work

Showing @name("filmId") when it's actually optional and we could use the parameter name, inducing me to falsly believe this was required.

In the example the parameter name and the value in the @Name annotation is actually different, so I added a note on that. I also removed the @Name annotations on other examples

I'm told I need to use @Inject Context by https://quarkus.io/guides/smallrye-graphql#context when trying to add it as a query method parameter appeared to Just Work.

@Inject is still useful when using it downstream, i.e in another class, so I added a note on method injection when used within the @GraphQLApi class

Signed-off-by:Phillip Kruger phillip.kruger@gmail.com

Copy link
Member

@gsmet gsmet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggested a few improvements.

docs/src/main/asciidoc/smallrye-graphql.adoc Outdated Show resolved Hide resolved
docs/src/main/asciidoc/smallrye-graphql.adoc Outdated Show resolved Hide resolved
docs/src/main/asciidoc/smallrye-graphql.adoc Outdated Show resolved Hide resolved
Signed-off-by: Phillip Kruger <phillip.kruger@gmail.com>
@phillip-kruger phillip-kruger requested a review from gsmet June 11, 2021 06:26
@phillip-kruger
Copy link
Member Author

Thanks @gsmet !

@phillip-kruger phillip-kruger merged commit d88f128 into quarkusio:main Jun 11, 2021
@quarkus-bot quarkus-bot bot added this to the 2.1 - main milestone Jun 11, 2021
@FroMage
Copy link
Member

FroMage commented Jun 11, 2021

Thanks!

@gsmet gsmet modified the milestones: 2.1 - main, 2.0.0.Final Jun 21, 2021
@phillip-kruger phillip-kruger deleted the smallrye-graphql-guide-update branch August 2, 2021 11:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

GraphQL guide simplifications
3 participants