Merge pull request #155 from daddykotex/dfrancoeur/enum-httplable

Allow enum as path param
disneystreaming · Mar 30, 2022 · 67bea32 · 67bea32
2 parents 4f70a44 + 52072b5
commit 67bea32
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 1 deletion.
diff --git a/modules/core/src/smithy4s/http/internals/SchematicPathEncoder.scala b/modules/core/src/smithy4s/http/internals/SchematicPathEncoder.scala
@@ -70,6 +70,12 @@ object SchematicPathEncoder
   override val unit: PathEncode.Make[Unit] =
     struct(Vector.empty)(_ => ())
 
+  override def enumeration[A](
+      to: A => (String, Int),
+      fromName: Map[String, A],
+      fromOrdinal: Map[Int, A]
+  ): PathEncode.Make[A] = PathEncode.Make.from { a => to(a)._1 }
+
   override def struct[S](fields: Vector[Field[PathEncode.Make, S, _]])(
       const: Vector[Any] => S
   ): PathEncode.Make[S] = {

diff --git a/modules/tests/src/smithy4s/tests/PizzaAdminServiceImpl.scala b/modules/tests/src/smithy4s/tests/PizzaAdminServiceImpl.scala
@@ -36,6 +36,9 @@ object PizzaAdminServiceImpl {
 class PizzaAdminServiceImpl(ref: Compat.Ref[IO, State])
     extends PizzaAdminService[IO] {
 
+  def getEnum(theEnum: TheEnum): IO[GetEnumOutput] =
+    IO.pure(GetEnumOutput(result = Some(theEnum.value)))
+
   def addMenuItem(
       restaurant: String,
       menuItem: MenuItem

diff --git a/modules/tests/src/smithy4s/tests/PizzaSpec.scala b/modules/tests/src/smithy4s/tests/PizzaSpec.scala
@@ -384,6 +384,18 @@ abstract class PizzaSpec
     expect(matchResult == None)
   }
 
+  routerTest("Positive: can find enum endpoint by value") {
+    (client, uri, log) =>
+      for {
+        resValue <- client.send(
+          GET(uri / "get-enum" / "v1"),
+          log
+        )
+      } yield {
+        expect(resValue._1 == 200)
+      }
+  }
+
   type Res = (Client[IO], Uri)
   def sharedResource: Resource[IO, (Client[IO], Uri)] = for {
     stateRef <- Resource.eval(

diff --git a/sampleSpecs/pizza.smithy b/sampleSpecs/pizza.smithy
@@ -6,7 +6,7 @@ use smithy4s.api#simpleRestJson
 service PizzaAdminService {
   version: "1.0.0",
   errors: [GenericServerError, GenericClientError],
-  operations: [AddMenuItem, GetMenu, Version, Health, HeaderEndpoint, RoundTrip]
+  operations: [AddMenuItem, GetMenu, Version, Health, HeaderEndpoint, RoundTrip, GetEnum]
 }
 
 @http(method: "POST", uri: "/restaurant/{restaurant}/menu/item", code: 201)
@@ -214,3 +214,27 @@ string UnknownServerErrorCode
 
 @trait
 document freeForm
+
+@readonly
+@http(method: "GET", uri: "/get-enum/{aa}", code: 200)
+operation GetEnum {
+  input: GetEnumInput,
+  output: GetEnumOutput,
+  errors: [ UnknownServerError ]
+}
+
+structure GetEnumInput {
+  @required
+  @httpLabel
+  aa: TheEnum
+}
+
+structure GetEnumOutput {
+  result: String
+}
+
+@enum([
+  {value: "v1", name: "V1"},
+  {value: "v2", name: "V2"}
+])
+string TheEnum