smithy.api.JsonName.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.recursive
import smithy4s.schema.Schema.string
/** Allows a serialized object property name to differ from a structure member
* name used in the model.
*/
object JsonName extends Newtype[String] {
val id: ShapeId = ShapeId("smithy.api", "jsonName")
val hints: Hints = Hints(
smithy.api.Documentation("Allows a serialized object property name to differ from a structure member\nname used in the model."),
smithy.api.Trait(selector = Some(":is(structure, union) > member"), structurallyExclusive = None, conflicts = None, breakingChanges = Some(List(smithy.api.TraitDiffRule(change = smithy.api.TraitChangeType.ANY.widen, severity = smithy.api.Severity.ERROR.widen, path = None, message = None)))),
).lazily
val underlyingSchema: Schema[String] = string.withId(id).addHints(hints)
implicit val schema: Schema[JsonName] = recursive(bijection(underlyingSchema, asBijection))
}