Documentation
¶
Index ¶
- type AdditionalPropertiesConstrained
- type ArrayLimit
- type AuthInsecureSchemes
- type CheckErrorResponse
- type CheckSecurity
- type DefineErrorDefinition
- type HeaderDefinition
- type HostsHttps
- type IntegerFormat
- type IntegerLimit
- type JWTBestPractice
- type NoAdditionalProperties
- type NoApiKeyInUrl
- type NoBasicAuth
- type NoCredentialsInUrl
- type NoNumericIds
- type RatelimitRetry429
- type StringLimit
- type StringRestricted
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AdditionalPropertiesConstrained ¶ added in v0.7.0
type AdditionalPropertiesConstrained struct{}
func (AdditionalPropertiesConstrained) GetSchema ¶ added in v0.7.0
func (ad AdditionalPropertiesConstrained) GetSchema() model.RuleFunctionSchema
GetSchema returns a model.RuleFunctionSchema defining the schema of the DefineError rule.
func (AdditionalPropertiesConstrained) RunRule ¶ added in v0.7.0
func (ad AdditionalPropertiesConstrained) RunRule(_ []*yaml.Node, context model.RuleFunctionContext) []model.RuleFunctionResult
RunRule will execute the DefineError rule, based on supplied context and a supplied []*yaml.Node slice.
type ArrayLimit ¶ added in v0.7.0
type ArrayLimit struct{}
func (ArrayLimit) GetSchema ¶ added in v0.7.0
func (ar ArrayLimit) GetSchema() model.RuleFunctionSchema
GetSchema returns a model.RuleFunctionSchema defining the schema of the DefineError rule.
func (ArrayLimit) RunRule ¶ added in v0.7.0
func (ar ArrayLimit) RunRule(_ []*yaml.Node, context model.RuleFunctionContext) []model.RuleFunctionResult
RunRule will execute the DefineError rule, based on supplied context and a supplied []*yaml.Node slice.
type AuthInsecureSchemes ¶ added in v0.7.0
type AuthInsecureSchemes struct{}
func (AuthInsecureSchemes) GetSchema ¶ added in v0.7.0
func (is AuthInsecureSchemes) GetSchema() model.RuleFunctionSchema
GetSchema returns a model.RuleFunctionSchema defining the schema of the DefineError rule.
func (AuthInsecureSchemes) RunRule ¶ added in v0.7.0
func (is AuthInsecureSchemes) RunRule(_ []*yaml.Node, context model.RuleFunctionContext) []model.RuleFunctionResult
RunRule will execute the DefineError rule, based on supplied context and a supplied []*yaml.Node slice.
type CheckErrorResponse ¶ added in v0.7.0
type CheckErrorResponse struct {
}
func (CheckErrorResponse) GetSchema ¶ added in v0.7.0
func (er CheckErrorResponse) GetSchema() model.RuleFunctionSchema
GetSchema returns a model.RuleFunctionSchema defining the schema of the DefineError rule.
func (CheckErrorResponse) RunRule ¶ added in v0.7.0
func (er CheckErrorResponse) RunRule(_ []*yaml.Node, context model.RuleFunctionContext) []model.RuleFunctionResult
RunRule will execute the DefineError rule, based on supplied context and a supplied []*yaml.Node slice.
type CheckSecurity ¶
type CheckSecurity struct {
}
func (CheckSecurity) GetSchema ¶
func (cd CheckSecurity) GetSchema() model.RuleFunctionSchema
GetSchema returns a model.RuleFunctionSchema defining the schema of the CheckSecurity rule.
func (CheckSecurity) RunRule ¶
func (cd CheckSecurity) RunRule(nodes []*yaml.Node, context model.RuleFunctionContext) []model.RuleFunctionResult
RunRule will execute the CheckSecurity rule, based on supplied context and a supplied []*yaml.Node slice.
type DefineErrorDefinition ¶
type DefineErrorDefinition struct {
}
func (DefineErrorDefinition) GetSchema ¶
func (cd DefineErrorDefinition) GetSchema() model.RuleFunctionSchema
GetSchema returns a model.RuleFunctionSchema defining the schema of the DefineError rule.
func (DefineErrorDefinition) RunRule ¶
func (cd DefineErrorDefinition) RunRule(_ []*yaml.Node, context model.RuleFunctionContext) []model.RuleFunctionResult
RunRule will execute the DefineError rule, based on supplied context and a supplied []*yaml.Node slice.
type HeaderDefinition ¶
type HeaderDefinition struct {
}
func (HeaderDefinition) GetSchema ¶
func (cd HeaderDefinition) GetSchema() model.RuleFunctionSchema
GetSchema returns a model.RuleFunctionSchema defining the schema of the HeaderDefinition rule.
func (HeaderDefinition) RunRule ¶
func (cd HeaderDefinition) RunRule(_ []*yaml.Node, context model.RuleFunctionContext) []model.RuleFunctionResult
RunRule will execute the HeaderDefinition rule, based on supplied context and a supplied []*yaml.Node slice.
type HostsHttps ¶ added in v0.7.0
type HostsHttps struct{}
func (HostsHttps) GetSchema ¶ added in v0.7.0
func (hh HostsHttps) GetSchema() model.RuleFunctionSchema
GetSchema returns a model.RuleFunctionSchema defining the schema of the DefineError rule.
func (HostsHttps) RunRule ¶ added in v0.7.0
func (hh HostsHttps) RunRule(_ []*yaml.Node, context model.RuleFunctionContext) []model.RuleFunctionResult
RunRule will execute the DefineError rule, based on supplied context and a supplied []*yaml.Node slice.
type IntegerFormat ¶ added in v0.7.0
type IntegerFormat struct{}
func (IntegerFormat) GetSchema ¶ added in v0.7.0
func (i IntegerFormat) GetSchema() model.RuleFunctionSchema
GetSchema returns a model.RuleFunctionSchema defining the schema of the DefineError rule.
func (IntegerFormat) RunRule ¶ added in v0.7.0
func (i IntegerFormat) RunRule(_ []*yaml.Node, context model.RuleFunctionContext) []model.RuleFunctionResult
RunRule will execute the DefineError rule, based on supplied context and a supplied []*yaml.Node slice.
type IntegerLimit ¶ added in v0.7.0
type IntegerLimit struct{}
func (IntegerLimit) GetSchema ¶ added in v0.7.0
func (il IntegerLimit) GetSchema() model.RuleFunctionSchema
GetSchema returns a model.RuleFunctionSchema defining the schema of the DefineError rule.
func (IntegerLimit) RunRule ¶ added in v0.7.0
func (il IntegerLimit) RunRule(_ []*yaml.Node, context model.RuleFunctionContext) []model.RuleFunctionResult
RunRule will execute the DefineError rule, based on supplied context and a supplied []*yaml.Node slice.
type JWTBestPractice ¶ added in v0.7.0
type JWTBestPractice struct{}
func (JWTBestPractice) GetSchema ¶ added in v0.7.0
func (jwt JWTBestPractice) GetSchema() model.RuleFunctionSchema
GetSchema returns a model.RuleFunctionSchema defining the schema of the DefineError rule.
func (JWTBestPractice) RunRule ¶ added in v0.7.0
func (jwt JWTBestPractice) RunRule(_ []*yaml.Node, context model.RuleFunctionContext) []model.RuleFunctionResult
RunRule will execute the DefineError rule, based on supplied context and a supplied []*yaml.Node slice.
type NoAdditionalProperties ¶ added in v0.7.0
type NoAdditionalProperties struct{}
func (NoAdditionalProperties) GetSchema ¶ added in v0.7.0
func (na NoAdditionalProperties) GetSchema() model.RuleFunctionSchema
GetSchema returns a model.RuleFunctionSchema defining the schema of the DefineError rule.
func (NoAdditionalProperties) RunRule ¶ added in v0.7.0
func (na NoAdditionalProperties) RunRule(_ []*yaml.Node, context model.RuleFunctionContext) []model.RuleFunctionResult
RunRule will execute the DefineError rule, based on supplied context and a supplied []*yaml.Node slice.
type NoApiKeyInUrl ¶ added in v0.7.0
type NoApiKeyInUrl struct{}
func (NoApiKeyInUrl) GetSchema ¶ added in v0.7.0
func (ak NoApiKeyInUrl) GetSchema() model.RuleFunctionSchema
GetSchema returns a model.RuleFunctionSchema defining the schema of the DefineError rule.
func (NoApiKeyInUrl) RunRule ¶ added in v0.7.0
func (ak NoApiKeyInUrl) RunRule(_ []*yaml.Node, context model.RuleFunctionContext) []model.RuleFunctionResult
RunRule will execute the DefineError rule, based on supplied context and a supplied []*yaml.Node slice.
type NoBasicAuth ¶ added in v0.7.0
type NoBasicAuth struct{}
func (NoBasicAuth) GetSchema ¶ added in v0.7.0
func (ba NoBasicAuth) GetSchema() model.RuleFunctionSchema
GetSchema returns a model.RuleFunctionSchema defining the schema of the DefineError rule.
func (NoBasicAuth) RunRule ¶ added in v0.7.0
func (ba NoBasicAuth) RunRule(_ []*yaml.Node, context model.RuleFunctionContext) []model.RuleFunctionResult
RunRule will execute the DefineError rule, based on supplied context and a supplied []*yaml.Node slice.
type NoCredentialsInUrl ¶ added in v0.7.0
type NoCredentialsInUrl struct{}
func (NoCredentialsInUrl) GetSchema ¶ added in v0.7.0
func (c NoCredentialsInUrl) GetSchema() model.RuleFunctionSchema
GetSchema returns a model.RuleFunctionSchema defining the schema of the DefineError rule.
func (NoCredentialsInUrl) RunRule ¶ added in v0.7.0
func (c NoCredentialsInUrl) RunRule(_ []*yaml.Node, context model.RuleFunctionContext) []model.RuleFunctionResult
RunRule will execute the DefineError rule, based on supplied context and a supplied []*yaml.Node slice.
type NoNumericIds ¶ added in v0.7.0
type NoNumericIds struct{}
func (NoNumericIds) GetSchema ¶ added in v0.7.0
func (ni NoNumericIds) GetSchema() model.RuleFunctionSchema
GetSchema returns a model.RuleFunctionSchema defining the schema of the DefineError rule.
func (NoNumericIds) RunRule ¶ added in v0.7.0
func (ni NoNumericIds) RunRule(_ []*yaml.Node, context model.RuleFunctionContext) []model.RuleFunctionResult
RunRule will execute the DefineError rule, based on supplied context and a supplied []*yaml.Node slice.
type RatelimitRetry429 ¶ added in v0.7.0
type RatelimitRetry429 struct {
}
func (RatelimitRetry429) GetSchema ¶ added in v0.7.0
func (r RatelimitRetry429) GetSchema() model.RuleFunctionSchema
GetSchema returns a model.RuleFunctionSchema defining the schema of the DefineError rule.
func (RatelimitRetry429) RunRule ¶ added in v0.7.0
func (r RatelimitRetry429) RunRule(_ []*yaml.Node, context model.RuleFunctionContext) []model.RuleFunctionResult
RunRule will execute the DefineError rule, based on supplied context and a supplied []*yaml.Node slice.
type StringLimit ¶ added in v0.7.0
type StringLimit struct{}
func (StringLimit) GetSchema ¶ added in v0.7.0
func (st StringLimit) GetSchema() model.RuleFunctionSchema
GetSchema returns a model.RuleFunctionSchema defining the schema of the DefineError rule.
func (StringLimit) RunRule ¶ added in v0.7.0
func (st StringLimit) RunRule(_ []*yaml.Node, context model.RuleFunctionContext) []model.RuleFunctionResult
RunRule will execute the DefineError rule, based on supplied context and a supplied []*yaml.Node slice.
type StringRestricted ¶ added in v0.7.0
type StringRestricted struct{}
func (StringRestricted) GetSchema ¶ added in v0.7.0
func (st StringRestricted) GetSchema() model.RuleFunctionSchema
GetSchema returns a model.RuleFunctionSchema defining the schema of the DefineError rule.
func (StringRestricted) RunRule ¶ added in v0.7.0
func (st StringRestricted) RunRule(_ []*yaml.Node, context model.RuleFunctionContext) []model.RuleFunctionResult
RunRule will execute the DefineError rule, based on supplied context and a supplied []*yaml.Node slice.
Source Files
¶
- additional_properties_constrained.go
- array_limit.go
- auth_insecure_schemes.go
- check_error_response.go
- check_security.go
- define_error_definition.go
- header_definition.go
- hosts_https.go
- integer_format.go
- integer_limit.go
- jwt_best_practice.go
- no_additional_properties.go
- no_api_key_url.go
- no_basic_auth.go
- no_credentials_in_url.go
- no_numeric_ids.go
- ratelimit_retry_429.go
- string_limit.go
- string_restricted.go