pidl

package module

Go to main page

Versions in this module

v0

v0.10.0

Oct 27, 2026

Changes in this version

+ const BindingFormat

+ const DefaultBodyLimit

+ const ObservationFormat

+ const ObservedMatched

+ const ObservedNotSeen

+ const ObservedSkipped

+ const ObservedStrong

+ const ObservedUnmatchable

+ const ObservedUnobservable

+ const ObservedWeak

+ func IsObservation(data []byte) bool

+ func NewObservedBody(data []byte, mediaType string, limit int) (body json.RawMessage, truncated bool, err error)

+ func StepKeys(scenario, expandedID, definedIn, flowID string) []string

+ type BinaryBody struct

+ Base64 string

+ MediaType string

+ type Binding struct

+ Format string

+ LabelsByPath []BindingLabelRule

+ Participants map[string]BindingParticipant

+ Paths map[string]map[string]string

+ Rewrite []BindingRewrite

+ Steps map[string]BindingStep

+ Unobservable []string

+ func ParseBinding(data []byte) (*Binding, error)

+ func ReadBinding(path string) (*Binding, error)

+ func (b *Binding) StepPath(participant, scenario, expandedID, definedIn, flowID string) (string, string, bool)

+ func (b *Binding) StepRule(scenario, expandedID, definedIn, flowID string) (StepMatch, string, bool)

+ func (b *Binding) Validate() ValidationErrors

+ func (b *Binding) WriteFile(path string) error

+ type BindingLabelRule struct

+ Label string

+ Participant string

+ Path string

+ type BindingParticipant struct

+ Hosts []string

+ Labels []string

+ type BindingRewrite struct

+ Match string

+ To string

+ type BindingStep struct

+ Match StepMatch

+ type Exchange struct

+ Annotations []ExchangeAnnotation

+ BodyTruncated bool

+ From string

+ Label string

+ Request ObservedRequest

+ RequestID string

+ Response ObservedResponse

+ Time *time.Time

+ To string

+ type ExchangeAnnotation struct

+ Kind string

+ OK *bool

+ Text string

+ Time *time.Time

type Flow

+ Match *StepMatch

+ type Observation struct

+ Exchanges []Exchange

+ Format string

+ Source ObservationSource

+ func ParseObservation(data []byte) (*Observation, error)

+ func ReadObservation(path string) (*Observation, error)

+ func (o *Observation) Validate() ValidationErrors

+ func (o *Observation) WriteFile(path string) error

+ type ObservationSource struct

+ From *time.Time

+ RequestFidelity RequestFidelity

+ To *time.Time

+ Tool string

+ type ObservedExtra struct

+ AfterStep int

+ From string

+ Observed ObservedMessage

+ To string

+ type ObservedHeaders [][2]string

+ func (h ObservedHeaders) Get(name string) (string, bool)

+ type ObservedMessage struct

+ Annotations []ExchangeAnnotation

+ BodyTruncated bool

+ From string

+ Label string

+ Repeats int

+ Request *ExampleRequest

+ RequestID string

+ Response *ExampleResponse

+ Time *time.Time

+ To string

+ Tokens []ExampleToken

+ type ObservedRequest struct

+ Body json.RawMessage

+ Headers ObservedHeaders

+ Method string

+ URL string

+ type ObservedResponse struct

+ Body json.RawMessage

+ Headers ObservedHeaders

+ Status int

+ type ObservedRun struct

+ Explained int

+ Extra int

+ From *time.Time

+ Instance int

+ Instances int

+ Matched int

+ NotSeen int

+ Redacted bool

+ RequestFidelity RequestFidelity

+ RunnerUp string

+ Scenario string

+ Skipped int

+ Source string

+ To *time.Time

+ Unmatchable int

+ Unobservable int

+ Weak int

+ type RequestFidelity string

+ const RequestFidelityClient

+ const RequestFidelityWire

+ type StepMatch struct

+ Body map[string]json.RawMessage

+ Headers map[string]string

+ Method string

+ Optional bool

+ Path string

+ Repeat bool

+ Status int

+ func (m StepMatch) Validate(field string) ValidationErrors

+ type TokenCarriage struct

+ In string

+ Name string

+ Param string

+ Path string

+ Typ string

type TokenDefinition

+ CarriedIn []TokenCarriage

type WalkthroughScenario

+ ObservedExtra []ObservedExtra

+ ObservedRun *ObservedRun

type WalkthroughStep

+ DefinedIn string

+ FlowID string

+ Match *StepMatch

+ Observed *ObservedMessage

+ ObservedStatus string

+ ObservedStrength string

v0.9.0

Oct 22, 2026

Changes in this version

+ const DefaultLanguage

+ const RepresentationCurl

+ const RepresentationHTTP

+ const SampleLockSuffix

+ const SampleSetFormat

+ const WalkthroughFormat

+ func ExtractRegion(content []byte, name string) (string, error)

+ func IsSampleSet(data []byte) bool

+ func SampleLockPath(docPath string) string

+ func WireBody(body json.RawMessage) ([]byte, error)

+ type Briefing struct

+ Narration Narration

+ Points []string

+ Why string

type ExampleRequest

+ func (r *ExampleRequest) Curl() (string, error)

type Flow

+ ID string

+ Narration Narration

+ Representations map[string]RepresentationNarration

type FlowExample

+ Samples []Sample

+ type Group struct

+ Description string

+ ID string

+ Name string

+ type Narration map[string]string

+ func (n Narration) Languages() []string

+ func (n Narration) Text(lang, source string) (text string, ok bool)

type Outline

+ Groups []Group

type OutlineScenario

+ Group string

+ VariantLabel string

+ VariantOf string

type Protocol

+ Groups []Group

+ Pronunciations map[string]map[string]string

+ func (p *Protocol) CheckSamples(lock *SampleLock, read SourceReader) []string

+ func (p *Protocol) GroupByID(id string) *Group

+ func (p *Protocol) OrderedScenarios() []int

+ func (p *Protocol) ResolveSamples(read SourceReader) (*SampleLock, error)

+ func (p *Protocol) SampleSources() []SampleSource

+ func (p *Protocol) SourceLanguage() string

+ func (p *Protocol) StepNarration(f Flow, rep, lang string) (text string, ok bool)

+ func (p *Protocol) WithSampleSet(set *SampleSet) (*Protocol, error)

+ func (p *Protocol) WithSamples(lock *SampleLock) *Protocol

type ProtocolMeta

+ Language string

+ type RepresentationNarration struct

+ Narration Narration

type ResolveOptions

+ FS fs.FS

+ type Sample struct

+ Code string

+ Label string

+ Language string

+ Role string

+ Source *SampleSource

+ type SampleLock struct

+ Samples []SampleLockEntry

+ Version int

+ func ParseSampleLock(data []byte) (*SampleLock, error)

+ func ReadSampleLock(path string) (*SampleLock, error)

+ func (l *SampleLock) Lookup(src SampleSource) *SampleLockEntry

+ func (l *SampleLock) WriteFile(path string) error

+ type SampleLockEntry struct

+ Code string

+ SHA256 string

+ type SampleSet struct

+ Format string

+ Name string

+ Protocol string

+ Samples []SampleSetEntry

+ func ParseSampleSet(data []byte) (*SampleSet, error)

+ func ReadSampleSet(path string) (*SampleSet, error)

+ func (s *SampleSet) Check(read SourceReader) []string

+ func (s *SampleSet) Resolve(read SourceReader) error

+ func (s *SampleSet) Validate() ValidationErrors

+ func (s *SampleSet) WriteFile(path string) error

+ type SampleSetEntry struct

+ SHA256 string

+ Step string

+ type SampleSource struct

+ Path string

+ Ref string

+ Region string

+ Repo string

+ func (s SampleSource) Key() string

type Scenario

+ Briefing *Briefing

+ Group string

+ Narration Narration

+ Samples []Sample

+ VariantLabel string

+ VariantOf string

type ScenarioSummary

+ Group string

+ VariantLabel string

+ VariantOf string

+ type SourceReader func(repo, ref, path string) ([]byte, error)

+ func CheckoutSourceReader(dir string) SourceReader

+ func LocalSourceReader(root string) SourceReader

type Walkthrough

+ Format string

+ Groups []Group

+ Language string

+ Pronunciations map[string]map[string]string

type WalkthroughScenario

+ Briefing *Briefing

+ Group string

+ Narration Narration

+ Samples []Sample

+ VariantLabel string

+ VariantOf string

type WalkthroughStep

+ Curl string

+ ID string

+ Narration Narration

+ Representations map[string]RepresentationNarration

v0.8.0

Oct 20, 2026

Changes in this version

+ func IsValidExampleKind(k ExampleKind) bool

+ type ExampleHeader struct

+ Name string

+ Value string

+ type ExampleKind string

+ const ExampleKindDerived

+ const ExampleKindDraft

+ type ExampleRequest struct

+ Body json.RawMessage

+ Headers []ExampleHeader

+ Method string

+ URL string

+ type ExampleResponse struct

+ Body json.RawMessage

+ Headers []ExampleHeader

+ Status int

+ type ExampleToken struct

+ Header json.RawMessage

+ Label string

+ Payload json.RawMessage

+ Token string

+ type Finding struct

+ Description string

+ ID string

+ Location string

+ Severity string

+ Title string

type Flow

+ Example *FlowExample

+ type FlowExample struct

+ Kind ExampleKind

+ Note string

+ Request *ExampleRequest

+ Response *ExampleResponse

+ Source string

+ Tokens []ExampleToken

type Protocol

+ func (p *Protocol) Walkthrough(findings []Finding) Walkthrough

+ type Walkthrough struct

+ Description string

+ Findings []Finding

+ ID string

+ Name string

+ Roles []OutlineRole

+ Scenarios []WalkthroughScenario

+ Tokens []WalkthroughToken

+ type WalkthroughScenario struct

+ Description string

+ Fragment bool

+ ID string

+ Name string

+ Participants []string

+ Position int

+ Steps []WalkthroughStep

+ type WalkthroughStep struct

+ Description string

+ Example *FlowExample

+ Findings []Finding

+ Fragments []string

+ From string

+ Issues []string

+ Label string

+ Location string

+ Note string

+ Number int

+ Phase string

+ Response bool

+ SignedBy string

+ To string

+ Verifies []string

+ type WalkthroughToken struct

+ Audience string

+ Claims []TokenClaim

+ ID string

+ Issuer string

+ Name string

+ Type string

+ VerifiedBy []string

v0.7.0

Oct 19, 2026

Changes in this version

type DiffCategory

+ const DiffCategoryOrder

+ const DiffCategoryScenario

type Flow

+ Include string

+ func (f *Flow) IsInclude() bool

type FlowSecurity

+ Issues []string

+ SignedBy string

+ Verifies []string

+ type Outline struct

+ Description string

+ ID string

+ Name string

+ Roles []OutlineRole

+ Scenarios []OutlineScenario

+ Tokens []OutlineToken

+ type OutlineRole struct

+ Description string

+ ID string

+ Name string

+ Position int

+ Type string

+ type OutlineScenario struct

+ Description string

+ Fragment bool

+ ID string

+ Name string

+ Participants []string

+ Position int

+ Steps []OutlineStep

+ type OutlineStep struct

+ From string

+ Include string

+ IncludePosition int

+ Label string

+ Number int

+ Phase string

+ Response bool

+ To string

+ type OutlineToken struct

+ Audience string

+ ID string

+ Issuer string

+ Name string

+ VerifiedBy []string

+ type ProjectOptions struct

+ Expand bool

type Protocol

+ Fragments []Scenario

+ Scenarios []Scenario

+ func (p *Protocol) DirectParticipants(id string) []string

+ func (p *Protocol) EntityIndex(id string) int

+ func (p *Protocol) Flatten() *Protocol

+ func (p *Protocol) HasScenarios() bool

+ func (p *Protocol) IncludeSpan(f Flow) (string, []string)

+ func (p *Protocol) OrderEntities(ids []string) []string

+ func (p *Protocol) Outline() Outline

+ func (p *Protocol) Scenario(id string, opts ProjectOptions) (*Protocol, error)

+ func (p *Protocol) ScenarioByID(id string) *Scenario

+ func (p *Protocol) ScenarioIDs(includeFragments bool) []string

+ func (p *Protocol) ScenarioParticipants(id string) []string

+ func (p *Protocol) ScenarioSummaries() []ScenarioSummary

+ func (p *Protocol) TokenUsage(id string) (issuedIn, verifiedIn []string)

type ProtocolExtends

+ ExcludeScenarios []string

type ProtocolImport

+ Scenarios []string

+ type Scenario struct

+ Description string

+ Flows []Flow

+ Fragment bool

+ ID string

+ Name string

+ Participants []string

+ type ScenarioSummary struct

+ Fragment bool

+ ID string

+ Includes []string

+ Name string

+ Participants []string

+ Position int

+ Steps int

+ type TokenClaim struct

+ CheckedBy []string

+ Description string

+ Name string

type TokenDefinition

+ Claims []TokenClaim

+ VerifiedBy []string

v0.6.0

Sep 13, 2026

Changes in this version

type Flow

+ Verification *FlowVerification

+ func (f Flow) HasVerification() bool

+ type FlowVerification struct

+ Citation string

+ Source string

+ Tier VerificationTier

+ type VerificationTier string

+ const VerificationTierCorroborated

+ const VerificationTierPartiallyReproduced

+ const VerificationTierReported

+ const VerificationTierReproduced

v0.5.0

Jul 12, 2026

Changes in this version

+ const CredentialAttestationCert

+ const CredentialBearerToken

+ const CredentialSAMLAssertion

+ const CredentialSessionCookie

+ const CredentialX509Certificate

+ const ProtocolFIDO2

+ const ProtocolOIDC

+ const ProtocolSAML

+ const ProtocolWebAuthn

+ var LLMCostPresets = map[string]struct{ ... }

+ var StepTypeLatencyDefaults = map[StepType]struct{ ... }

+ func CalculateExecutionCost(entity *Entity, metrics ExecutionMetrics) float64

+ func CanExecuteInParallel(p *Protocol, entityA, entityB string) bool

+ func EstimateLatencyPercentile(analysis *ProcessLatencyAnalysis, percentile int) time.Duration

+ func FormatLatencyReport(analysis *ProcessLatencyAnalysis) string

+ func GetCostEfficiency(analysis *ProcessCostAnalysis) map[string]float64

+ func GetLatencyBreakdown(analysis *ProcessLatencyAnalysis) map[string]time.Duration

+ func GetMaxParallelism(p *Protocol) int

+ func IsValidSchemaURI(uri string) bool

+ type CostEstimate struct

+ Breakdown map[string]float64

+ CostUnit string

+ EntityID string

+ ExpectedCost float64

+ MaxCost float64

+ MinCost float64

+ type CostModel struct

+ APICallCost float64

+ ComputeCostPerSecond float64

+ CostUnit string

+ EstimatedInputTokens int

+ EstimatedOutputTokens int

+ FixedCost float64

+ InputTokenCost float64

+ OutputTokenCost float64

+ Type CostModelType

+ VariableCost float64

+ type CostModelType string

+ const CostModelTypeAPICall

+ const CostModelTypeFixed

+ const CostModelTypeHybrid

+ const CostModelTypeTimeBased

+ const CostModelTypeTokenBased

+ type DataLineage struct

+ Edges []LineageEdge

+ ProtocolID string

+ SensitiveDataPaths [][]PortReference

+ Sinks []PortReference

+ Sources []PortReference

+ func AnalyzeDataLineage(p *Protocol) *DataLineage

+ func (l *DataLineage) GetDataProvenance(entityID string) []string

+ func (l *DataLineage) GetDownstream(entityID, portName string) []PortReference

+ func (l *DataLineage) GetImpactedEntities(entityID string) []string

+ func (l *DataLineage) GetUpstream(entityID, portName string) []PortReference

+ func (l *DataLineage) HasSensitiveDataFlow() bool

+ type DataPort struct

+ Description string

+ Kind DataPortKind

+ Name string

+ Required bool

+ Schema string

+ Sensitive bool

+ type DataPortKind string

+ const DataPortKindAPI

+ const DataPortKindDatabase

+ const DataPortKindFile

+ const DataPortKindObject

+ const DataPortKindQueue

+ const DataPortKindStream

+ type DataPortMapping struct

+ InputPort string

+ OutputPort string

+ Transformation string

+ type DependencyAnalysis struct

+ CriticalPath bool

+ DirectDependencies []string

+ DirectDependents []string

+ EntityID string

+ Name string

+ ProducedOutputs []string

+ RequiredInputs []string

+ StepType StepType

+ TransitiveDependencies []string

+ TransitiveDependents []string

+ type Determinism string

+ const DeterminismDeterministic

+ const DeterminismNonDeterministic

type Entity

+ FailureModes []FailureMode

+ Inputs []DataPort

+ Outputs []DataPort

+ Parallel *ParallelConfig

+ Processing *ProcessingConfig

+ RetryStrategy *RetryStrategy

+ StepType StepType

+ func (e Entity) FailureModeByID(id string) *FailureMode

+ func (e Entity) HasInputs() bool

+ func (e Entity) HasOutputs() bool

+ func (e Entity) InputByName(name string) *DataPort

+ func (e Entity) IsDeterministic() bool

+ func (e Entity) IsExternalStep() bool

+ func (e Entity) IsHumanStep() bool

+ func (e Entity) IsLLMStep() bool

+ func (e Entity) IsNonDeterministic() bool

+ func (e Entity) IsProcessStep() bool

+ func (e Entity) IsToolStep() bool

+ func (e Entity) OutputByName(name string) *DataPort

+ func (e Entity) RequiredInputs() []DataPort

+ func (e Entity) SensitiveInputs() []DataPort

+ func (e Entity) SensitiveOutputs() []DataPort

+ type ExecutionGraph struct

+ CriticalPath []string

+ EstimatedDuration time.Duration

+ ProtocolID string

+ Stages []ExecutionStage

+ func AnalyzeExecutionGraph(p *Protocol) *ExecutionGraph

+ type ExecutionMetrics struct

+ APICallCount int

+ Duration time.Duration

+ InputTokens int

+ OutputTokens int

+ type ExecutionReadiness struct

+ BlockedReasons map[string][]string

+ BlockedSteps int

+ CompletedSteps int

+ FailedSteps int

+ InProgressSteps int

+ NextSteps []string

+ ReadySteps int

+ TotalSteps int

+ type ExecutionStage struct

+ Dependencies []string

+ ID string

+ IsParallelBlock bool

+ ParallelConfig *ParallelConfig

+ Steps []string

+ type FailureMode struct

+ Description string

+ ID string

+ Name string

+ Recovery string

+ Severity string

type Flow

+ DataMappings []DataPortMapping

+ type JoinCondition string

+ const JoinConditionAll

+ const JoinConditionAny

+ const JoinConditionMajority

+ const JoinConditionQuorum

+ type LatencyBudget struct

+ Critical bool

+ ExpectedLatency string

+ Max string

+ P50 string

+ P95 string

+ P99 string

+ VarianceClass LatencyVarianceClass

+ type LatencyBudgetViolation struct

+ Budget time.Duration

+ EntityID string

+ Estimated time.Duration

+ Metric string

+ Severity string

+ type LatencyEstimate struct

+ EntityID string

+ Expected time.Duration

+ Max time.Duration

+ OnCriticalPath bool

+ P50 time.Duration

+ P95 time.Duration

+ P99 time.Duration

+ VarianceClass LatencyVarianceClass

+ type LatencyMeasurement struct

+ Duration time.Duration

+ EntityID string

+ ExceedsMax bool

+ ExceedsP50 bool

+ ExceedsP95 bool

+ ExceedsP99 bool

+ func CalculateActualLatency(entity *Entity, duration time.Duration) *LatencyMeasurement

+ type LatencyVarianceClass string

+ const LatencyVarianceHigh

+ const LatencyVarianceLow

+ const LatencyVarianceMedium

+ type LineageEdge struct

+ FlowIndex int

+ SourceEntity string

+ SourcePort string

+ TargetEntity string

+ TargetPort string

+ Transformation string

+ type ParallelBlock struct

+ Branches []ParallelBranch

+ ForkEntity string

+ ID string

+ JoinCondition JoinCondition

+ JoinEntity string

+ Mode ParallelMode

+ func DetectParallelBlocks(p *Protocol) []ParallelBlock

+ type ParallelBranch struct

+ Condition string

+ EntityID string

+ FlowRefs []int

+ ID string

+ Name string

+ Weight float64

+ type ParallelConfig struct

+ Branches []ParallelBranch

+ JoinCondition JoinCondition

+ MaxConcurrency int

+ Mode ParallelMode

+ Timeout string

+ type ParallelMode string

+ const ParallelModeForkJoin

+ const ParallelModeGather

+ const ParallelModeRace

+ const ParallelModeScatter

+ type PortReference struct

+ EntityID string

+ PortKind string

+ PortName string

+ Sensitive bool

+ type PortSchemaValidator struct

+ func NewPortSchemaValidator() *PortSchemaValidator

+ func (v *PortSchemaValidator) SetBasePath(path string)

+ func (v *PortSchemaValidator) ValidateEntityInputs(entity Entity, inputs map[string]interface{}) (*SchemaValidationResult, error)

+ func (v *PortSchemaValidator) ValidateEntityOutputs(entity Entity, outputs map[string]interface{}) (*SchemaValidationResult, error)

+ func (v *PortSchemaValidator) ValidatePortData(port DataPort, data interface{}) (*SchemaValidationResult, error)

+ type ProcessCostAnalysis struct

+ CostByType map[StepType]float64

+ CriticalPathCost float64

+ ParallelSavings float64

+ ProtocolID string

+ StepEstimates []CostEstimate

+ TotalEstimate CostEstimate

+ func AnalyzeProcessCosts(p *Protocol) *ProcessCostAnalysis

+ type ProcessExecutionContext struct

+ AvailableInputs map[string]bool

+ BlockedSteps map[string][]string

+ ExecutionOrder []string

+ ProducedOutputs map[string]bool

+ StepStatus map[string]StepExecutionStatus

+ type ProcessExecutor struct

+ DataFlowGraph map[string][]string

+ Dependencies map[string][]string

+ Dependents map[string][]string

+ func NewProcessExecutor(p *Protocol) (*ProcessExecutor, error)

+ func (pe *ProcessExecutor) AnalyzeDependencies() []DependencyAnalysis

+ func (pe *ProcessExecutor) CompleteStep(ctx *ProcessExecutionContext, entityID string) error

+ func (pe *ProcessExecutor) FailStep(ctx *ProcessExecutionContext, entityID string) error

+ func (pe *ProcessExecutor) GetBlockedSteps(ctx *ProcessExecutionContext) map[string][]string

+ func (pe *ProcessExecutor) GetExecutionReadiness(ctx *ProcessExecutionContext) ExecutionReadiness

+ func (pe *ProcessExecutor) GetReadySteps(ctx *ProcessExecutionContext) []string

+ func (pe *ProcessExecutor) MarkInputAvailable(ctx *ProcessExecutionContext, entityID, inputName string)

+ func (pe *ProcessExecutor) MarkOutputProduced(ctx *ProcessExecutionContext, entityID, outputName string)

+ func (pe *ProcessExecutor) NewProcessContext() *ProcessExecutionContext

+ func (pe *ProcessExecutor) StartStep(ctx *ProcessExecutionContext, entityID string) error

+ func (pe *ProcessExecutor) TopologicalSort() []string

+ type ProcessLatencyAnalysis struct

+ BudgetViolations []LatencyBudgetViolation

+ CriticalPath []string

+ CriticalPathLatency LatencyEstimate

+ LatencyByType map[StepType]time.Duration

+ ParallelSavings time.Duration

+ ProtocolID string

+ StepLatencies []LatencyEstimate

+ TotalLatency LatencyEstimate

+ func AnalyzeProcessLatency(p *Protocol) *ProcessLatencyAnalysis

+ type ProcessingConfig struct

+ CacheTTL string

+ Cacheable bool

+ CostModel *CostModel

+ Determinism Determinism

+ Engine string

+ Idempotent bool

+ LatencyBudget *LatencyBudget

+ ModelPolicy string

+ Timeout string

type Protocol

+ func (p *Protocol) DeterministicSteps() []Entity

+ func (p *Protocol) IsProcessSpec() bool

+ func (p *Protocol) Kind() ProtocolKind

+ func (p *Protocol) LLMSteps() []Entity

+ func (p *Protocol) ProcessSteps() []Entity

+ func (p *Protocol) ValidateProcess() ValidationErrors

+ type ProtocolKind string

+ const ProtocolKindProcess

+ const ProtocolKindProtocol

type ProtocolMeta

+ Kind ProtocolKind

+ type RetryStrategy struct

+ BackoffMultiplier float64

+ InitialDelay string

+ MaxAttempts int

+ MaxDelay string

+ RetryOn []string

+ type SchemaRegistry struct

+ func NewSchemaRegistry() *SchemaRegistry

+ func (r *SchemaRegistry) LoadSchema(uri string) (interface{}, error)

+ func (r *SchemaRegistry) RegisterSchema(uri string, schema interface{})

+ func (r *SchemaRegistry) SetBasePath(path string)

+ type SchemaValidationError struct

+ Message string

+ Path string

+ SchemaPath string

+ type SchemaValidationResult struct

+ Errors []SchemaValidationError

+ Valid bool

+ func ValidateData(data interface{}, schema interface{}) *SchemaValidationResult

+ func (r *SchemaValidationResult) Error() string

+ type StepExecutionStatus string

+ const StepStatusBlocked

+ const StepStatusCompleted

+ const StepStatusFailed

+ const StepStatusInProgress

+ const StepStatusPending

+ const StepStatusReady

+ const StepStatusSkipped

+ type StepType string

+ const StepTypeConditional

+ const StepTypeDeterministic

+ const StepTypeExternal

+ const StepTypeHuman

+ const StepTypeLLM

+ const StepTypeParallel

+ const StepTypeTool

v0.4.0

Jun 29, 2026

Changes in this version

+ const ComponentTypeAccessServer

+ const ComponentTypeAgentProvider

+ const ComponentTypeGateway

+ const ComponentTypeIGA

+ const ComponentTypeIdP

+ const ComponentTypeMCPClient

+ const ComponentTypeMCPServer

+ const ComponentTypePDP

+ const ComponentTypePersonServer

+ const ComponentTypeResourceAPI

+ const ComponentTypeSPIRE

+ const CredentialAAAgentJWT

+ const CredentialAAAuthJWT

+ const CredentialAPIKey

+ const CredentialAccessToken

+ const CredentialIDToken

+ const CredentialJWTAssertion

+ const CredentialJWTSVID

+ const CredentialMTLS

+ const CredentialX509SVID

+ const ProtocolA2A

+ const ProtocolAAuth

+ const ProtocolAuthZEN

+ const ProtocolIDJAG

+ const ProtocolMCP

+ const ProtocolOAuth

+ const ProtocolSCIM

+ const ProtocolSPIFFE

+ const TrustTypeAttests

+ const TrustTypeAuthenticates

+ const TrustTypeAuthorizes

+ const TrustTypeDelegates

+ const TrustTypeIssues

+ const TrustTypeProvisions

+ const TrustTypeTrusts

+ const TrustTypeValidates

+ func IsValidCategory(c Category) bool

+ func IsValidComponentType(t string) bool

+ func IsValidCredential(c string) bool

+ func IsValidEntityType(t EntityType) bool

+ func IsValidFlowMode(m FlowMode) bool

+ func IsValidProtocol(protocol string) bool

+ func IsValidSecurityRequirement(r SecurityRequirement) bool

+ func IsValidTrustLevel(t TrustLevel) bool

+ func IsValidTrustRelationType(t string) bool

+ type Breakpoint struct

+ Condition string

+ Enabled bool

+ FlowIndex int

+ HitCount int

+ type DebugSession struct

+ Breakpoints map[int]*Breakpoint

+ Context *ExecutionContext

+ Executor *Executor

+ Watchpoints map[string]string

+ func NewDebugSession(p *Protocol) *DebugSession

+ func (d *DebugSession) Continue() (*ExecutionStep, error)

+ func (d *DebugSession) EnableBreakpoint(flowIndex int, enabled bool) error

+ func (d *DebugSession) FormatFlowList() string

+ func (d *DebugSession) Inspect() *DebugState

+ func (d *DebugSession) InspectEntity(id string) (*Entity, string, error)

+ func (d *DebugSession) InspectFlow(index int) (*Flow, error)

+ func (d *DebugSession) ListBreakpoints() []*Breakpoint

+ func (d *DebugSession) ListFlows() []FlowListItem

+ func (d *DebugSession) Protocol() *Protocol

+ func (d *DebugSession) RemoveBreakpoint(flowIndex int) error

+ func (d *DebugSession) Reset()

+ func (d *DebugSession) SetBreakpoint(flowIndex int, condition string) error

+ func (d *DebugSession) SetEntityState(entityID, stateID string) error

+ func (d *DebugSession) Step() (*ExecutionStep, error)

+ func (d *DebugSession) Trace() *ExecutionTrace

+ type DebugState struct

+ AtBreakpoint bool

+ CurrentFlow *Flow

+ EntityStates map[string]string

+ Error error

+ FlowIndex int

+ IsCompleted bool

+ StepsExecuted int

+ func (d *DebugState) String() string

+ type DeploymentComponent struct

+ Description string

+ Entities []string

+ Examples []string

+ ID string

+ Implements []ProtocolRole

+ Name string

+ Type string

+ type DiffCategory string

+ const DiffCategoryEntity

+ const DiffCategoryFlow

+ const DiffCategoryMetadata

+ const DiffCategoryPhase

+ type DiffItem struct

+ Category DiffCategory

+ NewValue interface{}

+ OldValue interface{}

+ Path string

+ Summary string

+ Type DiffType

+ type DiffOptions struct

+ DeepFlowCompare bool

+ IgnoreDescriptions bool

+ IgnoreMetadata bool

+ func DefaultDiffOptions() DiffOptions

+ type DiffSummary struct

+ Added int

+ ByCategory map[DiffCategory]int

+ Modified int

+ Removed int

+ TotalChanges int

+ type DiffType string

+ const DiffTypeAdded

+ const DiffTypeModified

+ const DiffTypeRemoved

type Entity

+ ProtocolRoles []ProtocolRole

+ States []EntityState

+ TrustLevel TrustLevel

+ func (e Entity) HasProtocolRoles() bool

+ func (e Entity) HasRole(protocol, role string) bool

+ func (e Entity) HasStates() bool

+ func (e Entity) InitialState() *EntityState

+ func (e Entity) RolesByProtocol(protocol string) []ProtocolRole

+ func (e Entity) StateByID(id string) *EntityState

+ func (e Entity) StateIDs() []string

+ type EntityState struct

+ Description string

+ Final bool

+ ID string

+ Initial bool

+ Name string

+ type ExecutionContext struct

+ Completed bool

+ EntityStates map[string]string

+ Error error

+ EventQueue []ExecutionEvent

+ FlowIndex int

+ Protocol *Protocol

+ Trace *ExecutionTrace

+ func (ctx *ExecutionContext) CurrentFlow() *Flow

+ func (ctx *ExecutionContext) GetEntityState(entityID string) string

+ func (ctx *ExecutionContext) Progress() float64

+ func (ctx *ExecutionContext) SetEntityState(entityID, stateID string)

+ type ExecutionEvent struct

+ Data map[string]interface{}

+ EntityID string

+ FlowIndex int

+ Type string

+ type ExecutionStep struct

+ Action string

+ Condition string

+ ConditionMet *bool

+ FlowIndex int

+ From string

+ Label string

+ Mode FlowMode

+ Phase string

+ SkipReason string

+ Skipped bool

+ StateChanges []StateChange

+ StepNumber int

+ Timestamp time.Time

+ To string

+ type ExecutionTrace struct

+ Completed bool

+ EndTime time.Time

+ Error string

+ FinalStates map[string]string

+ InitialStates map[string]string

+ ProtocolID string

+ ProtocolName string

+ StartTime time.Time

+ Steps []ExecutionStep

+ func (t *ExecutionTrace) Duration() time.Duration

+ func (t *ExecutionTrace) SkippedCount() int

+ func (t *ExecutionTrace) StateChangeCount() int

+ func (t *ExecutionTrace) StepCount() int

+ func (t *ExecutionTrace) ToJSON() ([]byte, error)

+ type Executor struct

+ ConditionEvaluator func(ctx *ExecutionContext, flow *Flow) bool

+ Protocol *Protocol

+ func NewExecutor(p *Protocol) *Executor

+ func (e *Executor) NewContext() *ExecutionContext

+ func (e *Executor) Reset(ctx *ExecutionContext)

+ func (e *Executor) Run(ctx *ExecutionContext) (*ExecutionTrace, error)

+ func (e *Executor) RunN(ctx *ExecutionContext, n int) (*ExecutionTrace, error)

+ func (e *Executor) Step(ctx *ExecutionContext) (*ExecutionStep, error)

type Flow

+ Security *FlowSecurity

+ Sets []StateMutation

+ func (f Flow) HasSecurity() bool

+ func (f Flow) HasStateMutations() bool

+ func (f Flow) RequiresEncryption() bool

+ func (f Flow) RequiresToken() bool

type FlowAnimation

+ func (f *FlowAnimation) ShouldGlow() bool

+ type FlowListItem struct

+ Flow *Flow

+ HasBreakpoint bool

+ Index int

+ IsCurrent bool

+ IsExecuted bool

+ type FlowSecurity struct

+ Confidential bool

+ Description string

+ Requires []SecurityRequirement

+ Token string

type Protocol

+ Extends *ProtocolExtends

+ Imports []ProtocolImport

+ func (p *Protocol) AllComponentTypes() []string

+ func (p *Protocol) AllProtocols() []string

+ func (p *Protocol) AllTrustRelationTypes() []string

+ func (p *Protocol) ComponentByID(id string) *DeploymentComponent

+ func (p *Protocol) ComponentForEntity(entityID string) *DeploymentComponent

+ func (p *Protocol) ComponentsByType(componentType string) []DeploymentComponent

+ func (p *Protocol) EntitiesByProtocol(protocol string) []Entity

+ func (p *Protocol) EntitiesByRole(protocol, role string) []Entity

+ func (p *Protocol) EntitiesInComponent(componentID string) []Entity

+ func (p *Protocol) EntitiesWithProtocolRoles() []Entity

+ func (p *Protocol) EntitiesWithStates() []Entity

+ func (p *Protocol) IsResolved() bool

+ func (p *Protocol) NeedsResolution() bool

+ func (p *Protocol) Resolve(opts ResolveOptions) (*Protocol, error)

+ func (p *Protocol) StateTransitions() []StateTransition

+ func (p *Protocol) StateTransitionsForEntity(entityID string) []StateTransition

+ func (p *Protocol) TokenByID(id string) *TokenDefinition

+ func (p *Protocol) TrustRelationByID(id string) *TrustRelationship

+ func (p *Protocol) TrustRelationsByType(relType string) []TrustRelationship

+ func (p *Protocol) TrustRelationsFrom(id string) []TrustRelationship

+ func (p *Protocol) TrustRelationsTo(id string) []TrustRelationship

+ type ProtocolDiff struct

+ BaseProtocolID string

+ Items []DiffItem

+ NewProtocolID string

+ Summary DiffSummary

+ func Compare(base, new *Protocol, opts DiffOptions) *ProtocolDiff

+ func (d *ProtocolDiff) HasChanges() bool

+ func (d *ProtocolDiff) String() string

+ func (d *ProtocolDiff) ToJSON() ([]byte, error)

+ func (d *ProtocolDiff) ToMarkdown() string

+ type ProtocolExtends struct

+ ExcludeEntities []string

+ ExcludeFlows []int

+ ExcludePhases []string

+ Path string

+ type ProtocolImport struct

+ Alias string

+ Entities []string

+ IncludeFlows bool

+ Path string

+ Phases []string

type ProtocolMetadata

+ Components []DeploymentComponent

+ Tokens []TokenDefinition

+ TrustRelations []TrustRelationship

+ type ProtocolRole struct

+ Description string

+ Protocol string

+ Role string

+ Variant string

+ type ResolveOptions struct

+ BasePath string

+ MaxDepth int

+ func DefaultResolveOptions() ResolveOptions

+ type SecurityRequirement string

+ const SecurityRequirementEncryption

+ const SecurityRequirementMAC

+ const SecurityRequirementMTLS

+ const SecurityRequirementSignature

+ const SecurityRequirementToken

+ type StateChange struct

+ Entity string

+ FromState string

+ ToState string

+ type StateMutation struct

+ Entity string

+ From string

+ To string

+ type StateTransition struct

+ EntityID string

+ FlowAction string

+ FlowLabel string

+ FromState string

+ ToState string

+ type TokenDefinition struct

+ Audience string

+ Binding string

+ Description string

+ ID string

+ Issuer string

+ Name string

+ Type string

+ type TrustLevel string

+ const TrustLevelAuthoritative

+ const TrustLevelSemiTrusted

+ const TrustLevelTrusted

+ const TrustLevelUntrusted

+ type TrustRelationship struct

+ Credentials []string

+ Description string

+ From string

+ ID string

+ Mutual bool

+ To string

+ Type string

v0.3.0

May 18, 2026

Changes in this version

+ type AnimationPreset string

+ const AnimationPresetError

+ const AnimationPresetHighlight

+ const AnimationPresetNone

+ const AnimationPresetRequest

+ const AnimationPresetResponse

+ const AnimationPresetSuccess

+ const AnimationPresetWarning

type Entity

+ Metadata *EntityMetadata

+ type EntityMetadata struct

+ Network string

+ ServiceType string

type Flow

+ Animation *FlowAnimation

+ type FlowAnimation struct

+ Delay string

+ DotColor string

+ DotSize int

+ Duration string

+ Easing string

+ Enabled *bool

+ Preset AnimationPreset

+ Pulse bool

+ func (f *FlowAnimation) EffectiveDotColor(defaultColor string) string

+ func (f *FlowAnimation) EffectiveDotSize(defaultSize int) int

+ func (f *FlowAnimation) IsAnimationEnabled() bool

+ func (f *FlowAnimation) ShouldPulse() bool

+ type NetworkConfig struct

+ Color string

+ Description string

+ Entities []string

+ Name string

+ Style string

+ type NetworkLayoutConfig struct

+ Direction string

+ Order []string

type Protocol

+ Metadata *ProtocolMetadata

+ type ProtocolMetadata struct

+ NetworkLayout *NetworkLayoutConfig

+ Networks map[string]*NetworkConfig

v0.2.0

Apr 19, 2026

Changes in this version

+ func IsValidAnnotationType(t AnnotationType) bool

+ type Alternative struct

+ Condition string

+ Description string

+ Flows []Flow

+ type Annotation struct

+ Details string

+ Text string

+ Type AnnotationType

+ type AnnotationType string

+ const AnnotationTypeDeprecated

+ const AnnotationTypeError

+ const AnnotationTypeInfo

+ const AnnotationTypePerformance

+ const AnnotationTypeSecurity

+ const AnnotationTypeWarning

type Flow

+ Alternatives []Alternative

+ Annotations []Annotation

+ Condition string

+ Note string

+ func (f Flow) HasAlternatives() bool

+ func (f Flow) HasAnnotations() bool

+ func (f Flow) HasCondition() bool

+ func (f Flow) HasNote() bool

type Phase

+ Parent string

type Protocol

+ func (p *Protocol) ChildPhases(parentID string) []Phase

+ func (p *Protocol) PhaseDepth(phaseID string) int

+ func (p *Protocol) RootPhases() []Phase

v0.1.0

Apr 19, 2026

Changes in this version

+ func SanitizeID(s string) string

+ func TitleCase(s string) string

+ func ValidateFile(filename string) (*Protocol, ValidationErrors, error)

+ func WriteProtocolFile(filename string, p *Protocol) error

+ type Category string

+ const CategoryAgent

+ const CategoryAuth

+ const CategoryMessaging

+ const CategoryOther

+ const CategoryProvisioning

+ type Entity struct

+ Description string

+ ID string

+ Name string

+ Type EntityType

+ type EntityType string

+ const EntityTypeAgent

+ const EntityTypeAuthorizationServer

+ const EntityTypeBrowser

+ const EntityTypeClient

+ const EntityTypeDelegatedAgent

+ const EntityTypeIdentityProvider

+ const EntityTypeOther

+ const EntityTypeResourceServer

+ const EntityTypeServer

+ const EntityTypeServiceProvider

+ const EntityTypeTool

+ const EntityTypeToolServer

+ const EntityTypeUser

+ type FileValidationResult struct

+ Errors ValidationErrors

+ Filename string

+ ParseErr error

+ Protocol *Protocol

+ func ValidateFiles(filenames []string) []FileValidationResult

+ func (r FileValidationResult) IsValid() bool

+ type Flow struct

+ Action string

+ Description string

+ From string

+ Label string

+ Mode FlowMode

+ Phase string

+ Sequence int

+ To string

+ func (f Flow) DisplayLabel() string

+ func (f Flow) EffectiveMode() FlowMode

+ type FlowMode string

+ const FlowModeCallback

+ const FlowModeEvent

+ const FlowModeInteractive

+ const FlowModeRedirect

+ const FlowModeRequest

+ const FlowModeResponse

+ const FlowModeToolCall

+ const FlowModeToolResult

+ type Phase struct

+ Description string

+ ID string

+ Name string

+ type Protocol struct

+ Entities []Entity

+ Flows []Flow

+ Phases []Phase

+ ProtocolMeta ProtocolMeta

+ func MustParse(data []byte) *Protocol

+ func MustParseFile(filename string) *Protocol

+ func NewMinimalProtocol(id, name string) *Protocol

+ func NewProtocol(id, name string) *Protocol

+ func Parse(data []byte) (*Protocol, error)

+ func ParseFile(filename string) (*Protocol, error)

+ func ParseReader(r io.Reader) (*Protocol, error)

+ func (p *Protocol) EntityByID(id string) *Entity

+ func (p *Protocol) EntityIDs() []string

+ func (p *Protocol) FlowsByPhase(phaseID string) []Flow

+ func (p *Protocol) IsValid() bool

+ func (p *Protocol) PhaseByID(id string) *Phase

+ func (p *Protocol) PhaseIDs() []string

+ func (p *Protocol) ToJSON() ([]byte, error)

+ func (p *Protocol) ToJSONCompact() ([]byte, error)

+ func (p *Protocol) Validate() ValidationErrors

+ func (p *Protocol) WriteFile(filename string) error

+ type ProtocolMeta struct

+ Category Category

+ Description string

+ ID string

+ Name string

+ References []Reference

+ Version string

+ type Reference struct

+ Name string

+ URL string

+ type ValidationError struct

+ Field string

+ Message string

+ func (e ValidationError) Error() string

+ type ValidationErrors []ValidationError

+ func (e ValidationErrors) Error() string

+ func (e ValidationErrors) HasErrors() bool

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