jsonschema

Documentation

Index

• Variables
• func Hydrate(ctx context.Context, anyVal interface{}, cwd string, ...) (interface{}, error)
• func Loader(path string) gojsonschema.JSONLoader
• func Validate(schemaPath string, documentPath string) (*gojsonschema.Result, error)
• func WriteDereferencedSchema(schemaFilePath string, outFile io.Writer, c *client.MassdriverClient) error
• type Example
  • func (e *Example) UnmarshalJSON(b []byte) error
• type GenerateAuthFile
• type PropertiesMap
• type Property
• type RefdSchema
  • func (r *RefdSchema) Type() string
• type Schema
  • func GetJSONSchema(path string) (Schema, error)

Variables

var Object = "object"

Functions

func Hydrate

func Hydrate(ctx context.Context, anyVal interface{}, cwd string, c *client.MassdriverClient) (interface{}, error)

func Loader

func Loader(path string) gojsonschema.JSONLoader

Load a JSON Schema with or without a path prefix

func Validate

func Validate(schemaPath string, documentPath string) (*gojsonschema.Result, error)

Validate the input object against the schema

func WriteDereferencedSchema

func WriteDereferencedSchema(schemaFilePath string, outFile io.Writer, c *client.MassdriverClient) error

Types

type Example

type Example struct {
	Name   string `json:"__name"`
	Values map[string]interface{}
}

func (*Example) UnmarshalJSON

func (e *Example) UnmarshalJSON(b []byte) error

type GenerateAuthFile

type GenerateAuthFile struct {
	Format   string  `json:"format"`
	Template *string `json:"template,omitempty"`
}

type PropertiesMap

type PropertiesMap map[string]Property

PropertiesMap is a named map of Property

type Property

type Property struct {
	AdditionalProperties bool              `json:"additionalProperties"`
	Type                 string            `json:"type"`
	Items                *Property         `json:"items"`
	Properties           PropertiesMap     `json:"properties,omitempty"`
	Default              interface{}       `json:"default,omitempty"`
	GenerateAuthFile     *GenerateAuthFile `json:"md.generateAuthFile,omitempty"`
	Minimum              *float64          `json:"minimum,omitempty"`
}

Property is a single JSON Schema property field

type RefdSchema

type RefdSchema struct {
	SchemaID   string
	Definition interface{}
}

A RefdSchema is a JSON Schema that may contain $ref

func (*RefdSchema) Type

func (r *RefdSchema) Type() string

type Schema

type Schema struct {
	Properties PropertiesMap `json:"properties"`
	Required   []string      `json:"required,omitempty"`
	Examples   []Example     `json:"examples,omitempty"`
	Type       string        `json:"type,omitempty"`
}

Schema is a flimsy representation of a JSON Schema. It provides just enough structure to get type information.

func GetJSONSchema

func GetJSONSchema(path string) (Schema, error)