schema_v1p2

Documentation

Index

• type LoopSpec
• type RequestConfig
• type ResponseConfig
• type Sample
  • func (s *Sample) IsDocSample() bool
  • func (s *Sample) IsStandaloneSample() bool
• type SampleConfig
• type WriteFileSpec

Types

type LoopSpec

type LoopSpec struct {
	Collection string
	Map        string
	Variable   string
	Key        string
	Value      string
	Body       []ResponseConfig
}

type RequestConfig

type RequestConfig struct {
	Field          string
	Comment        string
	Value          string
	ValueIsFile    bool   `yaml:"value_is_file"`
	InputParameter string `yaml:"input_parameter"`
}

type ResponseConfig

type ResponseConfig struct {
	Comment   []string
	Define    string
	Print     []string
	Loop      *LoopSpec
	WriteFile *WriteFileSpec
}

type Sample

type Sample struct {
	ID              string `yaml:"id"`
	Title           string
	RegionTag       string `yaml:"region_tag"`
	Description     string
	Service         string
	Rpc             string
	CallingPatterns []string `yaml:"calling_patterns"`
	Request         []RequestConfig
	Response        []ResponseConfig
	SampleType      []string `yaml:"sample_type"`
}

func (*Sample) IsDocSample

func (s *Sample) IsDocSample() bool

IsDocSample returns true iff s.SampleType specifies s should generate in-code (language doc) samples.

func (*Sample) IsStandaloneSample

func (s *Sample) IsStandaloneSample() bool

IsStandaloneSample returns true iff s.SampleType specifies s should generate standalone samples.

type SampleConfig

type SampleConfig struct {
	Type    string
	Version string `yaml:"schema_version"`
	Samples []*Sample
}

type WriteFileSpec

type WriteFileSpec struct {
	Contents string
	FileName []string `yaml: file_name`
}