jsonschema

Documentation

Index

• func AppendMapToJsonSchema(baseConfig interface{}, mapConfig map[string]interface{}) *jschema.Schema
• func AppendOneOfToJsonSchema(baseConfig interface{}, anyOf map[string]interface{}) *jschema.Schema
• func CleanCommentDirectory() error
• func CloneCommentDirectory() error
• 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 AppendMapToJsonSchema

func AppendMapToJsonSchema(baseConfig interface{}, mapConfig map[string]interface{}) *jschema.Schema

AppendMapToJsonSchema generates a jsonschema based on a baseConfig and then append a map of properties using the mapConfig.

func AppendOneOfToJsonSchema

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

AppendOneOfToJsonschema generates a jsonschema based on a baseConfig and then append a oneOf based on the mapConfig.

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 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