Files
zeekayandHanzo Dev 472238ddb0 cd: the API is /v1, not /api/v1 — no /api prefix anywhere
House rule: /v1/ is the API prefix, everywhere, and /api/ is never added on
top of it. The api.* subdomain names the API; a path prefix restating it is
noise. This applies it to the whole route surface:

  /api/v1/*      -> /v1/*        106 proto annotations, 109 gateway patterns
  /api/version   -> /v1/version
  /api/badge     -> /v1/badge
  /api/webhook   -> /v1/webhook  (server + applicationset controller)
  /api/dex/*     -> /v1/dex/*    (constants; dex is built, not deployed)

The grpc-gateway .pb.gw.go files are generated, and the plugin toolchain is
not on this machine, so they were rewritten by a script that applies exactly
the transform codegen would: for /api/v1 paths, drop the leading "api"
literal-push opcode pair and decrement every LitPush(2,N)/Capture(5,N) pool
index; for /api/version, rename the segment. ConcatN(4,N) operands are
counts, not pool indexes, and are untouched. The .proto annotations moved in
the same commit, so the next real codegen run is a no-op against these files.

MustPattern panics at package init on a malformed pattern, so every rewritten
pattern is validated by any import of pkg/apiclient — those tests pass.

Also moved: assets/swagger.json (82 paths), the UI's two roots (apiRoot()
'/v1', version-service '/v1/version') and its two relative composers (app
logs download, badge panel), the five audit-pattern regexes in server.go, and
the tests that asserted the old paths. terminal_test's request URL claimed
/api/v1/terminal, a route that never existed — the handler is mounted at
/terminal; the fixture now says so.

NOT touched, deliberately: /api/v3 in GitHub Enterprise base-url examples
(GitHub's URL shape, not ours), util/vendored/kubeclientmetrics (parses the
KUBERNETES API server's /api/v1 paths), and util/http's cookie-path fixture
(arbitrary string exercising slash normalization).

go build ./... clean. Pre-existing failures in badge/session/webhook/account
tests reproduce identically on the parent commit (rebrand fallout — badge
colors, cookie name length, dex issuer) and are not made worse here.

External consumers checked: universe has zero references to cd.hanzo.ai/api;
the CLI speaks gRPC, not the REST gateway; UI and server ship in one image so
they move together.

Co-authored-by: Hanzo Dev <[email protected]>
2026-07-29 12:01:34 -07:00

110 lines
3.3 KiB
Protocol Buffer

syntax = "proto3";
option go_package = "github.com/hanzoai/cd/pkg/apiclient/settings";
// Settings Service
//
// Settings Service API retrieves Hanzo CD settings
package cluster;
import "gogoproto/gogo.proto";
import "google/api/annotations.proto";
import "github.com/hanzoai/cd/pkg/apis/application/v1alpha1/generated.proto";
import "github.com/hanzoai/cd/server/settings/oidc/claims.proto";
// SettingsQuery is a query for Hanzo CD settings
message SettingsQuery {
}
message Settings {
string url = 1 [(gogoproto.customname) = "URL"];
DexConfig dexConfig = 2;
OIDCConfig oidcConfig = 3 [(gogoproto.customname) = "OIDCConfig"];
string appLabelKey = 4;
map<string, github.com.argoproj.argo_cd.v3.pkg.apis.application.v1alpha1.ResourceOverride> resourceOverrides = 5;
bool statusBadgeEnabled = 6;
GoogleAnalyticsConfig googleAnalytics = 7;
github.com.argoproj.argo_cd.v3.pkg.apis.application.v1alpha1.KustomizeOptions kustomizeOptions = 8;
// Help settings
Help help = 9;
repeated Plugin plugins = 10;
bool userLoginsDisabled = 11;
// Deprecated: use sidecar plugins instead.
repeated github.com.argoproj.argo_cd.v3.pkg.apis.application.v1alpha1.ConfigManagementPlugin configManagementPlugins = 12;
repeated string kustomizeVersions = 13;
string uiCssURL = 14;
string uiBannerContent = 15;
string uiBannerURL = 16;
string passwordPattern = 17;
string trackingMethod = 18;
bool uiBannerPermanent = 19;
string uiBannerPosition = 20;
string statusBadgeRootUrl = 21;
bool execEnabled = 22;
string controllerNamespace = 23;
bool appsInAnyNamespaceEnabled = 24;
bool impersonationEnabled = 25;
string installationID = 26;
repeated string additionalUrls = 27 [(gogoproto.customname) = "AdditionalURLs"];
bool hydratorEnabled = 28;
bool syncWithReplaceAllowed = 29;
string uiLoginButtonText = 30;
}
message GoogleAnalyticsConfig {
string trackingID = 1;
bool anonymizeUsers = 2;
}
message SettingsPluginsResponse {
repeated Plugin plugins = 1;
}
// Help settings
message Help {
// the URL for getting chat help, this will typically be your Slack channel for support
string chatUrl = 1;
// the text for getting chat help, defaults to "Chat now!"
string chatText = 2;
// the URLs for downloading argocd binaries
map<string, string> binaryUrls = 3;
}
// Plugin settings
message Plugin {
// the name of the plugin, e.g. "kasane"
string name = 1;
}
message DexConfig {
repeated Connector connectors = 1;
}
message Connector {
string name = 1;
string type = 2;
}
message OIDCConfig {
string name = 1;
string issuer = 2;
string clientID = 3 [(gogoproto.customname) = "ClientID"];
string cliClientID = 4 [(gogoproto.customname) = "CLIClientID"];
repeated string scopes = 5;
map<string, github.com.argoproj.argo_cd.server.settings.oidc.Claim> idTokenClaims = 6 [(gogoproto.customname) = "IDTokenClaims"];
bool enablePKCEAuthentication = 7;
}
// SettingsService
service SettingsService {
// Get returns Hanzo CD settings
rpc Get(SettingsQuery) returns (Settings) {
option (google.api.http).get = "/v1/settings";
}
// Get returns Hanzo CD plugins
rpc GetPlugins(SettingsQuery) returns (SettingsPluginsResponse) {
option (google.api.http).get = "/v1/settings/plugins";
}
}