meta

package
v0.0.0-...-70c17a4 Latest Latest
Warning

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

Go to latest
Published: Jun 26, 2022 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Dependencies

type Dependencies map[string]string

type ProviderMetadata

type ProviderMetadata struct {
	Name      string               `yaml:"name"`
	Resources map[string]*Resource `yaml:"resources"`
	// contains filtered or unexported fields
}

func NewProviderMetadata

func NewProviderMetadata(name, codeXPath, preludeXPath, fieldPathXPath, importXPath string) *ProviderMetadata

func NewProviderMetadataFromFile

func NewProviderMetadataFromFile(path string) (*ProviderMetadata, error)

func (*ProviderMetadata) ScrapeRepo

func (pm *ProviderMetadata) ScrapeRepo(config *ScrapeConfiguration) error

func (*ProviderMetadata) Store

func (pm *ProviderMetadata) Store(path string) error

type Resource

type Resource struct {
	SubCategory      string            `yaml:"subCategory"`
	Description      string            `yaml:"description,omitempty"`
	Name             string            `yaml:"name"`
	TitleName        string            `yaml:"titleName"`
	Examples         []ResourceExample `yaml:"examples,omitempty"`
	ArgumentDocs     map[string]string `yaml:"argumentDocs"`
	ImportStatements []string          `yaml:"importStatements"`
	// contains filtered or unexported fields
}

func (*Resource) AddArgumentDoc

func (r *Resource) AddArgumentDoc(fieldName, doc string)

type ResourceExample

type ResourceExample struct {
	Name         string            `yaml:"name"`
	Manifest     string            `yaml:"manifest"`
	References   map[string]string `yaml:"references,omitempty"`
	Dependencies Dependencies      `yaml:"dependencies,omitempty"`
}

type ScrapeConfiguration

type ScrapeConfiguration struct {
	SkipExampleErrors     bool
	SkipExampleReferences bool
	RepoPath              string
}

Jump to

Keyboard shortcuts

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