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

Avoid using "Reactive" for Quarkus REST in security doc #43089

Conversation

gsmet
Copy link
Member

@gsmet gsmet commented Sep 6, 2024

Also remove a redundant section.

@quarkus-bot quarkus-bot bot added area/docstyle issues related for manual docstyle review area/documentation labels Sep 6, 2024
@@ -1369,24 +1369,6 @@ As mentioned, use `AccessTokenRequestFilter` if you work with Keycloak or an Ope
You can generate the tokens as described in xref:security-oidc-bearer-token-authentication.adoc#bearer-token-integration-testing[OpenID Connect Bearer Token Integration testing] section.
Prepare the REST test endpoints. You can have the test front-end endpoint, which uses the injected MP REST client with a registered token propagation filter, call the downstream endpoint. For example, see the `integration-tests/resteasy-client-oidc-token-propagation` in the `main` Quarkus repository.
Copy link
Member Author

Choose a reason for hiding this comment

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

Note for this PR but please let's not point to random content in our repo without even giving a link.

Please include some code here as an example.

Copy link
Member

Choose a reason for hiding this comment

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

Hi @gsmet Sure, I must've typed it with the very initial version of this doc, agree it is a bad idea.
How about linking to the corresponding quickstart section, https://quarkus.io/guides/security-openid-connect-client#testing-the-application ? There is a lot of code involved, and the quickstart covers it all for OIDC client and propagation.
If you agree, I can push a commit to your PR adding it.

Copy link
Member

Choose a reason for hiding this comment

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

So we replace integration-tests/resteasy-client-oidc-token-propagation with a link. Let me know what you prefer

Copy link
Member

Choose a reason for hiding this comment

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

Or I can follow up a bit later with dedicated PR, whatever you prefer works for me

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, please do a follow-up!

@quarkus-bot

This comment has been minimized.

@gsmet gsmet force-pushed the improve-security-openid-connect-client-reference.adoc branch from e3ea0bd to 141e84a Compare September 6, 2024 16:23
@gsmet gsmet changed the title Avoid using Reactive for Quarkus REST in security doc Avoid using "Reactive" for Quarkus REST in security doc Sep 6, 2024
Copy link

github-actions bot commented Sep 6, 2024

🙈 The PR is closed and the preview is expired.

@quarkus-bot
Copy link

quarkus-bot bot commented Sep 6, 2024

Status for workflow Quarkus Documentation CI

This is the status report for running Quarkus Documentation CI on commit 141e84a.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

@gsmet gsmet merged commit df61f78 into quarkusio:main Sep 6, 2024
5 checks passed
@quarkus-bot quarkus-bot bot added this to the 3.16 - main milestone Sep 6, 2024
@gsmet gsmet modified the milestones: 3.16 - main, 3.14.3 Sep 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docstyle issues related for manual docstyle review area/documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants