SmithyValidation

zio.http.gen.smithy.SmithyValidation
object SmithyValidation

Smithy Model Validation

Validates Smithy models according to the Smithy specification: https://smithy.io/2.0/spec/model-validation.html

Provides comprehensive validation with helpful error messages including:

  • Shape reference validation (undefined references)
  • HTTP trait validation (path parameters, methods, status codes)
  • Constraint trait validation (@length, @range, @pattern)
  • Structure validation (required members, duplicate members)
  • Operation validation (input/output/error shapes)
  • Service validation (referenced operations/resources exist)

Attributes

Source
SmithyValidation.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

object ErrorType

Attributes

Companion
trait
Source
SmithyValidation.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
ErrorType.type
sealed trait ErrorType

Attributes

Companion
object
Source
SmithyValidation.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object InvalidEnum
object InvalidLength
object InvalidRange
Show all
class SmithyValidationException(val result: ValidationResult) extends RuntimeException

Attributes

Source
SmithyValidation.scala
Supertypes
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
final case class ValidationError(shapeName: Option[String], memberName: Option[String], errorType: ErrorType, message: String)

A validation error with context about where and what failed

A validation error with context about where and what failed

Attributes

Source
SmithyValidation.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class ValidationResult(errors: List[ValidationError], warnings: List[ValidationError])

Result of validation

Result of validation

Attributes

Companion
object
Source
SmithyValidation.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ValidationResult

Attributes

Companion
class
Source
SmithyValidation.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Value members

Concrete methods

def validate(model: SmithyModel): ValidationResult

Validate a SmithyModel and return all errors and warnings

Validate a SmithyModel and return all errors and warnings

Attributes

Source
SmithyValidation.scala
def validateOrThrow(model: SmithyModel): SmithyModel

Validate and throw if there are errors

Validate and throw if there are errors

Attributes

Source
SmithyValidation.scala