Skip to content

chore: new @GeneratedApi annotation #1471

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

Open
ianbotsf wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −0
Open

chore: new @GeneratedApi annotation #1471

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions ...kotlin-codegen/src/main/kotlin/software/amazon/smithy/kotlin/codegen/core/RuntimeTypes.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ object RuntimeTypes {
val TimestampFormat = symbol("TimestampFormat", "time")
val ClientException = symbol("ClientException")
val SdkDsl = symbol("SdkDsl")
val GeneratedApi = symbol("GeneratedApi")

object BusinessMetrics : RuntimeTypePackage(KotlinDependency.CORE, "businessmetrics") {
val AccountIdBasedEndpointAccountId = symbol("AccountIdBasedEndpointAccountId")
Expand Down
3 changes: 3 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 @@ -33,6 +33,9 @@ public final class aws/smithy/kotlin/runtime/ErrorMetadata$Companion {
public abstract interface annotation class aws/smithy/kotlin/runtime/ExperimentalApi : java/lang/annotation/Annotation {
}

public abstract interface annotation class aws/smithy/kotlin/runtime/GeneratedApi : java/lang/annotation/Annotation {
}

public abstract interface annotation class aws/smithy/kotlin/runtime/InternalApi : java/lang/annotation/Annotation {
}

Expand Down
6 changes: 6 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 @@ -71,3 +71,9 @@ public annotation class PlannedRemoval(
val major: Int,
val minor: Int,
)

/**
* Indicates that the annotated API is created by a code generator such as **smithy-kotlin** codegen. Generated APIs may
* be excluded from certain kinds of automated checks, such as API compatibility verification.
*/
public annotation class GeneratedApi
Loading