Documentation
¶
Overview ¶
Package schema provides JSON Schema generation for observability specs.
This package generates JSON Schemas from the Go struct definitions, following the Go-first approach where Go types are the source of truth.
Index ¶
- func All() map[string]func() ([]byte, error)
- func GenerateClassesSchema() ([]byte, error)
- func GenerateGoldenSchema() ([]byte, error)
- func GenerateOpenSLOSchema() ([]byte, error)
- func GenerateREDSchema() ([]byte, error)
- func GenerateSLOTemplateSchema() ([]byte, error)
- func GenerateUSESchema() ([]byte, error)
- func GoldenDefinition() *jsonschema.Schema
- func OpenSLOSLO() *jsonschema.Schema
- func OpenSLOService() *jsonschema.Schema
- func REDDefinition() *jsonschema.Schema
- func SLOTemplate() *jsonschema.Schema
- func ServiceSpec() *jsonschema.Schema
- func USEDefinition() *jsonschema.Schema
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GenerateClassesSchema ¶
GenerateClassesSchema generates JSON Schema for service class specs as JSON bytes.
func GenerateGoldenSchema ¶
GenerateGoldenSchema generates JSON Schema for Golden Signals as JSON bytes.
func GenerateOpenSLOSchema ¶
GenerateOpenSLOSchema generates JSON Schema for OpenSLO SLO as JSON bytes.
func GenerateREDSchema ¶
GenerateREDSchema generates JSON Schema for RED definitions as JSON bytes.
func GenerateSLOTemplateSchema ¶
GenerateSLOTemplateSchema generates JSON Schema for SLO templates as JSON bytes.
func GenerateUSESchema ¶
GenerateUSESchema generates JSON Schema for USE definitions as JSON bytes.
func GoldenDefinition ¶
func GoldenDefinition() *jsonschema.Schema
GoldenDefinition returns the JSON Schema for golden.Definition.
func OpenSLOSLO ¶
func OpenSLOSLO() *jsonschema.Schema
OpenSLOSLO returns the JSON Schema for openslo.SLO.
func OpenSLOService ¶
func OpenSLOService() *jsonschema.Schema
OpenSLOService returns the JSON Schema for openslo.Service.
func REDDefinition ¶
func REDDefinition() *jsonschema.Schema
REDDefinition returns the JSON Schema for red.Definition.
func SLOTemplate ¶
func SLOTemplate() *jsonschema.Schema
SLOTemplate returns the JSON Schema for classes.SLOTemplate.
func ServiceSpec ¶
func ServiceSpec() *jsonschema.Schema
ServiceSpec returns the JSON Schema for classes.ServiceSpec.
func USEDefinition ¶
func USEDefinition() *jsonschema.Schema
USEDefinition returns the JSON Schema for use.Definition.
Types ¶
This section is empty.
Source Files