fixture

Documentation

Index

• Constants
• type CrumbID
• type Fixtures
• type Operation
• type Parameter
• type Path
• type ResourceID
• type Resources
• type Service
• type ServiceID
• type Spec

Constants

const (
	// YFinQuotes are the yfin quote responses.
	YFinQuotes ResourceID = "quote"
	// YFinChart are the yfin chart responses.
	YFinChart ResourceID = "chart"
	// YFinOptions are the yfin options responses.
	YFinOptions ResourceID = "options"
	// YFinCrumb are the yfin crumb responses.
	YFinCrumb ResourceID = "crumb"
	// ServiceYFin is the yfin service.
	ServiceYFin ServiceID = "yfin"
)

Types

type CrumbID

type CrumbID string

CrumbID is just an identifier for a service.

type Fixtures

type Fixtures struct {
	Resources map[ServiceID]Resources `json:"resources"`
}

Fixtures is a collection of resources.

type Operation

type Operation struct {
	Parameters []*Parameter `yaml:"parameters"`
	ResourceID ResourceID   `yaml:"resource"`
}

Operation defines a service operation.

type Parameter

type Parameter struct {
	Description string `yaml:"description"`
	Name        string `yaml:"name"`
	Required    bool   `yaml:"required"`
}

Parameter describes a url parameter.

type Path

type Path string

Path is a url path.

type ResourceID

type ResourceID string

ResourceID is just an identifier for a resource.

type Resources

type Resources map[ResourceID]interface{}

Resources alias for resource map.

type Service

type Service struct {
	Paths map[Path]*Operation `yaml:"paths"`
}

Service is a collection of url paths and resources.

type ServiceID

type ServiceID string

ServiceID is just an identifier for a service.

type Spec

type Spec struct {
	Services map[ServiceID]*Service `yaml:"services"`
}

Spec specification of services.