smithy.api.Idempotent.scala Maven / Gradle / Ivy
package smithy.api
import smithy4s.Hints
import smithy4s.Schema
import smithy4s.ShapeId
import smithy4s.ShapeTag
import smithy4s.schema.Schema.constant
/** Indicates that the intended effect on the server of multiple identical
* requests with an operation is the same as the effect for a single such
* request.
*/
final case class Idempotent()
object Idempotent extends ShapeTag.Companion[Idempotent] {
val id: ShapeId = ShapeId("smithy.api", "idempotent")
val hints: Hints = Hints(
smithy.api.Documentation("Indicates that the intended effect on the server of multiple identical\nrequests with an operation is the same as the effect for a single such\nrequest."),
smithy.api.Trait(selector = Some("operation"), structurallyExclusive = None, conflicts = Some(List(smithy.api.NonEmptyString("smithy.api#readonly"))), breakingChanges = Some(List(smithy.api.TraitDiffRule(change = smithy.api.TraitChangeType.REMOVE.widen, severity = smithy.api.Severity.ERROR.widen, path = None, message = None)))),
).lazily
implicit val schema: Schema[Idempotent] = constant(Idempotent()).withId(id).addHints(hints)
}