Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Api ¶
type Command ¶
type Command struct {
Name string `json:"name"`
Type string `json:"type"`
Definition string `json:"request"`
Response Response `json:"response"`
Description string `json:"description"`
Documented bool `json:"documented"`
Internal bool `json:"internal"`
Deprecated bool `json:"deprecated"`
AdditionalProperties map[string]interface{} `json:""`
}
func (*Command) UnmarshalJSON ¶
type Definition ¶
type Definition struct {
Name string `json:"name"`
ObjectType string `json:"objectType"`
RequestType string `json:"requestType"`
Show bool `json:"show"`
Common bool `json:"common"`
Description string `json:"description"`
Fields []Field `json:"fields"`
UnderMoreFields []Field `json:"under-more-fields"`
RequiredFields []Field `json:"required-fields"`
AdditionalProperties map[string]interface{} `json:""`
}
func (*Definition) UnmarshalJSON ¶
func (d *Definition) UnmarshalJSON(body []byte) error
type ElementType ¶
func (ElementType) GetElementType ¶
func (t ElementType) GetElementType() ElementType
func (ElementType) GetName ¶
func (t ElementType) GetName() string
func (ElementType) GetObjectName ¶
func (t ElementType) GetObjectName() string
func (ElementType) GetValidValues ¶
func (t ElementType) GetValidValues() []string
type Field ¶
type Field struct {
Name string `json:"name"`
Description string `json:"description"`
Types []Type `json:"types"`
UnderMore bool `json:"under-more"`
Deprecated bool `json:"deprecated"`
FieldOrder int `json:"field-order"`
Default string `json:"default-value"`
Required bool `json:"required"`
Alternatives []Field `json:"field-alternatives"`
InRequest bool `json:"field-in-request"`
AdditionalProperties map[string]interface{} `json:""`
}
func (*Field) UnmarshalJSON ¶
type Model ¶
type Model struct {
Version string `json:"version"`
Path string `json:"path"`
Commands []Command `json:"commands"`
Definitions []Definition `json:"objects"`
}
type Response ¶
type Response struct {
Success ResponseObject `json:"on-success"`
Failure ResponseObject `json:"on-failure"`
}
func (*Response) UnmarshalJSON ¶
type ResponseObject ¶
func (*ResponseObject) UnmarshalJSON ¶
func (r *ResponseObject) UnmarshalJSON(body []byte) error
type Tags ¶
func (Tags) MarshalJSON ¶
type Type ¶
type Type struct {
Name string `json:"name"`
ValidValues []string `json:"valid-values"`
ObjectName string `json:"object-name"`
ElementType ElementType `json:"element-type"`
}
func (Type) GetElementType ¶
func (t Type) GetElementType() ElementType
func (Type) GetObjectName ¶
func (Type) GetValidValues ¶
type TypeOrElementType ¶
type TypeOrElementType interface {
GetName() string
GetValidValues() []string
GetObjectName() string
GetElementType() ElementType
}
Click to show internal directories.
Click to hide internal directories.