smithy.api.Examples.scala Maven / Gradle / Ivy
package smithy.api
import smithy4s.Hints
import smithy4s.Newtype
import smithy4s.Schema
import smithy4s.ShapeId
import smithy4s.schema.Schema.bijection
import smithy4s.schema.Schema.list
import smithy4s.schema.Schema.recursive
/** Provides example inputs and outputs for operations. */
object Examples extends Newtype[List[Example]] {
val id: ShapeId = ShapeId("smithy.api", "examples")
val hints: Hints = Hints(
smithy.api.Documentation("Provides example inputs and outputs for operations."),
smithy.api.Trait(selector = Some("operation"), structurallyExclusive = None, conflicts = None, breakingChanges = None),
).lazily
val underlyingSchema: Schema[List[Example]] = list(Example.schema).withId(id).addHints(hints)
implicit val schema: Schema[Examples] = recursive(bijection(underlyingSchema, asBijection))
}