Skip to content

Commit

Permalink
Security doc fix: Broken link and bad code snippet
Browse files Browse the repository at this point in the history 
Update docs/src/main/asciidoc/security-proactive-authentication.adoc

Co-authored-by: Guillaume Smet <guillaume.smet@gmail.com>
  • Loading branch information
@michelle-purcell @gsmet
michelle-purcell and gsmet committed Nov 14, 2023
1 parent c570268 commit b0be8f0
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/src/main/asciidoc/security-proactive-authentication.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ To disable proactive authentication in Quarkus, set the following attribute in t

[source,xml,options="nowrap",role="white-space-pre"]
----
`quarkus.http.auth.proactive=false`
quarkus.http.auth.proactive=false
----

If you disable proactive authentication, the authentication process runs only when an identity is requested.
Expand All @@ -42,7 +42,7 @@ You can still access `SecurityIdentity` synchronously with `public SecurityIdent
The same is also valid for xref:reactive-routes.adoc[Reactive routes] if a route response is synchronous.
====

xref:security-authorization.adoc#standard-security-annotations[Standard security annotations] on CDI beans are not supported on an I/O thread if a non-void secured method returns a value synchronously and proactive authentication is disabled because they need to access `SecurityIdentity`.
xref:security-authorize-web-endpoints-reference.adoc#standard-security-annotations[Standard security annotations] on CDI beans are not supported on an I/O thread if a non-void secured method returns a value synchronously and proactive authentication is disabled because they need to access `SecurityIdentity`.

Check warning on line 45 in docs/src/main/asciidoc/security-proactive-authentication.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'need to'.

Raw Output:
{"message": "[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'need to'.", "location": {"path": "docs/src/main/asciidoc/security-proactive-authentication.adoc", "range": {"start": {"line": 45, "column": 276}}}, "severity": "INFO"}

In the following example, `HelloResource` and `HelloService` are defined.
Any GET request to `/hello` will run on the I/O thread and throw a `BlockingOperationNotAllowedException` exception.
Expand Down

0 comments on commit b0be8f0

Please sign in to comment.