issues

package
v1.38.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 4, 2026 License: MIT Imports: 2 Imported by: 0

Documentation

Overview

Package issues provides a unified issue type for validation and conversion problems.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Issue

type Issue struct {
	// Path is the JSON path to the problematic field (e.g., "paths./pets.get.responses")
	Path string
	// Message is a human-readable description of the issue
	Message string
	// Severity indicates the severity level of the issue
	Severity severity.Severity
	// Field is the specific field name that has the issue
	Field string
	// Value is the problematic value (optional)
	Value any
	// SpecRef is the URL to the relevant section of the OAS specification (optional, validation use)
	SpecRef string
	// Context provides additional information about the issue (optional, conversion use)
	Context string
	// Line is the 1-based line number in the source file (0 if unknown)
	Line int
	// Column is the 1-based column number in the source file (0 if unknown)
	Column int
	// File is the source file path (empty for main document)
	File string
}

Issue represents a single problem found during validation or conversion.

func (Issue) HasLocation added in v1.27.0

func (i Issue) HasLocation() bool

HasLocation returns true if this issue has source location information.

func (Issue) Location added in v1.27.0

func (i Issue) Location() string

Location returns the source location in IDE-friendly format. Returns "file:line:column" if file is set, "line:column" if only line is set, or the JSON path if location is unknown.

func (Issue) String

func (i Issue) String() string

String returns a formatted string representation of the issue. Uses different symbols based on severity level: - "✗" for Error or Critical severity - "⚠" for Warning severity - "ℹ" for Info severity

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL