Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrConfigRequired = errors.New("config is required")
Functions ¶
This section is empty.
Types ¶
type ArazzoConfig ¶
type ArazzoConfig struct {
Doc string `yaml:"doc" json:"doc"`
Workflows []string `yaml:"workflows,omitempty" json:"workflows,omitempty"` // empty = all
}
ArazzoConfig specifies Arazzo workflow run.
type ArazzoResult ¶
type ArazzoResult struct {
Workflows []WorkflowResult `json:"workflows"`
Passed int `json:"passed"`
Total int `json:"total"`
}
ArazzoResult is the result of Arazzo workflow runs.
type Config ¶
type Config struct {
OpenAPI *OpenAPIConfig `yaml:"openapi,omitempty" json:"openapi,omitempty"`
Arazzo *ArazzoConfig `yaml:"arazzo,omitempty" json:"arazzo,omitempty"`
BaseURL string `yaml:"baseUrl,omitempty" json:"baseUrl,omitempty"`
ProxyURL string `yaml:"proxyUrl,omitempty" json:"proxyUrl,omitempty"`
Output string `yaml:"output,omitempty" json:"output,omitempty"` // human, junit, json
}
Config is the barometer config file (e.g. barometer.yaml).
func LoadConfig ¶
LoadConfig reads a config file from path.
type OpenAPIConfig ¶
type OpenAPIConfig struct {
Spec string `yaml:"spec" json:"spec"`
Tags []string `yaml:"tags,omitempty" json:"tags,omitempty"`
}
OpenAPIConfig specifies OpenAPI contract test run.
type OpenAPIResult ¶
type OpenAPIResult struct {
Results []openapi.ContractResult `json:"results"`
Passed int `json:"passed"`
Total int `json:"total"`
}
OpenAPIResult is the result of OpenAPI contract tests.
type Result ¶
type Result struct {
OpenAPI *OpenAPIResult `json:"openapi,omitempty"`
Arazzo *ArazzoResult `json:"arazzo,omitempty"`
Pass bool `json:"pass"`
}
Result holds the combined result of a contract test run (OpenAPI + Arazzo).
Click to show internal directories.
Click to hide internal directories.