-
Bug
-
Resolution: Unresolved
-
Major
-
None
-
None
-
None
-
Documentation (Ref Guide, User Guide, etc.)
-
---
-
---
Description
We have identified possible instances of outdated documentation, as follows:
1. The class JaspiConfigurationBuilder was removed. However, the adoc file has not reflect the removal at https://github.com/wildfly/wildfly/blob/main/docs/src/main/asciidoc/_elytron/Elytron_and_Java_Authentication_SPI_for_Containers-JASPI.adoc.
Shouldn’t the reference be removed from the doc? For example, there are the sentences:
Where the configuration was provided either within the WildFly Elytron subsystem or using the `JaspiConfigurationBuilder` API it is possible to associate a control flag with each `ServerAuthModule` - if one is not specified we assume `REQUIRED`. The flags have the following meanings depending on their result.
The sentence can be revised as follow:
Where the configuration was provided within the WildFly Elytron subsystem, it is possible to associate a control flag with each ServerAuthModule - if one is not specified we assume REQUIRED. The flags have the following meanings depending on their result.
2. The method allowSaslMechanisms(String) was removed from org.wildfly.security.auth.client.AuthenticationConfiguration. However, the adoc file has not reflected the removal at https://github.com/wildfly/wildfly/blob/main/docs/src/main/asciidoc/_elytron/Client_Authentication_with_Elytron_Client.adoc.
There are code examples as follows:
//create your authentication configuration
AuthenticationConfiguration adminConfig =
AuthenticationConfiguration.empty()
.useProviders(() -> new Provider[] { new WildFlyElytronProvider() })
.allowSaslMechanisms("DIGEST-MD5")
.useRealm("ManagementRealm")
.useName("administrator")
.usePassword("password1!");
Can the code example be updated to the following examples?
AuthenticationConfiguration adminConfig =
AuthenticationConfiguration.empty()
.useProviders(() -> new Provider[] { new WildFlyElytronProvider() })
.setSaslMechanismSelector(SaslMechanismSelector.NONE.addMechanism("DIGEST-MD5"))
.useRealm("ManagementRealm")
.useName("administrator")
.usePassword("password1!");
About
This is part of a research project that aims to automatically identify outdated API references in documentation in GitHub repositories and update them. We welcome any feedback. Thanks!