Add @internalapi to clearToken

ktorio · Feb 10, 2025 · b7e4963 · b7e4963
1 parent 5c29a57
commit b7e4963
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 0 deletions.
diff --git a/...ns/ktor-client-auth/common/src/io/ktor/client/plugins/auth/providers/BasicAuthProvider.kt b/...ns/ktor-client-auth/common/src/io/ktor/client/plugins/auth/providers/BasicAuthProvider.kt
@@ -176,6 +176,7 @@ public class BasicAuthProvider(
      *
      * [Report a problem](https://ktor.io/feedback/?fqname=io.ktor.client.plugins.auth.providers.BasicAuthProvider.clearToken)
      */
+    @InternalAPI // TODO KTOR-8180: Provide control over tokens to user code
     public fun clearToken() {
         tokensHolder.clearToken()
     }

diff --git a/...s/ktor-client-auth/common/src/io/ktor/client/plugins/auth/providers/DigestAuthProvider.kt b/...s/ktor-client-auth/common/src/io/ktor/client/plugins/auth/providers/DigestAuthProvider.kt
@@ -231,6 +231,7 @@ public class DigestAuthProvider(
      *
      * [Report a problem](https://ktor.io/feedback/?fqname=io.ktor.client.plugins.auth.providers.DigestAuthProvider.clearToken)
      */
+    @InternalAPI // TODO KTOR-8180: Provide control over tokens to user code
     public fun clearToken() {
         tokenHolder.clearToken()
     }

diff --git a/...ent-plugins/ktor-client-auth/common/test/io/ktor/client/plugins/auth/BasicProviderTest.kt b/...ent-plugins/ktor-client-auth/common/test/io/ktor/client/plugins/auth/BasicProviderTest.kt
@@ -8,6 +8,7 @@ import io.ktor.client.plugins.auth.providers.*
 import io.ktor.client.request.*
 import io.ktor.http.*
 import io.ktor.http.auth.*
+import io.ktor.utils.io.*
 import kotlinx.coroutines.test.runTest
 import kotlin.test.Test
 import kotlin.test.assertEquals
@@ -50,6 +51,7 @@ class BasicProviderTest {
         assertTrue(provider.isApplicable(header), "Provider with capitalized scheme should be applicable")
     }
 
+    @OptIn(InternalAPI::class)
     @Test
     fun `update credentials after clearToken`() = runTest {
         var credentials = BasicAuthCredentials("admin", "admin")