constants

package
v0.4.17 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 12, 2026 License: MIT Imports: 0 Imported by: 12

Documentation

Overview

Package constants defines ConfigHub values shared across the server, bridge workers, functions, and config kits: the metadata keys below, and API constants such as ServerVersionHeader. It imports nothing, so the server can use it without depending on the API client.

Index

Constants

View Source
const (
	// Identifying Metadata
	SpaceIDKeySuffix                = "SpaceID"
	UnitSlugKeySuffix               = "UnitSlug"
	RevisionNumKeySuffix            = "RevisionNum"
	ResourceNameStableCoreKeySuffix = "ResourceNameStableCore"

	// Other Metadata
	ConfigMapFormatKeySuffix = "ConfigMapFormat"
	HashKeySuffix            = "Hash"

	// Options
	MutationOptionsKeySuffix = "MutationOptions"
	RenderRevisionKeySuffix  = "RenderRevision"
	VisitorOptionsKeySuffix  = "VisitorOptions"
)

Key suffixes for ConfigHub context metadata to inject into managed resources in bridges. Paths and Prefixes will depend on the ResourceProvider.

View Source
const (
	VisitorOptionIgnoreNeeded   = "IgnoreNeeded"
	VisitorOptionIgnoreProvided = "IgnoreProvided"
)
View Source
const (
	ConfigMapFormatFile     = "File"
	ConfigMapFormatKeyValue = "KeyValue"
)

ConfigMapFormat annotation values for the ConfigMap bridge.

View Source
const ServerVersionHeader = "ConfigHub-Version"

ServerVersionHeader is the response header the ConfigHub server stamps its own version onto, on every /api response. A client that reads it learns the server version from a call it was already making, rather than spending a round trip on /api/info. The value is what /api/info reports in Version: a release version such as "v0.2.34", or "v0.2-dev" for a build from a working tree.

It lives here, and not in cubapi, so that the server can stamp the header without importing the API client. The server does not call its own API, and that import would pull the generated client into the server binary and into the OpenAPI spec generator, which links internal/views -> cubapi -> goclient-new: a broken client then blocks regenerating that same client.

Variables

This section is empty.

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

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