Skip to content

Commit

Permalink
Exclude internal APIs from API dump
Browse files Browse the repository at this point in the history
  • Loading branch information
ZacSweers committed Jun 6, 2024
1 parent e8fabad commit fb5f196
Show file tree
Hide file tree
Showing 5 changed files with 1 addition and 22 deletions.
1 change: 1 addition & 0 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ plugins {
apiValidation {
@OptIn(ExperimentalBCVApi::class)
klib.enabled = true
nonPublicMarkers += "com.slack.eithernet.InternalEitherNetApi"
}

tasks.dokkaHtmlMultiModule {
Expand Down
11 changes: 0 additions & 11 deletions eithernet/api/eithernet.api
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
public final class com/slack/eithernet/AnnotationsKt {
public static final fun createStatusCode (I)Lcom/slack/eithernet/StatusCode;
public static final fun errorType ([Ljava/lang/annotation/Annotation;)Lkotlin/Pair;
public static final fun statusCode ([Ljava/lang/annotation/Annotation;)Lkotlin/Pair;
public static final fun toKType (Lcom/slack/eithernet/ResultType;)Lkotlin/reflect/KType;
}

public final class com/slack/eithernet/Annotations_jvmKt {
public static final fun createResultType (Ljava/lang/reflect/Type;)Lcom/slack/eithernet/ResultType;
public static final fun toType (Lcom/slack/eithernet/ResultType;)Ljava/lang/reflect/Type;
}

Expand Down Expand Up @@ -35,33 +33,27 @@ public abstract interface class com/slack/eithernet/ApiResult$Failure : com/slac
}

public final class com/slack/eithernet/ApiResult$Failure$ApiFailure : com/slack/eithernet/ApiResult$Failure {
public fun <init> (Ljava/lang/Object;Ljava/util/Map;)V
public final fun getError ()Ljava/lang/Object;
public final fun withTags (Ljava/util/Map;)Lcom/slack/eithernet/ApiResult$Failure$ApiFailure;
}

public final class com/slack/eithernet/ApiResult$Failure$HttpFailure : com/slack/eithernet/ApiResult$Failure {
public fun <init> (ILjava/lang/Object;Ljava/util/Map;)V
public final fun getCode ()I
public final fun getError ()Ljava/lang/Object;
public final fun withTags (Ljava/util/Map;)Lcom/slack/eithernet/ApiResult$Failure$HttpFailure;
}

public final class com/slack/eithernet/ApiResult$Failure$NetworkFailure : com/slack/eithernet/ApiResult$Failure {
public fun <init> (Ljava/io/IOException;Ljava/util/Map;)V
public final fun getError ()Ljava/io/IOException;
public final fun withTags (Ljava/util/Map;)Lcom/slack/eithernet/ApiResult$Failure$NetworkFailure;
}

public final class com/slack/eithernet/ApiResult$Failure$UnknownFailure : com/slack/eithernet/ApiResult$Failure {
public fun <init> (Ljava/lang/Throwable;Ljava/util/Map;)V
public final fun getError ()Ljava/lang/Throwable;
public final fun withTags (Ljava/util/Map;)Lcom/slack/eithernet/ApiResult$Failure$UnknownFailure;
}

public final class com/slack/eithernet/ApiResult$Success : com/slack/eithernet/ApiResult {
public fun <init> (Ljava/lang/Object;Ljava/util/Map;)V
public final fun getTags ()Ljava/util/Map;
public final fun getValue ()Ljava/lang/Object;
public final fun withTags (Ljava/util/Map;)Lcom/slack/eithernet/ApiResult$Success;
}
Expand Down Expand Up @@ -92,7 +84,6 @@ public abstract interface annotation class com/slack/eithernet/InternalEitherNet

public final class com/slack/eithernet/KTypesKt {
public static final fun canonicalize (Lkotlin/reflect/KType;)Lkotlin/reflect/KType;
public static final fun isFunctionallyEqualTo (Lkotlin/reflect/KType;Lkotlin/reflect/KType;)Z
}

public abstract interface annotation class com/slack/eithernet/ResultType : java/lang/annotation/Annotation {
Expand Down Expand Up @@ -133,8 +124,6 @@ public final class com/slack/eithernet/TypesKt {
}

public final class com/slack/eithernet/Util {
public static final fun canonicalize (Ljava/lang/reflect/Type;)Ljava/lang/reflect/Type;
public static final fun removeSubtypeWildcard (Ljava/lang/reflect/Type;)Ljava/lang/reflect/Type;
public static final fun resolve (Ljava/lang/reflect/Type;Ljava/lang/reflect/Type;Ljava/lang/Class;)Ljava/lang/reflect/Type;
}

9 changes: 0 additions & 9 deletions eithernet/api/eithernet.klib.api
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,11 @@ final class com.slack.eithernet/ApiException : kotlin/Exception { // com.slack.e
}
final fun (com.slack.eithernet/ResultType).com.slack.eithernet/toKType(): kotlin.reflect/KType // com.slack.eithernet/toKType|[email protected](){}[0]
final fun (kotlin.reflect/KType).com.slack.eithernet/canonicalize(): kotlin.reflect/KType // com.slack.eithernet/canonicalize|[email protected](){}[0]
final fun (kotlin.reflect/KType?).com.slack.eithernet/isFunctionallyEqualTo(kotlin.reflect/KType?): kotlin/Boolean // com.slack.eithernet/isFunctionallyEqualTo|[email protected]?(kotlin.reflect.KType?){}[0]
final fun (kotlin/Array<out kotlin/Annotation>).com.slack.eithernet/errorType(): kotlin/Pair<com.slack.eithernet/ResultType, kotlin/Array<kotlin/Annotation>>? // com.slack.eithernet/errorType|[email protected]<out|kotlin.Annotation>(){}[0]
final fun (kotlin/Array<out kotlin/Annotation>).com.slack.eithernet/statusCode(): kotlin/Pair<com.slack.eithernet/StatusCode, kotlin/Array<kotlin/Annotation>>? // com.slack.eithernet/statusCode|[email protected]<out|kotlin.Annotation>(){}[0]
final fun <#A: kotlin/Any, #B: kotlin/Any> (com.slack.eithernet/ApiResult<#A, #B>).com.slack.eithernet/successOrNull(): #A? // com.slack.eithernet/successOrNull|[email protected]<0:0,0:1>(){0§<kotlin.Any>;1§<kotlin.Any>}[0]
final fun <#A: kotlin/Any> (com.slack.eithernet/ApiResult.Failure<#A>).com.slack.eithernet/exceptionOrNull(): kotlin/Throwable? // com.slack.eithernet/exceptionOrNull|[email protected]<0:0>(){0§<kotlin.Any>}[0]
final fun <#A: kotlin/Any> (com.slack.eithernet/ApiResult<*, *>).com.slack.eithernet/tag(kotlin.reflect/KClass<#A>): #A? // com.slack.eithernet/tag|[email protected]<*,*>(kotlin.reflect.KClass<0:0>){0§<kotlin.Any>}[0]
final fun com.slack.eithernet/createStatusCode(kotlin/Int): com.slack.eithernet/StatusCode // com.slack.eithernet/createStatusCode|createStatusCode(kotlin.Int){}[0]
final inline fun <#A: kotlin/Any, #B: kotlin/Any, #C: kotlin/Any?> (com.slack.eithernet/ApiResult<#A, #B>).com.slack.eithernet/fold(kotlin/Function1<#A, #C>, kotlin/Function1<com.slack.eithernet/ApiResult.Failure.NetworkFailure, #C>, kotlin/Function1<com.slack.eithernet/ApiResult.Failure.UnknownFailure, #C>, kotlin/Function1<com.slack.eithernet/ApiResult.Failure.HttpFailure<#B>, #C>, kotlin/Function1<com.slack.eithernet/ApiResult.Failure.ApiFailure<#B>, #C>): #C // com.slack.eithernet/fold|[email protected]<0:0,0:1>(kotlin.Function1<0:0,0:2>;kotlin.Function1<com.slack.eithernet.ApiResult.Failure.NetworkFailure,0:2>;kotlin.Function1<com.slack.eithernet.ApiResult.Failure.UnknownFailure,0:2>;kotlin.Function1<com.slack.eithernet.ApiResult.Failure.HttpFailure<0:1>,0:2>;kotlin.Function1<com.slack.eithernet.ApiResult.Failure.ApiFailure<0:1>,0:2>){0§<kotlin.Any>;1§<kotlin.Any>;2§<kotlin.Any?>}[0]
final inline fun <#A: kotlin/Any, #B: kotlin/Any, #C: kotlin/Any?> (com.slack.eithernet/ApiResult<#A, #B>).com.slack.eithernet/fold(noinline kotlin/Function1<#A, #C>, noinline kotlin/Function1<com.slack.eithernet/ApiResult.Failure<#B>, #C>): #C // com.slack.eithernet/fold|[email protected]<0:0,0:1>(kotlin.Function1<0:0,0:2>;kotlin.Function1<com.slack.eithernet.ApiResult.Failure<0:1>,0:2>){0§<kotlin.Any>;1§<kotlin.Any>;2§<kotlin.Any?>}[0]
final inline fun <#A: kotlin/Any, #B: kotlin/Any> (com.slack.eithernet/ApiResult<#A, #B>).com.slack.eithernet/onApiFailure(kotlin/Function1<com.slack.eithernet/ApiResult.Failure.ApiFailure<#B>, kotlin/Unit>): com.slack.eithernet/ApiResult<#A, #B> // com.slack.eithernet/onApiFailure|[email protected]<0:0,0:1>(kotlin.Function1<com.slack.eithernet.ApiResult.Failure.ApiFailure<0:1>,kotlin.Unit>){0§<kotlin.Any>;1§<kotlin.Any>}[0]
Expand Down Expand Up @@ -59,10 +57,7 @@ open annotation class com.slack.eithernet/StatusCode : kotlin/Annotation { // co
}
sealed interface <#A: out kotlin/Any, #B: out kotlin/Any> com.slack.eithernet/ApiResult { // com.slack.eithernet/ApiResult|null[0]
final class <#A1: kotlin/Any> Success : com.slack.eithernet/ApiResult<#A1, kotlin/Nothing> { // com.slack.eithernet/ApiResult.Success|null[0]
constructor <init>(#A1, kotlin.collections/Map<kotlin.reflect/KClass<*>, kotlin/Any>) // com.slack.eithernet/ApiResult.Success.<init>|<init>(1:0;kotlin.collections.Map<kotlin.reflect.KClass<*>,kotlin.Any>){}[0]
final fun withTags(kotlin.collections/Map<kotlin.reflect/KClass<*>, kotlin/Any>): com.slack.eithernet/ApiResult.Success<#A1> // com.slack.eithernet/ApiResult.Success.withTags|withTags(kotlin.collections.Map<kotlin.reflect.KClass<*>,kotlin.Any>){}[0]
final val tags // com.slack.eithernet/ApiResult.Success.tags|{}tags[0]
final fun <get-tags>(): kotlin.collections/Map<kotlin.reflect/KClass<*>, kotlin/Any> // com.slack.eithernet/ApiResult.Success.tags.<get-tags>|<get-tags>(){}[0]
final val value // com.slack.eithernet/ApiResult.Success.value|{}value[0]
final fun <get-value>(): #A1 // com.slack.eithernet/ApiResult.Success.value.<get-value>|<get-value>(){}[0]
}
Expand All @@ -77,27 +72,23 @@ sealed interface <#A: out kotlin/Any, #B: out kotlin/Any> com.slack.eithernet/Ap
}
sealed interface <#A1: kotlin/Any> Failure : com.slack.eithernet/ApiResult<kotlin/Nothing, #A1> { // com.slack.eithernet/ApiResult.Failure|null[0]
final class <#A2: kotlin/Any> ApiFailure : com.slack.eithernet/ApiResult.Failure<#A2> { // com.slack.eithernet/ApiResult.Failure.ApiFailure|null[0]
constructor <init>(#A2?, kotlin.collections/Map<kotlin.reflect/KClass<*>, kotlin/Any>) // com.slack.eithernet/ApiResult.Failure.ApiFailure.<init>|<init>(1:0?;kotlin.collections.Map<kotlin.reflect.KClass<*>,kotlin.Any>){}[0]
final fun withTags(kotlin.collections/Map<kotlin.reflect/KClass<*>, kotlin/Any>): com.slack.eithernet/ApiResult.Failure.ApiFailure<#A2> // com.slack.eithernet/ApiResult.Failure.ApiFailure.withTags|withTags(kotlin.collections.Map<kotlin.reflect.KClass<*>,kotlin.Any>){}[0]
final val error // com.slack.eithernet/ApiResult.Failure.ApiFailure.error|{}error[0]
final fun <get-error>(): #A2? // com.slack.eithernet/ApiResult.Failure.ApiFailure.error.<get-error>|<get-error>(){}[0]
}
final class <#A2: kotlin/Any> HttpFailure : com.slack.eithernet/ApiResult.Failure<#A2> { // com.slack.eithernet/ApiResult.Failure.HttpFailure|null[0]
constructor <init>(kotlin/Int, #A2?, kotlin.collections/Map<kotlin.reflect/KClass<*>, kotlin/Any>) // com.slack.eithernet/ApiResult.Failure.HttpFailure.<init>|<init>(kotlin.Int;1:0?;kotlin.collections.Map<kotlin.reflect.KClass<*>,kotlin.Any>){}[0]
final fun withTags(kotlin.collections/Map<kotlin.reflect/KClass<*>, kotlin/Any>): com.slack.eithernet/ApiResult.Failure.HttpFailure<#A2> // com.slack.eithernet/ApiResult.Failure.HttpFailure.withTags|withTags(kotlin.collections.Map<kotlin.reflect.KClass<*>,kotlin.Any>){}[0]
final val code // com.slack.eithernet/ApiResult.Failure.HttpFailure.code|{}code[0]
final fun <get-code>(): kotlin/Int // com.slack.eithernet/ApiResult.Failure.HttpFailure.code.<get-code>|<get-code>(){}[0]
final val error // com.slack.eithernet/ApiResult.Failure.HttpFailure.error|{}error[0]
final fun <get-error>(): #A2? // com.slack.eithernet/ApiResult.Failure.HttpFailure.error.<get-error>|<get-error>(){}[0]
}
final class NetworkFailure : com.slack.eithernet/ApiResult.Failure<kotlin/Nothing> { // com.slack.eithernet/ApiResult.Failure.NetworkFailure|null[0]
constructor <init>(okio/IOException, kotlin.collections/Map<kotlin.reflect/KClass<*>, kotlin/Any>) // com.slack.eithernet/ApiResult.Failure.NetworkFailure.<init>|<init>(okio.IOException;kotlin.collections.Map<kotlin.reflect.KClass<*>,kotlin.Any>){}[0]
final fun withTags(kotlin.collections/Map<kotlin.reflect/KClass<*>, kotlin/Any>): com.slack.eithernet/ApiResult.Failure.NetworkFailure // com.slack.eithernet/ApiResult.Failure.NetworkFailure.withTags|withTags(kotlin.collections.Map<kotlin.reflect.KClass<*>,kotlin.Any>){}[0]
final val error // com.slack.eithernet/ApiResult.Failure.NetworkFailure.error|{}error[0]
final fun <get-error>(): okio/IOException // com.slack.eithernet/ApiResult.Failure.NetworkFailure.error.<get-error>|<get-error>(){}[0]
}
final class UnknownFailure : com.slack.eithernet/ApiResult.Failure<kotlin/Nothing> { // com.slack.eithernet/ApiResult.Failure.UnknownFailure|null[0]
constructor <init>(kotlin/Throwable, kotlin.collections/Map<kotlin.reflect/KClass<*>, kotlin/Any>) // com.slack.eithernet/ApiResult.Failure.UnknownFailure.<init>|<init>(kotlin.Throwable;kotlin.collections.Map<kotlin.reflect.KClass<*>,kotlin.Any>){}[0]
final fun withTags(kotlin.collections/Map<kotlin.reflect/KClass<*>, kotlin/Any>): com.slack.eithernet/ApiResult.Failure.UnknownFailure // com.slack.eithernet/ApiResult.Failure.UnknownFailure.withTags|withTags(kotlin.collections.Map<kotlin.reflect.KClass<*>,kotlin.Any>){}[0]
final val error // com.slack.eithernet/ApiResult.Failure.UnknownFailure.error|{}error[0]
final fun <get-error>(): kotlin/Throwable // com.slack.eithernet/ApiResult.Failure.UnknownFailure.error.<get-error>|<get-error>(){}[0]
Expand Down
1 change: 0 additions & 1 deletion eithernet/test-fixtures/api/test-fixtures.api
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ public final class com/slack/eithernet/test/CreateEndpointKeyKt {
public abstract interface class com/slack/eithernet/test/EitherNetController {
public abstract fun assertNoMoreQueuedResults ()V
public abstract fun getApi ()Ljava/lang/Object;
public abstract fun unsafeEnqueue (Lcom/slack/eithernet/test/EndpointKey;Lkotlin/jvm/functions/Function2;)V
}

public final class com/slack/eithernet/test/EitherNetControllersKt {
Expand Down
1 change: 0 additions & 1 deletion eithernet/test-fixtures/api/test-fixtures.klib.api
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ abstract fun interface com.slack.eithernet.test/ApiValidator { // com.slack.eith
abstract fun validate(kotlin.reflect/KClass<*>, kotlin.reflect/KFunction<*>, kotlin.collections/MutableList<kotlin/String>) // com.slack.eithernet.test/ApiValidator.validate|validate(kotlin.reflect.KClass<*>;kotlin.reflect.KFunction<*>;kotlin.collections.MutableList<kotlin.String>){}[0]
}
abstract interface <#A: kotlin/Any> com.slack.eithernet.test/EitherNetController { // com.slack.eithernet.test/EitherNetController|null[0]
abstract fun <#A1: kotlin/Any, #B1: kotlin/Any> unsafeEnqueue(com.slack.eithernet.test/EndpointKey, kotlin.coroutines/SuspendFunction1<kotlin/Array<kotlin/Any>, com.slack.eithernet/ApiResult<#A1, #B1>>) // com.slack.eithernet.test/EitherNetController.unsafeEnqueue|unsafeEnqueue(com.slack.eithernet.test.EndpointKey;kotlin.coroutines.SuspendFunction1<kotlin.Array<kotlin.Any>,com.slack.eithernet.ApiResult<0:0,0:1>>){0§<kotlin.Any>;1§<kotlin.Any>}[0]
abstract fun assertNoMoreQueuedResults() // com.slack.eithernet.test/EitherNetController.assertNoMoreQueuedResults|assertNoMoreQueuedResults(){}[0]
abstract val api // com.slack.eithernet.test/EitherNetController.api|{}api[0]
abstract fun <get-api>(): #A // com.slack.eithernet.test/EitherNetController.api.<get-api>|<get-api>(){}[0]
Expand Down

0 comments on commit fb5f196

Please sign in to comment.