All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

There is a newer version: 0.19.0-41-91762fb
Show newest version
package smithy.api

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

/** Shapes marked with the internal trait are meant only for internal use and
  * must not be exposed to customers.
  */
final case class Internal()

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

  val hints: Hints = Hints(
    smithy.api.Documentation("Shapes marked with the internal trait are meant only for internal use and\nmust not be exposed to customers."),
    smithy.api.Trait(selector = None, structurallyExclusive = None, conflicts = None, breakingChanges = Some(List(smithy.api.TraitDiffRule(change = smithy.api.TraitChangeType.REMOVE.widen, severity = smithy.api.Severity.WARNING.widen, path = None, message = Some("Removing the @internal trait makes a shape externally visible."))))),
  ).lazily


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




© 2015 - 2024 Weber Informatics LLC | Privacy Policy