gateway

func InstallSuccessorForTest ¶ added in v1.29.0

func InstallSuccessorForTest(t interface {
	Helper()
	Fatalf(string, ...any)
}, refused, command, why string,
) func()

InstallSuccessorForTest adds a curated entry for the duration of a test and returns the undo. It exists because successors is unexported and legitimately empty — the one live entry it held was retired when spec-derived resource identity folded the withdrawn v2 computer-groups command into its v3 sibling — while the code that renders an entry lives in three other places (the runtime refusal, the --help caveat and the `commands -o json` catalog), two of them in internal/commands. Without this, those two would have to skip, and a skip is what let the last guard gap in this area ship: the projection that copies the successor into the catalog was dead for a release with every test green.

The first parameter is *testing.T, taken as the narrowest interface that satisfies it rather than by importing testing into a production package. That is also what keeps this out of production use: nothing outside a test has a value to pass.

func Note ¶

func Note(level Level, basis Basis, detail string) string

Note renders the hint appended to a gateway 403 or 404, or "" when there is nothing to add.

Most such requests never reach the wire: checkAPIMatch refuses the command pre-flight. This is for the cases that do — a hand-written command fanning out over many endpoints carries one annotation for the whole batch, so only the request itself knows which endpoint was refused.

func NoteForRequest ¶

func NoteForRequest(method, path string) string

NoteForRequest is Note over the table, for a concrete gateway-form request.

func Refusal ¶

func Refusal(cmdPath string, basis Basis, detail string) string

Refusal renders the pre-flight refusal. cmdPath is the invoked command, e.g. "pro app-installer-titles list".

A probed entry states the fact. An unpublished one says the endpoint is outside the supported surface and that answering today is transitional — refusing it now is the point, because letting it through means a workflow gets built on a route that is going away and the failure arrives later as an unexplained breakage.

func Scopes ¶

func Scopes(method, path string) []string

Scopes returns the Jamf Account capability permissions the gateway requires for a gateway-form request — the path as it will be sent, e.g. "/pro/v1/categories" or "/proclassic/computers/id/3". Returns nil when the table has nothing for it, which includes a tree with no manifest, an unserved operation (the published specs declare no scope for what they do not publish) and the 44 Jamf Pro endpoints that are unauthenticated and therefore declare none.

These are the GA capability permissions granted in Jamf Account (categories:read), never Jamf Pro API-role privilege names — so this is the right answer only for a request actually going through the gateway. Callers discriminate on the /pro/ and /proclassic/ prefixes, which exist only in gateway mode.

func Successor ¶

func Successor(cmdPath string) (command, why string, ok bool)

Successor returns the replacement for a refused command path — the full path as cobra reports it, binary name included, e.g. "jamf-cli pro static-computer-groups list". ok is false when nothing is curated for it, which is the normal answer.

Matched by longest command-path prefix, so one entry covers every subcommand of a refused resource.

func SuccessorNote ¶

func SuccessorNote(cmdPath string) string

SuccessorNote renders the successor sentence for a command path, or "" when nothing is curated. Shared by the refusal and by the --help caveat so the two cannot drift.

func SuccessorTable ¶

func SuccessorTable() map[string]string

SuccessorTable returns the curated entries as refused path -> replacement path, both without the binary name, for the staleness test.

func UnpublishedOverrideWarning ¶

func UnpublishedOverrideWarning(cmdPath, detail string) string

UnpublishedOverrideWarning renders the warning printed in place of the refusal when JAMF_CLI_ALLOW_UNPUBLISHED is set. It is deliberately loud and deliberately not silenceable: the whole point of the escape hatch is that the operator is told, on every affected invocation, that they are running against a route nobody has committed to keeping.