scrape

Documentation

Index

• Variables
• func Verify(items *APIResponse) bool
• type APIResponse
  • func RetrieveInfo() (*APIResponse, error)
• type Base
• type BaseData
• type Category
  • func (c Category) String() string
• type Enum
• type Field
• type Method
  • func (m *Method) GetBase() *Base
• type Type
  • func (t *Type) GetBase() *Base

Variables

var (
	CoreTypes = map[string]struct{}{
		"String":  {},
		"Boolean": {},
		"Integer": {},
		"Float":   {},
	}
)

Functions

func Verify

func Verify(items *APIResponse) bool

Types

type APIResponse

type APIResponse struct {
	Version     string    `json:"version"`
	ReleaseDate string    `json:"release_date"`
	Changelog   string    `json:"changelog"`
	Methods     []*Method `json:"methods"`
	Types       []*Type   `json:"types"`
	Enums       []*Enum   `json:"enums"`
}

func RetrieveInfo

func RetrieveInfo() (*APIResponse, error)

type Base

type Base struct {
	Name        string   `json:"name"`
	Href        string   `json:"href,omitempty"`
	Description []string `json:"description,omitempty"`
	Fields      []*Field `json:"fields,omitempty"`
	// contains filtered or unexported fields
}

type BaseData

type BaseData interface {
	GetBase() *Base
}

type Category

type Category int

const (
	CategoryType Category = iota
	CategoryMethod
)

func (Category) String

func (c Category) String() string

type Enum

type Enum struct {
	Name   string   `json:"name"`
	Values []string `json:"values"`
}

type Field

type Field struct {
	Name        string   `json:"name"`
	Types       []string `json:"types"`
	Required    bool     `json:"required"`
	Description string   `json:"description"`
	Const       string   `json:"const,omitempty"`
}

type Method

type Method struct {
	Base
	Returns []string `json:"returns"`
}

func (*Method) GetBase

func (m *Method) GetBase() *Base

type Type

type Type struct {
	Base
	Subtypes  []string `json:"subtypes,omitempty"`
	SubtypeOf []string `json:"subtype_of,omitempty"`
}

func (*Type) GetBase

func (t *Type) GetBase() *Base