Skip to content

Commit 4e12181

Browse files
authored
misc: plannedRemoval annotation (#1415)
1 parent f557442 commit 4e12181

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

runtime/runtime-core/api/runtime-core.api

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,11 @@ public abstract interface annotation class aws/smithy/kotlin/runtime/Experimenta
3636
public abstract interface annotation class aws/smithy/kotlin/runtime/InternalApi : java/lang/annotation/Annotation {
3737
}
3838

39+
public abstract interface annotation class aws/smithy/kotlin/runtime/PlannedRemoval : java/lang/annotation/Annotation {
40+
public abstract fun major ()I
41+
public abstract fun minor ()I
42+
}
43+
3944
public abstract interface class aws/smithy/kotlin/runtime/ProtocolResponse {
4045
public abstract fun getSummary ()Ljava/lang/String;
4146
}

runtime/runtime-core/common/src/aws/smithy/kotlin/runtime/Annotations.kt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,3 +58,16 @@ public annotation class ExperimentalApi
5858
*/
5959
@DslMarker
6060
public annotation class SdkDsl
61+
62+
/**
63+
* Indicates that the annotated API is deprecated and scheduled for removal in an upcoming version.
64+
* Any code using this API should migrate to the suggested replacement as soon as possible.
65+
*/
66+
@RequiresOptIn(
67+
message = "This API is deprecated and scheduled for removal in an upcoming version.",
68+
level = RequiresOptIn.Level.WARNING,
69+
)
70+
public annotation class PlannedRemoval(
71+
val major: Int,
72+
val minor: Int,
73+
)

0 commit comments

Comments
 (0)