commonMain.io.github.optimumcode.json.schema.ValidationError.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of json-schema-validator Show documentation

Multiplatform Kotlin implementation of JSON schema validator

There is a newer version: 0.3.0

Show newest version

package io.github.optimumcode.json.schema

import io.github.optimumcode.json.pointer.JsonPointer

/**
 * [ValidationError] contains information about the assertion that failed during the validation
 */
public data class ValidationError(
  /**
   * Path to the assertion definition in schema
   */
  val schemaPath: JsonPointer,
  /**
   * Path in the object that failed validation against the schema in [schemaPath]
   */
  val objectPath: JsonPointer,
  /**
   * Validation error message
   */
  val message: String,
  /**
   * Additional details about error
   */
  val details: Map = emptyMap(),
  /**
   * The absolute path to triggered assertion if the $ref was used
   */
  val absoluteLocation: JsonPointer? = null,
)