Add doc comment

alexcardell · May 9, 2024 · 3fc5e5c · 3fc5e5c
1 parent b256d3f
commit 3fc5e5c
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/flipt/sdk-server/shared/src/main/scala/io/cardell/ff4s/flipt/FliptApi.scala b/flipt/sdk-server/shared/src/main/scala/io/cardell/ff4s/flipt/FliptApi.scala
@@ -36,6 +36,12 @@ trait FliptApi[F[_]] {
   def evaluateVariant(
       request: EvaluationRequest
   ): F[VariantEvaluationResponse]
+
+  /** If a variant matches, attempt to deserialise a variant attachment
+    *
+    * This method assumes all variant attachments match the JSON model of the
+    * type parameter
+    */
   def evaluateStructuredVariant[A: Decoder](
       request: EvaluationRequest
   ): F[Either[AttachmentDecodingError, StructuredVariantEvaluationResponse[A]]]