agenthealthref

package

v0.22.0 Latest Latest Go to latest Published: Nov 9, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Details

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

Repository

github.com/TheAgentHealth/agenthealth

Links

Open Source Insights

Documentation ¶

Overview ¶

Package agenthealthref provides a reference application contract, not an SDK.

Index ¶

func Handler(snapshot func() Document, probe func(context.Context, Task) (Outcome, error)) http.Handler
type Document
type Outcome
type Task

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Handler ¶

func Handler(snapshot func() Document, probe func(context.Context, Task) (Outcome, error)) http.Handler

Handler serves HEAD/GET and an optional explicitly authorized POST probe. Protect this resource with your application's authentication middleware. Probe must honor cancellation and perform only bounded, non-destructive work.

Types ¶

type Document ¶

type Document struct {
	Version      string   `json:"version"`
	Name         string   `json:"name"`
	Live         bool     `json:"live"`
	Ready        bool     `json:"ready"`
	Capabilities []string `json:"capabilities"`
	Dependencies []string `json:"dependencies"`
}

type Outcome ¶

type Outcome struct {
	Completed  bool   `json:"completed"`
	Success    bool   `json:"success"`
	Downstream string `json:"downstream,omitempty"`
}

type Task ¶

type Task struct {
	Safe       bool   `json:"safe"`
	Text       string `json:"text"`
	Downstream string `json:"downstream,omitempty"`
}

Source Files ¶

View all Source files

handler.go

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