Skip to content

misc: plannedRemoval annotation #1415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 22, 2025
Merged

misc: plannedRemoval annotation #1415

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6e2f3b5
misc: deprecatedUntilVersion annotation
0marperez Sep 19, 2025
576e3e1
feedback
0marperez Sep 22, 2025
c7a0e03
self review
0marperez Sep 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions runtime/runtime-core/api/runtime-core.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@ public abstract interface annotation class aws/smithy/kotlin/runtime/Experimenta
public abstract interface annotation class aws/smithy/kotlin/runtime/InternalApi : java/lang/annotation/Annotation {
}

public abstract interface annotation class aws/smithy/kotlin/runtime/PlannedRemoval : java/lang/annotation/Annotation {
public abstract fun major ()I
public abstract fun minor ()I
}

public abstract interface class aws/smithy/kotlin/runtime/ProtocolResponse {
public abstract fun getSummary ()Ljava/lang/String;
}
Expand Down
13 changes: 13 additions & 0 deletions runtime/runtime-core/common/src/aws/smithy/kotlin/runtime/Annotations.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,16 @@ public annotation class ExperimentalApi
*/
@DslMarker
public annotation class SdkDsl

/**
* Indicates that the annotated API is deprecated and scheduled for removal in an upcoming version.
* Any code using this API should migrate to the suggested replacement as soon as possible.
*/
@RequiresOptIn(
message = "This API is deprecated and scheduled for removal in an upcoming version.",
level = RequiresOptIn.Level.WARNING,
)
public annotation class PlannedRemoval(
val major: Int,
val minor: Int,
)
Loading