formatters

package

v0.15.0-rc2 Latest Latest Go to latest Published: Apr 9, 2026 License: AGPL-3.0 Imports: 4 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/compliance-framework/api

Links

Open Source Insights

Documentation ¶

Index ¶

func FormatDigestMessage(digestSummary *DigestSummary) (*types.Message, error)
func FormatWorkflowTaskAssignedMessage(userName string, stepTitle string, workflowTitle string, ...) (*types.Message, error)
func FormatWorkflowTaskDigestMessage(userName string, periodLabel string, pendingTasks []WorkflowTaskDigestItem, ...) (*types.Message, error)
func FormatWorkflowTaskDueSoonMessage(userName string, stepTitle string, workflowTitle string, ...) (*types.Message, error)
type DigestSummary
type DigestSummaryEvidence
type WorkflowTaskDigestItem

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func FormatDigestMessage ¶

func FormatDigestMessage(digestSummary *DigestSummary) (*types.Message, error)

func FormatWorkflowTaskAssignedMessage ¶

func FormatWorkflowTaskAssignedMessage(
	userName string,
	stepTitle string,
	workflowTitle string,
	workflowInstanceTitle string,
	stepURL string,
	dueDate string,
) (*types.Message, error)

func FormatWorkflowTaskDigestMessage ¶

func FormatWorkflowTaskDigestMessage(
	userName string,
	periodLabel string,
	pendingTasks []WorkflowTaskDigestItem,
	overdueTasks []WorkflowTaskDigestItem,
	myTasksURL string,
) (*types.Message, error)

func FormatWorkflowTaskDueSoonMessage ¶

func FormatWorkflowTaskDueSoonMessage(
	userName string,
	stepTitle string,
	workflowTitle string,
	workflowInstanceTitle string,
	stepURL string,
	dueDate string,
) (*types.Message, error)

Types ¶

type DigestSummary ¶

type DigestSummary struct {
	TotalCount        int64
	SatisfiedCount    int64
	NotSatisfiedCount int64
	ExpiredCount      int64

	TopExpired      []DigestSummaryEvidence
	TopNotSatisfied []DigestSummaryEvidence

	BaseURL string
}

type DigestSummaryEvidence ¶

type DigestSummaryEvidence struct {
	Title       string
	Description string
	ExpiresAt   string
	ID          string
}

type WorkflowTaskDigestItem ¶

type WorkflowTaskDigestItem struct {
	StepTitle             string
	WorkflowTitle         string
	WorkflowInstanceTitle string
	DueDate               string
	StepURL               string
}

Source Files ¶

View all Source files

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