smithy.api.Box.scala Maven / Gradle / Ivy
package smithy.api
import smithy4s.Hints
import smithy4s.Schema
import smithy4s.ShapeId
import smithy4s.ShapeTag
import smithy4s.schema.Schema.constant
/** Used only in Smithy 1.0 to indicate that a shape is boxed.
*
* This trait cannot be used in Smithy 2.0 models. When a boxed shape is the
* target of a member, the member may or may not contain a value, and the
* member has no default value.
*/
final case class Box()
object Box extends ShapeTag.Companion[Box] {
val id: ShapeId = ShapeId("smithy.api", "box")
val hints: Hints = Hints(
smithy.api.Documentation("Used only in Smithy 1.0 to indicate that a shape is boxed.\n\nThis trait cannot be used in Smithy 2.0 models. When a boxed shape is the\ntarget of a member, the member may or may not contain a value, and the\nmember has no default value."),
smithy.api.Trait(selector = Some(":test(boolean, byte, short, integer, long, float, double,\nmember > :test(boolean, byte, short, integer, long, float, double))"), structurallyExclusive = None, conflicts = None, breakingChanges = None),
).lazily
implicit val schema: Schema[Box] = constant(Box()).withId(id).addHints(hints)
}