rules

package
v1.27.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 17, 2026 License: MIT Imports: 15 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// CategorySemantic represents rules that check for logical issues that make a workflow broken, unreachable or
	// harder to maintain. Examples: unreachable steps, dependency cycles, unused components.
	CategorySemantic = "semantic"

	// CategoryStyle represents rules that check for documentation and authoring conventions.
	// Examples: missing descriptions, steps without success criteria.
	CategoryStyle = "style"

	// CategorySecurity represents rules that check for security concerns.
	// Examples: source descriptions loaded over plain HTTP.
	CategorySecurity = "security"
)
View Source
const RuleSecuritySourceDescriptionHTTPS = "security-source-description-https"
View Source
const RuleSemanticDependencyCycle = "semantic-dependency-cycle"
View Source
const RuleSemanticUnreachableStep = "semantic-unreachable-step"
View Source
const RuleSemanticUnusedComponent = "semantic-unused-component"
View Source
const RuleSemanticUnusedStepOutput = "semantic-unused-step-output"
View Source
const RuleSemanticUnusedWorkflowInput = "semantic-unused-workflow-input"
View Source
const RuleStyleInfoDescription = "style-info-description"
View Source
const RuleStyleRetryAfter = "style-retry-after"
View Source
const RuleStyleSourceDescriptionType = "style-source-description-type"
View Source
const RuleStyleStepSuccessCriteria = "style-step-success-criteria"
View Source
const RuleStyleWorkflowDescription = "style-workflow-description"

Variables

This section is empty.

Functions

func ContextWithSourceDocuments

func ContextWithSourceDocuments(ctx context.Context, sources *arazzo.SourceDocuments) context.Context

ContextWithSourceDocuments returns a context carrying the documents loaded for the Arazzo document's sourceDescriptions (see arazzo.LoadSourceDescriptions). Rules use them to improve their findings and fixes, for example to suggest a sourceDescription's type from the document it references.

Types

type DependencyCycleRule

type DependencyCycleRule struct{}

func (*DependencyCycleRule) Category

func (r *DependencyCycleRule) Category() string

func (*DependencyCycleRule) DefaultSeverity

func (r *DependencyCycleRule) DefaultSeverity() validation.Severity

func (*DependencyCycleRule) Description

func (r *DependencyCycleRule) Description() string

func (*DependencyCycleRule) HowToFix

func (r *DependencyCycleRule) HowToFix() string

func (*DependencyCycleRule) ID

func (r *DependencyCycleRule) ID() string
func (r *DependencyCycleRule) Link() string

func (*DependencyCycleRule) Run

func (*DependencyCycleRule) Summary

func (r *DependencyCycleRule) Summary() string

func (*DependencyCycleRule) Versions

func (r *DependencyCycleRule) Versions() []string

type InfoDescriptionRule

type InfoDescriptionRule struct{}

func (*InfoDescriptionRule) Category

func (r *InfoDescriptionRule) Category() string

func (*InfoDescriptionRule) DefaultSeverity

func (r *InfoDescriptionRule) DefaultSeverity() validation.Severity

func (*InfoDescriptionRule) Description

func (r *InfoDescriptionRule) Description() string

func (*InfoDescriptionRule) FixAvailable

func (r *InfoDescriptionRule) FixAvailable() bool

func (*InfoDescriptionRule) HowToFix

func (r *InfoDescriptionRule) HowToFix() string

func (*InfoDescriptionRule) ID

func (r *InfoDescriptionRule) ID() string
func (r *InfoDescriptionRule) Link() string

func (*InfoDescriptionRule) Run

func (*InfoDescriptionRule) Summary

func (r *InfoDescriptionRule) Summary() string

func (*InfoDescriptionRule) Versions

func (r *InfoDescriptionRule) Versions() []string

type RetryAfterRule

type RetryAfterRule struct{}

func (*RetryAfterRule) Category

func (r *RetryAfterRule) Category() string

func (*RetryAfterRule) DefaultSeverity

func (r *RetryAfterRule) DefaultSeverity() validation.Severity

func (*RetryAfterRule) Description

func (r *RetryAfterRule) Description() string

func (*RetryAfterRule) HowToFix

func (r *RetryAfterRule) HowToFix() string

func (*RetryAfterRule) ID

func (r *RetryAfterRule) ID() string
func (r *RetryAfterRule) Link() string

func (*RetryAfterRule) Run

func (*RetryAfterRule) Summary

func (r *RetryAfterRule) Summary() string

func (*RetryAfterRule) Versions

func (r *RetryAfterRule) Versions() []string

type SourceDescriptionHTTPSRule

type SourceDescriptionHTTPSRule struct{}

func (*SourceDescriptionHTTPSRule) Category

func (r *SourceDescriptionHTTPSRule) Category() string

func (*SourceDescriptionHTTPSRule) DefaultSeverity

func (r *SourceDescriptionHTTPSRule) DefaultSeverity() validation.Severity

func (*SourceDescriptionHTTPSRule) Description

func (r *SourceDescriptionHTTPSRule) Description() string

func (*SourceDescriptionHTTPSRule) HowToFix

func (r *SourceDescriptionHTTPSRule) HowToFix() string

func (*SourceDescriptionHTTPSRule) ID

func (*SourceDescriptionHTTPSRule) Run

func (*SourceDescriptionHTTPSRule) Summary

func (r *SourceDescriptionHTTPSRule) Summary() string

func (*SourceDescriptionHTTPSRule) Versions

func (r *SourceDescriptionHTTPSRule) Versions() []string

type SourceDescriptionTypeRule

type SourceDescriptionTypeRule struct{}

func (*SourceDescriptionTypeRule) Category

func (r *SourceDescriptionTypeRule) Category() string

func (*SourceDescriptionTypeRule) DefaultSeverity

func (r *SourceDescriptionTypeRule) DefaultSeverity() validation.Severity

func (*SourceDescriptionTypeRule) Description

func (r *SourceDescriptionTypeRule) Description() string

func (*SourceDescriptionTypeRule) FixAvailable

func (r *SourceDescriptionTypeRule) FixAvailable() bool

func (*SourceDescriptionTypeRule) HowToFix

func (r *SourceDescriptionTypeRule) HowToFix() string

func (*SourceDescriptionTypeRule) ID

func (*SourceDescriptionTypeRule) Run

func (*SourceDescriptionTypeRule) Summary

func (r *SourceDescriptionTypeRule) Summary() string

func (*SourceDescriptionTypeRule) Versions

func (r *SourceDescriptionTypeRule) Versions() []string

type StepSuccessCriteriaRule

type StepSuccessCriteriaRule struct{}

func (*StepSuccessCriteriaRule) Category

func (r *StepSuccessCriteriaRule) Category() string

func (*StepSuccessCriteriaRule) DefaultSeverity

func (r *StepSuccessCriteriaRule) DefaultSeverity() validation.Severity

func (*StepSuccessCriteriaRule) Description

func (r *StepSuccessCriteriaRule) Description() string

func (*StepSuccessCriteriaRule) HowToFix

func (r *StepSuccessCriteriaRule) HowToFix() string

func (*StepSuccessCriteriaRule) ID

func (r *StepSuccessCriteriaRule) Link() string

func (*StepSuccessCriteriaRule) Run

func (*StepSuccessCriteriaRule) Summary

func (r *StepSuccessCriteriaRule) Summary() string

func (*StepSuccessCriteriaRule) Versions

func (r *StepSuccessCriteriaRule) Versions() []string

type UnreachableStepRule

type UnreachableStepRule struct{}

func (*UnreachableStepRule) Category

func (r *UnreachableStepRule) Category() string

func (*UnreachableStepRule) DefaultSeverity

func (r *UnreachableStepRule) DefaultSeverity() validation.Severity

func (*UnreachableStepRule) Description

func (r *UnreachableStepRule) Description() string

func (*UnreachableStepRule) HowToFix

func (r *UnreachableStepRule) HowToFix() string

func (*UnreachableStepRule) ID

func (r *UnreachableStepRule) ID() string
func (r *UnreachableStepRule) Link() string

func (*UnreachableStepRule) Run

func (*UnreachableStepRule) Summary

func (r *UnreachableStepRule) Summary() string

func (*UnreachableStepRule) Versions

func (r *UnreachableStepRule) Versions() []string

type UnusedComponentRule

type UnusedComponentRule struct{}

func (*UnusedComponentRule) Category

func (r *UnusedComponentRule) Category() string

func (*UnusedComponentRule) DefaultSeverity

func (r *UnusedComponentRule) DefaultSeverity() validation.Severity

func (*UnusedComponentRule) Description

func (r *UnusedComponentRule) Description() string

func (*UnusedComponentRule) FixAvailable

func (r *UnusedComponentRule) FixAvailable() bool

func (*UnusedComponentRule) HowToFix

func (r *UnusedComponentRule) HowToFix() string

func (*UnusedComponentRule) ID

func (r *UnusedComponentRule) ID() string
func (r *UnusedComponentRule) Link() string

func (*UnusedComponentRule) Run

func (*UnusedComponentRule) Summary

func (r *UnusedComponentRule) Summary() string

func (*UnusedComponentRule) Versions

func (r *UnusedComponentRule) Versions() []string

type UnusedStepOutputRule

type UnusedStepOutputRule struct{}

func (*UnusedStepOutputRule) Category

func (r *UnusedStepOutputRule) Category() string

func (*UnusedStepOutputRule) DefaultSeverity

func (r *UnusedStepOutputRule) DefaultSeverity() validation.Severity

func (*UnusedStepOutputRule) Description

func (r *UnusedStepOutputRule) Description() string

func (*UnusedStepOutputRule) HowToFix

func (r *UnusedStepOutputRule) HowToFix() string

func (*UnusedStepOutputRule) ID

func (r *UnusedStepOutputRule) ID() string
func (r *UnusedStepOutputRule) Link() string

func (*UnusedStepOutputRule) Run

func (*UnusedStepOutputRule) Summary

func (r *UnusedStepOutputRule) Summary() string

func (*UnusedStepOutputRule) Versions

func (r *UnusedStepOutputRule) Versions() []string

type UnusedWorkflowInputRule

type UnusedWorkflowInputRule struct{}

func (*UnusedWorkflowInputRule) Category

func (r *UnusedWorkflowInputRule) Category() string

func (*UnusedWorkflowInputRule) DefaultSeverity

func (r *UnusedWorkflowInputRule) DefaultSeverity() validation.Severity

func (*UnusedWorkflowInputRule) Description

func (r *UnusedWorkflowInputRule) Description() string

func (*UnusedWorkflowInputRule) HowToFix

func (r *UnusedWorkflowInputRule) HowToFix() string

func (*UnusedWorkflowInputRule) ID

func (r *UnusedWorkflowInputRule) Link() string

func (*UnusedWorkflowInputRule) Run

func (*UnusedWorkflowInputRule) Summary

func (r *UnusedWorkflowInputRule) Summary() string

func (*UnusedWorkflowInputRule) Versions

func (r *UnusedWorkflowInputRule) Versions() []string

type WorkflowDescriptionRule

type WorkflowDescriptionRule struct{}

func (*WorkflowDescriptionRule) Category

func (r *WorkflowDescriptionRule) Category() string

func (*WorkflowDescriptionRule) DefaultSeverity

func (r *WorkflowDescriptionRule) DefaultSeverity() validation.Severity

func (*WorkflowDescriptionRule) Description

func (r *WorkflowDescriptionRule) Description() string

func (*WorkflowDescriptionRule) HowToFix

func (r *WorkflowDescriptionRule) HowToFix() string

func (*WorkflowDescriptionRule) ID

func (r *WorkflowDescriptionRule) Link() string

func (*WorkflowDescriptionRule) Run

func (*WorkflowDescriptionRule) Summary

func (r *WorkflowDescriptionRule) Summary() string

func (*WorkflowDescriptionRule) Versions

func (r *WorkflowDescriptionRule) Versions() []string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL