explain

package
v0.0.0-...-60784e1 Latest Latest
Warning

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

Go to latest
Published: Aug 3, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package explain renders kubectl-explain-style field documentation from a JSON Schema. It is schema-agnostic: callers pass the schema bytes and a dotted field path, and get back a human-readable description of that field plus its sub-fields.

It understands the subset of JSON Schema the Educates config schemas use: properties, items, enum, default, required, additionalProperties, $ref (against #/$defs and other in-document pointers), and the allOf/anyOf/oneOf combinators (merged into a union of fields).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Explain

func Explain(schemaBytes []byte, path string) (string, error)

Explain renders the field at the dotted path within the schema. An empty path explains the root. A leading "<Title>." on the path is tolerated so 'EducatesLocalConfig.ingress' and 'ingress' both work.

Types

This section is empty.

Jump to

Keyboard shortcuts

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