validate

Documentation

Overview

Package validate performs provider-free structural and API-source validation for native Ramen projects.

The validate package is part of Ramen's supported v0.1 core API.

Index

• Constants
• type APISourceInput
• type Diagnostic
• type Options
• type Result
  • func Run(ctx context.Context, opts Options) (*Result, error)
• type Summary

Constants

const Version = "ramen.validate.v1"

Types

type APISourceInput

type APISourceInput struct {
	Kind string
	ID   string
	Path string
}

type Diagnostic

type Diagnostic struct {
	Code          string `json:"code"`
	Severity      string `json:"severity"`
	Message       string `json:"message"`
	Address       string `json:"address,omitempty"`
	APISourceKind string `json:"api_source_kind,omitempty"`
	APISourceID   string `json:"api_source_id,omitempty"`
	OperationID   string `json:"operation_id,omitempty"`
}

type Options

type Options struct {
	ProjectPath string
	APISources  []APISourceInput
	Strict      bool
}

type Result

type Result struct {
	Version     string       `json:"version"`
	ProjectPath string       `json:"project_path,omitempty"`
	Strict      bool         `json:"strict,omitempty"`
	Valid       bool         `json:"valid"`
	Summary     Summary      `json:"summary"`
	Diagnostics []Diagnostic `json:"diagnostics,omitempty"`
}

func Run

func Run(ctx context.Context, opts Options) (*Result, error)

type Summary

type Summary struct {
	Errors      int `json:"errors"`
	Warnings    int `json:"warnings"`
	Diagnostics int `json:"diagnostics"`
}