MIGRATION_GUIDE.md

Ktor Migration Guide

Migrating from 2.0.x to 2.2.x

Migrating from 1.6.x to 2.0.x

Migrating to 1.6.x

While Ktor provides migration support in the code itself (by using the @Deprecated annotation), this document serves as a reference point for all migrations as of version 1.6.0.

• TestApplicationCall.requestHandled has been deprecated. For proper validation, it is recommended to check the corresponding status, header, or content of the request, depending on the system under test.
• Updates to basic and digest authentication providers, deprecating sendWithoutRequest property, and favouring sendWithoutRequest function. Also, username and password properties are deprecated in favour of credentials function, which takes as parameter BasicAuthCredentials or DigestAuthCredentials data classes.
• Application extension functions uninstallAllFeatures, uninstall, and uninstallFeature have been deprecated. Currently, there are no replacements for these functions. Please consider commenting on your use-cases on the corresponding issue.
• ApplicationCall.locationOrNull has been deprecated. Please use ApplicationCall.location.
• ContentNegotiation constructor has been deprecated as it will become internal. It should not be explicitly called from the application code. Please consider passing in the necessary configuration options during installation of the ContentNegotiation plugin.
• ByteChannelSequentialBase.readByteOrder and ByteChannelSequentialBase.writeByOrder have been deprecated. Please read/write using big endian, and call the ByteChannelSequentialBase.reverseByteOrder() extension function if necessary.
• AbstractInput class has been deprecated and will be merged with Input class as of version 2.0.0.
• AbstractOutput class has been deprecated and will be merged with Output class as of version 2.0.0.
• IoBuffer class has been deprecated. Please use ChunkBuffer instead.