doccomments_gen.go

// Code generated by github.com/smartcontractkit/capabilities/libs/capability/internal/docgen, DO NOT EDIT.

package capability

import "github.com/smartcontractkit/chainlink-common/x/config/commentparsing"

func (AppConfig) DocComments() map[string]commentparsing.FieldDoc {
	return map[string]commentparsing.FieldDoc{
		"AppID": {Comment: "AppID is the ID of the node process that started this process. The node makes a new random ID\neach time it starts. Traces use it as service.instance.id. If the node does not set it, this\nprocess makes its own random ID."},
	}
}

func (CapabilitiesConfig) DocComments() map[string]commentparsing.FieldDoc {
	return map[string]commentparsing.FieldDoc{
		"CapabilityDonID": {Comment: "CapabilityDonID is the on-chain DON ID of the capability DON this process was spawned for."},
		"HTTPDebug":       {Comment: "HTTPDebug serves the capability debug UI on the shared HTTP server, under /debug/capabilities."},
		"ProxyURL":        {Comment: "ProxyURL is the gRPC target of the node's capability registry proxy (e.g. localhost:9000), used\nto resolve capabilities this binary does not host. Unset resolves only the capabilities this\nbinary hosts."},
	}
}

func (HTTPConfig) DocComments() map[string]commentparsing.FieldDoc {
	return map[string]commentparsing.FieldDoc{
		"Port": {Comment: "Port serves /metrics, /debug/pprof, /livez, /startupz, /readyz, /healthz and any routes a\nservice registers."},
	}
}

func (PrometheusConfig) DocComments() map[string]commentparsing.FieldDoc {
	return map[string]commentparsing.FieldDoc{
		"PrometheusPort": {Comment: "PrometheusPort is the port of the web server. The core node sets it, and gets the metrics\nfrom it."},
	}
}

func (SettingsConfig) DocComments() map[string]commentparsing.FieldDoc {
	return map[string]commentparsing.FieldDoc{
		"URL": {Comment: "URL is the gRPC target of the host's CRE settings service (e.g. localhost:9001), which pushes\nsettings updates to this process. Unset leaves every limit at its compiled-in default."},
	}
}