Help us shape the future of Go! Take the 2026 Go Developer Survey

openapi

package
v0.0.0-...-4a6edd7 Latest Latest
Warning

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

Go to latest
Published: Oct 21, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Finding

type Finding struct {
	Kind     FindingKind
	Type     string
	Subtype  string
	SpecPath string
	Field    string
	// Line and Column are one-based; zero means the location is unavailable.
	Line   int
	Column int
}

Finding is one presentation-neutral OpenAPI analysis fact.

type FindingKind

type FindingKind string

FindingKind classifies protocol-level parse, reference, and standard-validation facts.

const (
	DocumentInvalid  FindingKind = "document_invalid"
	ReferenceInvalid FindingKind = "reference_invalid"
	StandardInvalid  FindingKind = "openapi_standard"
)

type Operation

type Operation struct {
	Method      string
	Path        string
	OperationID string
	Responses   []string
	// Line and Column are one-based source coordinates.
	Line   int
	Column int
}

Operation contains the fields needed by devctl rules for one OpenAPI operation.

type Report

type Report struct {
	Version    string
	Operations []Operation
	Findings   []Finding
}

Report contains deterministic facts extracted without performing I/O.

func Analyze

func Analyze(data []byte) Report

Analyze parses and validates one OpenAPI document without applying devctl-specific lint policy.

Jump to

Keyboard shortcuts

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