Documentation
¶
Index ¶
- Constants
- func ContextWithSourceDocuments(ctx context.Context, sources *arazzo.SourceDocuments) context.Context
- type DependencyCycleRule
- func (r *DependencyCycleRule) Category() string
- func (r *DependencyCycleRule) DefaultSeverity() validation.Severity
- func (r *DependencyCycleRule) Description() string
- func (r *DependencyCycleRule) HowToFix() string
- func (r *DependencyCycleRule) ID() string
- func (r *DependencyCycleRule) Link() string
- func (r *DependencyCycleRule) Run(_ context.Context, docInfo *linter.DocumentInfo[*arazzo.Arazzo], ...) []error
- func (r *DependencyCycleRule) Summary() string
- func (r *DependencyCycleRule) Versions() []string
- type InfoDescriptionRule
- func (r *InfoDescriptionRule) Category() string
- func (r *InfoDescriptionRule) DefaultSeverity() validation.Severity
- func (r *InfoDescriptionRule) Description() string
- func (r *InfoDescriptionRule) FixAvailable() bool
- func (r *InfoDescriptionRule) HowToFix() string
- func (r *InfoDescriptionRule) ID() string
- func (r *InfoDescriptionRule) Link() string
- func (r *InfoDescriptionRule) Run(_ context.Context, docInfo *linter.DocumentInfo[*arazzo.Arazzo], ...) []error
- func (r *InfoDescriptionRule) Summary() string
- func (r *InfoDescriptionRule) Versions() []string
- type RetryAfterRule
- func (r *RetryAfterRule) Category() string
- func (r *RetryAfterRule) DefaultSeverity() validation.Severity
- func (r *RetryAfterRule) Description() string
- func (r *RetryAfterRule) HowToFix() string
- func (r *RetryAfterRule) ID() string
- func (r *RetryAfterRule) Link() string
- func (r *RetryAfterRule) Run(_ context.Context, docInfo *linter.DocumentInfo[*arazzo.Arazzo], ...) []error
- func (r *RetryAfterRule) Summary() string
- func (r *RetryAfterRule) Versions() []string
- type SourceDescriptionHTTPSRule
- func (r *SourceDescriptionHTTPSRule) Category() string
- func (r *SourceDescriptionHTTPSRule) DefaultSeverity() validation.Severity
- func (r *SourceDescriptionHTTPSRule) Description() string
- func (r *SourceDescriptionHTTPSRule) HowToFix() string
- func (r *SourceDescriptionHTTPSRule) ID() string
- func (r *SourceDescriptionHTTPSRule) Link() string
- func (r *SourceDescriptionHTTPSRule) Run(_ context.Context, docInfo *linter.DocumentInfo[*arazzo.Arazzo], ...) []error
- func (r *SourceDescriptionHTTPSRule) Summary() string
- func (r *SourceDescriptionHTTPSRule) Versions() []string
- type SourceDescriptionTypeRule
- func (r *SourceDescriptionTypeRule) Category() string
- func (r *SourceDescriptionTypeRule) DefaultSeverity() validation.Severity
- func (r *SourceDescriptionTypeRule) Description() string
- func (r *SourceDescriptionTypeRule) FixAvailable() bool
- func (r *SourceDescriptionTypeRule) HowToFix() string
- func (r *SourceDescriptionTypeRule) ID() string
- func (r *SourceDescriptionTypeRule) Link() string
- func (r *SourceDescriptionTypeRule) Run(ctx context.Context, docInfo *linter.DocumentInfo[*arazzo.Arazzo], ...) []error
- func (r *SourceDescriptionTypeRule) Summary() string
- func (r *SourceDescriptionTypeRule) Versions() []string
- type StepSuccessCriteriaRule
- func (r *StepSuccessCriteriaRule) Category() string
- func (r *StepSuccessCriteriaRule) DefaultSeverity() validation.Severity
- func (r *StepSuccessCriteriaRule) Description() string
- func (r *StepSuccessCriteriaRule) HowToFix() string
- func (r *StepSuccessCriteriaRule) ID() string
- func (r *StepSuccessCriteriaRule) Link() string
- func (r *StepSuccessCriteriaRule) Run(_ context.Context, docInfo *linter.DocumentInfo[*arazzo.Arazzo], ...) []error
- func (r *StepSuccessCriteriaRule) Summary() string
- func (r *StepSuccessCriteriaRule) Versions() []string
- type UnreachableStepRule
- func (r *UnreachableStepRule) Category() string
- func (r *UnreachableStepRule) DefaultSeverity() validation.Severity
- func (r *UnreachableStepRule) Description() string
- func (r *UnreachableStepRule) HowToFix() string
- func (r *UnreachableStepRule) ID() string
- func (r *UnreachableStepRule) Link() string
- func (r *UnreachableStepRule) Run(_ context.Context, docInfo *linter.DocumentInfo[*arazzo.Arazzo], ...) []error
- func (r *UnreachableStepRule) Summary() string
- func (r *UnreachableStepRule) Versions() []string
- type UnusedComponentRule
- func (r *UnusedComponentRule) Category() string
- func (r *UnusedComponentRule) DefaultSeverity() validation.Severity
- func (r *UnusedComponentRule) Description() string
- func (r *UnusedComponentRule) FixAvailable() bool
- func (r *UnusedComponentRule) HowToFix() string
- func (r *UnusedComponentRule) ID() string
- func (r *UnusedComponentRule) Link() string
- func (r *UnusedComponentRule) Run(_ context.Context, docInfo *linter.DocumentInfo[*arazzo.Arazzo], ...) []error
- func (r *UnusedComponentRule) Summary() string
- func (r *UnusedComponentRule) Versions() []string
- type UnusedStepOutputRule
- func (r *UnusedStepOutputRule) Category() string
- func (r *UnusedStepOutputRule) DefaultSeverity() validation.Severity
- func (r *UnusedStepOutputRule) Description() string
- func (r *UnusedStepOutputRule) HowToFix() string
- func (r *UnusedStepOutputRule) ID() string
- func (r *UnusedStepOutputRule) Link() string
- func (r *UnusedStepOutputRule) Run(_ context.Context, docInfo *linter.DocumentInfo[*arazzo.Arazzo], ...) []error
- func (r *UnusedStepOutputRule) Summary() string
- func (r *UnusedStepOutputRule) Versions() []string
- type UnusedWorkflowInputRule
- func (r *UnusedWorkflowInputRule) Category() string
- func (r *UnusedWorkflowInputRule) DefaultSeverity() validation.Severity
- func (r *UnusedWorkflowInputRule) Description() string
- func (r *UnusedWorkflowInputRule) HowToFix() string
- func (r *UnusedWorkflowInputRule) ID() string
- func (r *UnusedWorkflowInputRule) Link() string
- func (r *UnusedWorkflowInputRule) Run(_ context.Context, docInfo *linter.DocumentInfo[*arazzo.Arazzo], ...) []error
- func (r *UnusedWorkflowInputRule) Summary() string
- func (r *UnusedWorkflowInputRule) Versions() []string
- type WorkflowDescriptionRule
- func (r *WorkflowDescriptionRule) Category() string
- func (r *WorkflowDescriptionRule) DefaultSeverity() validation.Severity
- func (r *WorkflowDescriptionRule) Description() string
- func (r *WorkflowDescriptionRule) HowToFix() string
- func (r *WorkflowDescriptionRule) ID() string
- func (r *WorkflowDescriptionRule) Link() string
- func (r *WorkflowDescriptionRule) Run(_ context.Context, docInfo *linter.DocumentInfo[*arazzo.Arazzo], ...) []error
- func (r *WorkflowDescriptionRule) Summary() string
- func (r *WorkflowDescriptionRule) Versions() []string
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 (*DependencyCycleRule) Link ¶
func (r *DependencyCycleRule) Link() string
func (*DependencyCycleRule) Run ¶
func (r *DependencyCycleRule) Run(_ context.Context, docInfo *linter.DocumentInfo[*arazzo.Arazzo], config *linter.RuleConfig) []error
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 (*InfoDescriptionRule) Link ¶
func (r *InfoDescriptionRule) Link() string
func (*InfoDescriptionRule) Run ¶
func (r *InfoDescriptionRule) Run(_ context.Context, docInfo *linter.DocumentInfo[*arazzo.Arazzo], config *linter.RuleConfig) []error
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 (*RetryAfterRule) Link ¶
func (r *RetryAfterRule) Link() string
func (*RetryAfterRule) Run ¶
func (r *RetryAfterRule) Run(_ context.Context, docInfo *linter.DocumentInfo[*arazzo.Arazzo], config *linter.RuleConfig) []error
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 (r *SourceDescriptionHTTPSRule) ID() string
func (*SourceDescriptionHTTPSRule) Link ¶
func (r *SourceDescriptionHTTPSRule) Link() string
func (*SourceDescriptionHTTPSRule) Run ¶
func (r *SourceDescriptionHTTPSRule) Run(_ context.Context, docInfo *linter.DocumentInfo[*arazzo.Arazzo], config *linter.RuleConfig) []error
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 (r *SourceDescriptionTypeRule) ID() string
func (*SourceDescriptionTypeRule) Link ¶
func (r *SourceDescriptionTypeRule) Link() string
func (*SourceDescriptionTypeRule) Run ¶
func (r *SourceDescriptionTypeRule) Run(ctx context.Context, docInfo *linter.DocumentInfo[*arazzo.Arazzo], config *linter.RuleConfig) []error
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) ID() string
func (*StepSuccessCriteriaRule) Link ¶
func (r *StepSuccessCriteriaRule) Link() string
func (*StepSuccessCriteriaRule) Run ¶
func (r *StepSuccessCriteriaRule) Run(_ context.Context, docInfo *linter.DocumentInfo[*arazzo.Arazzo], config *linter.RuleConfig) []error
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 (*UnreachableStepRule) Link ¶
func (r *UnreachableStepRule) Link() string
func (*UnreachableStepRule) Run ¶
func (r *UnreachableStepRule) Run(_ context.Context, docInfo *linter.DocumentInfo[*arazzo.Arazzo], config *linter.RuleConfig) []error
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 (*UnusedComponentRule) Link ¶
func (r *UnusedComponentRule) Link() string
func (*UnusedComponentRule) Run ¶
func (r *UnusedComponentRule) Run(_ context.Context, docInfo *linter.DocumentInfo[*arazzo.Arazzo], config *linter.RuleConfig) []error
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 (*UnusedStepOutputRule) Link ¶
func (r *UnusedStepOutputRule) Link() string
func (*UnusedStepOutputRule) Run ¶
func (r *UnusedStepOutputRule) Run(_ context.Context, docInfo *linter.DocumentInfo[*arazzo.Arazzo], config *linter.RuleConfig) []error
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) ID() string
func (*UnusedWorkflowInputRule) Link ¶
func (r *UnusedWorkflowInputRule) Link() string
func (*UnusedWorkflowInputRule) Run ¶
func (r *UnusedWorkflowInputRule) Run(_ context.Context, docInfo *linter.DocumentInfo[*arazzo.Arazzo], config *linter.RuleConfig) []error
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) ID() string
func (*WorkflowDescriptionRule) Link ¶
func (r *WorkflowDescriptionRule) Link() string
func (*WorkflowDescriptionRule) Run ¶
func (r *WorkflowDescriptionRule) Run(_ context.Context, docInfo *linter.DocumentInfo[*arazzo.Arazzo], config *linter.RuleConfig) []error
func (*WorkflowDescriptionRule) Summary ¶
func (r *WorkflowDescriptionRule) Summary() string
func (*WorkflowDescriptionRule) Versions ¶
func (r *WorkflowDescriptionRule) Versions() []string
Click to show internal directories.
Click to hide internal directories.