jsonschema

Documentation

Index

• func CleanCommentDirectory() error
• func CloneCommentDirectory() error
• func GenerateJsonSchema(resourceConfigSchema interface{}, anyOf map[string]interface{}) *jschema.Schema
• func GetPackageComments(rootPackagePath string) (map[string]string, error)
• type Schema
  • func New(baseSchemaID, schemaDirectory string) *Schema
  • func (s *Schema) GenerateSchema(object interface{}) error
  • func (s *Schema) Save() error
  • func (s *Schema) String() string

Functions

func CleanCommentDirectory

func CleanCommentDirectory() error

CleanCommentDirectory will remove the main temporary directory used by updatecli.

func CloneCommentDirectory

func CloneCommentDirectory() error

CloneCommentDirectory clones the updatecli git repository in a temporary location so we can parse comments

func GenerateJsonSchema

func GenerateJsonSchema(resourceConfigSchema interface{}, anyOf map[string]interface{}) *jschema.Schema

func GetPackageComments

func GetPackageComments(rootPackagePath string) (map[string]string, error)

GetPackageComments retrieves all updatecli code comments

Types

type Schema

type Schema struct {
	SchemaDir    string
	BaseSchemaID string
	JsonSchema   jschema.Schema
}

func New

func New(baseSchemaID, schemaDirectory string) *Schema

func (*Schema) GenerateSchema

func (s *Schema) GenerateSchema(object interface{}) error

GenerateSchema generates updatecli json schema based the config struct

func (*Schema) Save

func (s *Schema) Save() error

Save export a jsonschema to a local file

func (*Schema) String

func (s *Schema) String() string

String implements the string interface