Skip to content

Commit 01b14a8

Browse files
authored
KTOR-8982 Update API docs links (#702)
1 parent 3b18f7e commit 01b14a8

File tree

104 files changed

+306
-306
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

104 files changed

+306
-306
lines changed

codeSnippets/snippets/_misc_client/AndroidConfig.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import java.net.InetSocketAddress
55

66
val client = HttpClient(Android) {
77
engine {
8-
// this: [[[AndroidEngineConfig|https://api.ktor.io/ktor-client/ktor-client-android/io.ktor.client.engine.android/-android-engine-config/index.html]]]
8+
// this: [[[AndroidEngineConfig|https://api.ktor.io/ktor-client-android/io.ktor.client.engine.android/-android-engine-config/index.html]]]
99
connectTimeout = 100_000
1010
socketTimeout = 100_000
1111
proxy = Proxy(Proxy.Type.HTTP, InetSocketAddress("localhost", 8080))

codeSnippets/snippets/_misc_client/ApacheConfig.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import org.apache.http.HttpHost
44

55
val client = HttpClient(Apache) {
66
engine {
7-
// this: [[[ApacheEngineConfig|https://api.ktor.io/ktor-client/ktor-client-apache/io.ktor.client.engine.apache/-apache-engine-config/index.html]]]
7+
// this: [[[ApacheEngineConfig|https://api.ktor.io/ktor-client-apache/io.ktor.client.engine.apache/-apache-engine-config/index.html]]]
88
followRedirects = true
99
socketTimeout = 10_000
1010
connectTimeout = 10_000

codeSnippets/snippets/_misc_client/BasicEngineConfigExample.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
HttpClient() {
22
engine {
3-
// this: [[[HttpClientEngineConfig|https://api.ktor.io/ktor-client/ktor-client-core/io.ktor.client.engine/-http-client-engine-config/index.html]]]
3+
// this: [[[HttpClientEngineConfig|https://api.ktor.io/ktor-client-core/io.ktor.client.engine/-http-client-engine-config/index.html]]]
44
threadsCount = 4
55
pipelining = true
66
}

codeSnippets/snippets/_misc_client/CioConfig.kt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@ import io.ktor.network.tls.*
44

55
val client = HttpClient(CIO) {
66
engine {
7-
// this: [[[CIOEngineConfig|https://api.ktor.io/ktor-client/ktor-client-cio/io.ktor.client.engine.cio/-c-i-o-engine-config/index.html]]]
7+
// this: [[[CIOEngineConfig|https://api.ktor.io/ktor-client-cio/io.ktor.client.engine.cio/-c-i-o-engine-config/index.html]]]
88
maxConnectionsCount = 1000
99
endpoint {
10-
// this: [[[EndpointConfig|https://api.ktor.io/ktor-client/ktor-client-cio/io.ktor.client.engine.cio/-endpoint-config/index.html]]]
10+
// this: [[[EndpointConfig|https://api.ktor.io/ktor-client-cio/io.ktor.client.engine.cio/-endpoint-config/index.html]]]
1111
maxConnectionsPerRoute = 100
1212
pipelineMaxSize = 20
1313
keepAliveTime = 5000
1414
connectTimeout = 5000
1515
connectAttempts = 5
1616
}
1717
https {
18-
// this: [[[TLSConfigBuilder|https://api.ktor.io/ktor-network/ktor-network-tls/io.ktor.network.tls/-t-l-s-config-builder/index.html]]]
18+
// this: [[[TLSConfigBuilder|https://api.ktor.io/ktor-network-tls/io.ktor.network.tls/-t-l-s-config-builder/index.html]]]
1919
serverName = "api.ktor.io"
2020
cipherSuites = CIOCipherSuites.SupportedSuites
2121
trustManager = myCustomTrustManager

codeSnippets/snippets/_misc_client/JavaConfig.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import io.ktor.client.engine.java.*
44

55
val client = HttpClient(Java) {
66
engine {
7-
// this: [[[JavaHttpConfig|https://api.ktor.io/ktor-client/ktor-client-java/io.ktor.client.engine.java/-java-http-config/index.html]]]
7+
// this: [[[JavaHttpConfig|https://api.ktor.io/ktor-client-java/io.ktor.client.engine.java/-java-http-config/index.html]]]
88
threadsCount = 8
99
pipelining = true
1010
proxy = ProxyBuilder.http("http://proxy-server.com/")

codeSnippets/snippets/_misc_client/JettyConfig.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import org.eclipse.jetty.util.ssl.SslContextFactory
44

55
val client = HttpClient(Jetty) {
66
engine {
7-
// this: [[[JettyEngineConfig|https://api.ktor.io/ktor-client/ktor-client-jetty-jakarta/io.ktor.client.engine.jetty.jakarta/-jetty-engine-config/index.html]]]
7+
// this: [[[JettyEngineConfig|https://api.ktor.io/ktor-client-jetty-jakarta/io.ktor.client.engine.jetty.jakarta/-jetty-engine-config/index.html]]]
88
sslContextFactory = SslContextFactory.Client()
99
clientCacheSize = 12
1010
}

codeSnippets/snippets/_misc_client/OkHttpConfig.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import io.ktor.client.engine.okhttp.*
33

44
val client = HttpClient(OkHttp) {
55
engine {
6-
// this: [[[OkHttpConfig|https://api.ktor.io/ktor-client/ktor-client-okhttp/io.ktor.client.engine.okhttp/-ok-http-config/index.html]]]
6+
// this: [[[OkHttpConfig|https://api.ktor.io/ktor-client-okhttp/io.ktor.client.engine.okhttp/-ok-http-config/index.html]]]
77
config {
88
// this: OkHttpClient.Builder
99
followRedirects(true)

topics/FAQ.topic

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@
178178

179179
<chapter title="How to resolve 'NoTransformationFoundException'?" id="no-transformation-found-exception">
180180
<p>
181-
<a href="https://api.ktor.io/ktor-client/ktor-client-core/io.ktor.client.call/-no-transformation-found-exception/index.html">NoTransformationFoundException</a>
181+
<a href="https://api.ktor.io/ktor-client-core/io.ktor.client.call/-no-transformation-found-exception/index.html">NoTransformationFoundException</a>
182182
represents the inability to find a suitable transformation for the <i>received body</i> from
183183
<b>resulted</b> type to <b>expected</b> by the client type.
184184
</p>

topics/client-auth.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The Auth plugin handles authentication and authorization in your client applicat
1414
</link-summary>
1515

1616
Ktor provides
17-
the [Auth](https://api.ktor.io/ktor-client/ktor-client-plugins/ktor-client-auth/io.ktor.client.plugins.auth/-auth)
17+
the [Auth](https://api.ktor.io/ktor-client-auth/io.ktor.client.plugins.auth/-auth)
1818
plugin to handle authentication and authorization in your client application.
1919
Typical usage scenarios include logging in users and gaining access to specific resources.
2020

@@ -60,7 +60,7 @@ Now you can [configure](#configure_authentication) the required authentication p
6060

6161
### Step 1: Choose an authentication provider {id="choose-provider"}
6262

63-
To use a specific authentication provider ([basic](client-basic-auth.md), [digest](client-digest-auth.md), or [bearer](client-bearer-auth.md)), you need to call the corresponding function inside the `install` block. For example, to use the `basic` authentication, call the [basic](https://api.ktor.io/ktor-client/ktor-client-plugins/ktor-client-auth/io.ktor.client.plugins.auth.providers/basic.html) function:
63+
To use a specific authentication provider ([basic](client-basic-auth.md), [digest](client-digest-auth.md), or [bearer](client-bearer-auth.md)), you need to call the corresponding function inside the `install` block. For example, to use the `basic` authentication, call the [basic](https://api.ktor.io/ktor-client-auth/io.ktor.client.plugins.auth.providers/basic.html) function:
6464

6565
```kotlin
6666
install(Auth) {

topics/client-basic-auth.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ The basic authentication flow looks as follows:
4040

4141
To send user credentials in the `Authorization` header using the `Basic` scheme, you need to configure the `basic` authentication provider as follows:
4242

43-
1. Call the [basic](https://api.ktor.io/ktor-client/ktor-client-plugins/ktor-client-auth/io.ktor.client.plugins.auth.providers/basic.html) function inside the `install` block.
44-
2. Provide the required credentials using [BasicAuthCredentials](https://api.ktor.io/ktor-client/ktor-client-plugins/ktor-client-auth/io.ktor.client.plugins.auth.providers/-basic-auth-credentials/index.html) and pass this object to the [credentials](https://api.ktor.io/ktor-client/ktor-client-plugins/ktor-client-auth/io.ktor.client.plugins.auth.providers/-basic-auth-config/credentials.html) function.
43+
1. Call the [basic](https://api.ktor.io/ktor-client-auth/io.ktor.client.plugins.auth.providers/basic.html) function inside the `install` block.
44+
2. Provide the required credentials using [BasicAuthCredentials](https://api.ktor.io/ktor-client-auth/io.ktor.client.plugins.auth.providers/-basic-auth-credentials/index.html) and pass this object to the [credentials](https://api.ktor.io/ktor-client-auth/io.ktor.client.plugins.auth.providers/-basic-auth-config/credentials.html) function.
4545
3. Configure the realm using the `realm` property.
4646

4747
```kotlin

0 commit comments

Comments
 (0)