Documentation ¶
Overview ¶
Package schema provides the Apex RPC schema.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var SchemaJson = []byte{}/* 6036 elements not displayed */
SchemaJson holds content of schema.json
Functions ¶
Types ¶
type Example ¶
type Example struct { Description string `json:"description"` Value interface{} `json:"value"` }
Example model.
type Field ¶
type Field struct { Name string `json:"name"` Description string `json:"description"` Required bool `json:"required"` ReadOnly bool `json:"readonly"` Default interface{} `json:"default"` Type TypeObject `json:"type"` Items ItemsObject `json:"items"` Enum []string `json:"enum"` }
Field model.
type Group ¶
type Group struct { Name string `json:"name"` Description string `json:"description"` Summary string `json:"summary"` }
Group model.
type Method ¶
type Method struct { Name string `json:"name"` Description string `json:"description"` Private bool `json:"private"` Group string `json:"group"` Inputs []Field `json:"inputs"` Outputs []Field `json:"outputs"` Examples []MethodExample `json:"examples"` }
Method model.
type MethodExample ¶
type MethodExample struct { Name string `json:"name"` Description string `json:"description"` Input interface{} `json:"input"` Output interface{} `json:"output"` }
MethodExample model.
type Schema ¶
type Schema struct { Name string `json:"name"` Version string `json:"version"` Description string `json:"description"` Methods []Method `json:"methods"` Groups []Group `json:"groups"` Types map[string]Type `json:"types"` Go struct { Tags []string `json:"tags"` } `json:"go"` }
Schema model.
func (Schema) TypesSlice ¶
TypesSlice returns a sorted slice of types.
type Type ¶
type Type struct { Name string `json:"name"` Description string `json:"description"` Private bool `json:"private"` Properties []Field `json:"properties"` Examples []Example `json:"examples"` }
Type model.
type TypeObject ¶
TypeObject model.
func (*TypeObject) UnmarshalJSON ¶
func (t *TypeObject) UnmarshalJSON(b []byte) error
UnmarshalJSON implementation.
type ValidationError ¶
type ValidationError struct {
Result *gojsonschema.Result
}
ValidationError is a validation error.
Click to show internal directories.
Click to hide internal directories.