api

type APIEngine struct {
	// contains filtered or unexported fields
}

type AuthChecker func(username, command string) bool

type CallerIdentity struct {
	Username   string
	RemoteAddr string
	Surface    string
	// ReadOnly means the transport admitted the caller with read-only access only.
	ReadOnly bool
}

type CommandMeta struct {
	Name        string      // Dispatch path, e.g. "show bgp rib status"
	Description string      // From YANG or registration
	ReadOnly    bool        // True if read-only command
	Params      []ParamMeta // Input parameters from YANG RPC (nil = no typed params)
}

type CommandSource func() []CommandMeta

type ConfigCommitHook func() error

type ConfigCommitRequest struct {
	Username  string
	SessionID string
}

type ConfigDeleteRequest struct {
	Username  string
	SessionID string
	Path      string
}

type ConfigDiffRequest struct {
	Username  string
	SessionID string
}

type ConfigDiscardRequest struct {
	Username  string
	SessionID string
}

type ConfigEditor interface {
	SetValue(path []string, key, value string) error
	DeleteByPath(fullPath []string) error
	Diff() string
	Save() error
	StageCandidate(stamp time.Time) (content string, version string, err error)
	MarkCommittedContent(content string)
	RestoreOriginalContent(content string) error
	Discard() error
	OriginalContent() string
	WorkingContent() string
}

type ConfigEditorFactory func() (ConfigEditor, error)

type ConfigSession struct {
	ID           string
	Editor       ConfigEditor
	Username     string
	CreatedAt    time.Time
	LastActivity time.Time
	// contains filtered or unexported fields
}

type ConfigSessionManager struct {
	// contains filtered or unexported fields
}

type ConfigSetRequest struct {
	Username  string
	SessionID string
	Path      string
	Value     string
}

type ConfigValidationHook func(previous, candidate string) error

type DescribeCommandRequest struct {
	Caller CallerIdentity
	Path   string
}

type ExecResult struct {
	Status string `json:"status"`          // "done", "error", or "partial"
	Data   any    `json:"data,omitempty"`  // Payload
	Error  string `json:"error,omitempty"` // Error message (when status is "error")
}

type ExecuteRequest struct {
	Caller  CallerIdentity
	Command string
}

type Executor func(ctx context.Context, caller CallerIdentity, command string) (string, error)

type ListCommandsRequest struct {
	Caller CallerIdentity
	Prefix string
}

type ParamMeta struct {
	Name        string // Parameter name (kebab-case from YANG)
	Type        string // YANG type: "string", "uint32", "boolean", etc.
	Description string // From YANG description
	Required    bool   // Mandatory in YANG
}

type StreamRequest struct {
	Caller  CallerIdentity
	Command string
}

type StreamSource func(ctx context.Context, caller CallerIdentity, command string) (<-chan string, func(), error)