• Home
• com.disneystreaming.smithy4s
• smithy4s-core_3
• 0.18.0-13-d40e0f5
• source code
• Required.scala

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

smithy.api.Required.scala Maven / Gradle / Ivy

package smithy.api

import smithy4s.Hints
import smithy4s.Schema
import smithy4s.ShapeId
import smithy4s.ShapeTag
import smithy4s.schema.Schema.constant

/** Marks a structure member as required, meaning a value for the member MUST
  * be present.
  */
final case class Required()

object Required extends ShapeTag.Companion[Required] {
  val id: ShapeId = ShapeId("smithy.api", "required")

  val hints: Hints = Hints(
    smithy.api.Documentation("Marks a structure member as required, meaning a value for the member MUST\nbe present."),
    smithy.api.Trait(selector = Some("structure > member"), structurallyExclusive = None, conflicts = None, breakingChanges = Some(List(smithy.api.TraitDiffRule(change = smithy.api.TraitChangeType.ADD.widen, severity = smithy.api.Severity.WARNING.widen, path = None, message = Some("If any consumers were previously omitting this member in operation inputs, making it required is backwards incompatible"))))),
  ).lazily


  implicit val schema: Schema[Required] = constant(Required()).withId(id).addHints(hints)
}