zeekay
88d3bee3d7
CI/CD / containment (push) Successful in 2m24s
Hanzo CI/CD / cicd (push) Failing after 51m20s
CI/CD / gate (push) Failing after 51m20s
CI/CD / image (push) Skipped
CI/CD / rollout (push) Skipped
CI/CD / reach (push) Skipped
CI/CD / fanout (push) Skipped
CI/CD / receipt (push) Skipped
apps/integrations carried two openapi.Describe calls for GET /v1/integrations/slack/install, written by different hands into different init() funcs. Describe panics on a duplicate — correctly, because two descriptions of one operation means one of them renders and nobody can tell which — and that panic fires at init, so it took down every app that links integrations: ads, automations, campaign, catalogsync, channels, cloudflare, company, content, destinations, git, guide, integrations and sync all failed to describe. The earlier one survives. It was already the superset: it has the attribution constraint (Slack refuses a slack.com URL in that field, so the click has to route through an address of ours to be counted) AND the tenant point (public, no principal, binds no org, because minting an org for an anonymous click is the one thing that would break isolation). The later one had a single fact the first did not — 503 where the app is unconfigured, rather than a consent URL with an empty client_id that Slack renders as its own dead end — so that sentence moved across before the duplicate went. The floor drops for the merge's own deletion too: /v1/billing/gpu/charge and /v1/billing/gpu/eligibility are gone because GPU is metered like any other resource now, and the bespoke prepay path with it. Checked rather than assumed — a -1 that is not a multiple of two is not a TRACE/OPTIONS removal, and an unexplained shrink is exactly what the ratchet is there to make someone look at. 1762 paths, 2480 operations, 185 products. Every one carries an operationId and a summary; 51 still want a long description and 49 of those are hanzoai/ai, whose prose belongs on its controllers, in that repo.
1219 lines
48 KiB
JSON
1219 lines
48 KiB
JSON
{
|
|
"openapi": "3.1.0",
|
|
"info": {
|
|
"title": "Hanzo Cloud API",
|
|
"description": "Package deploy is Hanzo CD: see what each app is running, sync it, and roll back a bad release.",
|
|
"version": "v1"
|
|
},
|
|
"servers": [
|
|
{
|
|
"url": "https://api.hanzo.ai"
|
|
}
|
|
],
|
|
"tags": [
|
|
{
|
|
"name": "deploy"
|
|
}
|
|
],
|
|
"paths": {
|
|
"/v1/deploy/account/can-i/{wildcard1}": {
|
|
"get": {
|
|
"operationId": "get_v1_deploy_account_can-i_by_wildcard1",
|
|
"summary": "Compatibility answer the console UI asks before enabling its buttons",
|
|
"description": "Always answers `yes`, whatever resource, action or subresource the path names. It exists for the ArgoCD-compatible console, which asks this before enabling a control, and it is NOT the authorization decision: nothing downstream consults it, and every route that returns fleet data or mutates a CR carries its own gate. Reaching it at all already requires SuperAdmin, so a caller who can read the `yes` is one for whom it is true.",
|
|
"tags": [
|
|
"deploy"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "wildcard1",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/deploy/applications": {
|
|
"get": {
|
|
"operationId": "get_v1_deploy_applications",
|
|
"summary": "Returns the fleet as an argocd ApplicationList: one projected Application per operator App CR, carrying the image tag the CR DECLARES, the tag actually RUNNING in the cluster's Deployment, the reconciled health, and the sync verdict those two produce (declared == running ⇒ Synced, both known and different ⇒ OutOfSync, either unknown ⇒ Unknown).",
|
|
"description": "Returns the fleet as an argocd ApplicationList: one\nprojected Application per operator App CR, carrying the image tag the CR\nDECLARES, the tag actually RUNNING in the cluster's Deployment, the reconciled\nhealth, and the sync verdict those two produce (declared == running ⇒ Synced,\nboth known and different ⇒ OutOfSync, either unknown ⇒ Unknown).\n\nIt is TENANT-SCOPED: a platform SuperAdmin reads every platform namespace, a\nvalidated org member reads only its own org's tenant namespace and only the App\nCRs labelled with its org, and anyone else is refused. A cross-tenant CR is\nnever projected into an answer.",
|
|
"tags": [
|
|
"deploy"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/argoAppList"
|
|
}
|
|
}
|
|
},
|
|
"description": "ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/deploy/applications/{name}": {
|
|
"get": {
|
|
"operationId": "get_v1_deploy_applications_by_name",
|
|
"summary": "Returns ONE projected argocd Application by name, with status.resources filled in from its reconciled resource tree — which is what makes it the detail view rather than a row of the list.",
|
|
"description": "Returns ONE projected argocd Application by name, with\nstatus.resources filled in from its reconciled resource tree — which is what\nmakes it the detail view rather than a row of the list.\n\nIt is TENANT-SCOPED, and a name that belongs to another org is reported NOT\nFOUND rather than refused: a 403 would confirm the application exists, so the\nroute would become a cross-tenant existence oracle. A name that is not a\nDNS-1123 label is a 400 before any cluster read.",
|
|
"tags": [
|
|
"deploy"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Name is the application to read, from the path. It must be a DNS-1123 label\n(lowercase alphanumerics and hyphens, starting and ending alphanumeric) —\nevery operator App CR's metadata.name satisfies that, and anything else is a\n400 rather than a lookup.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/argoApp"
|
|
}
|
|
}
|
|
},
|
|
"description": "ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/deploy/applications/{name}/resource-tree": {
|
|
"get": {
|
|
"operationId": "get_v1_deploy_applications_by_name_resource-tree",
|
|
"summary": "Returns one application's argocd ApplicationTree: the objects the operator reconciled from its App CR, reached by ownerRef — the Deployment and, under it, the ReplicaSet and Pods, plus the Service, Ingress, HorizontalPodAutoscaler, PodDisruptionBudget and ConfigMaps it owns — each node carrying its parent edges and its health.",
|
|
"description": "Returns one application's argocd ApplicationTree: the\nobjects the operator reconciled from its App CR, reached by ownerRef — the\nDeployment and, under it, the ReplicaSet and Pods, plus the Service, Ingress,\nHorizontalPodAutoscaler, PodDisruptionBudget and ConfigMaps it owns — each node\ncarrying its parent edges and its health.\n\nSecrets are DELIBERATELY not walked, so no materialized environment can ever\nappear in the tree. Tenant-scoped exactly like the application read: another\norg's name is not found, a malformed name is a 400.",
|
|
"tags": [
|
|
"deploy"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Name is the application to read, from the path. It must be a DNS-1123 label\n(lowercase alphanumerics and hyphens, starting and ending alphanumeric) —\nevery operator App CR's metadata.name satisfies that, and anything else is a\n400 rather than a lookup.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/argoTree"
|
|
}
|
|
}
|
|
},
|
|
"description": "ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/deploy/applications/{name}/revisions/{revision}/metadata": {
|
|
"get": {
|
|
"operationId": "get_v1_deploy_applications_by_name_revisions_by_revision_metadata",
|
|
"summary": "Returns the argocd RevisionMetadata for one revision of one application — what the detail view shows beside a revision.",
|
|
"description": "Returns the argocd RevisionMetadata for one revision\nof one application — what the detail view shows beside a revision.\n\nAn App CR is IMAGE-pinned rather than commit-pinned: the deploy names an image\ntag, and the git source this projection reports is the display-only manifest\nrepo, not the application's own source. Nothing in this process can read a\ncommit's author or message for an arbitrary revision. So rather than 404 (which\nthe SPA turns into an error toast) or invent a git author, it answers the\nHONEST minimum: date is when the App CR was created, message is the revision\nasked for — with the empty revision and \"HEAD\" resolving to the image tag the\nCR declares — and author is empty. An over-long revision is truncated before it\nis echoed back.\n\nTenant-scoped exactly like the application read.",
|
|
"tags": [
|
|
"deploy"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Name is the application to read, from the path. It must be a DNS-1123 label.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "revision",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Revision is the revision to describe, from the path. The empty revision and\n\"HEAD\" both mean \"whatever this application currently declares\".",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/argoRevisionMetadata"
|
|
}
|
|
}
|
|
},
|
|
"description": "ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/deploy/applications/{name}/rollback": {
|
|
"post": {
|
|
"operationId": "post_v1_deploy_applications_by_name_rollback",
|
|
"summary": "The console's rollback control — today it requests a reconcile, nothing more",
|
|
"description": "Performs exactly what the sync action performs: it stamps the sync-requested timestamp onto the application's App CR and answers the application re-projected. It does NOT select, pin or revert to a prior image tag, and that is the one thing to know before wiring anything to it — the name is the console's, the behaviour is the sync. Pinning a previous release rides the release seam, which this address does not call yet.\n\nSuperAdmin-only and fail-closed, reading no request body, with an unknown application name a 404 and no cluster client a 503 — the same gate and the same failures as the sync it shares a handler with.",
|
|
"tags": [
|
|
"deploy"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/deploy/applications/{name}/sync": {
|
|
"post": {
|
|
"operationId": "post_v1_deploy_applications_by_name_sync",
|
|
"summary": "Ask the operator to reconcile one application now",
|
|
"description": "Requests an immediate reconcile of one application by stamping a sync-requested timestamp onto its App CR, which the operator's watch observes, and answers the application re-projected. It ASKS, it does not apply: the operator performs the reconcile on its own clock, so a 200 means the request landed, not that the rollout finished — the returned row's running version still lags until it does. The CR is the desired source today, so this is a nudge; when git becomes the source the same address becomes apply-from-git.\n\nSuperAdmin-only and fail-closed — a non-SuperAdmin is refused before any cluster object is read or patched, and the write surface stays admin-only while the tenant surface is read-only reflection. It reads no request body. An unknown application name is a 404; no cluster client configured is a 503.",
|
|
"tags": [
|
|
"deploy"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/deploy/applications/{name}/syncwindows": {
|
|
"get": {
|
|
"operationId": "get_v1_deploy_applications_by_name_syncwindows",
|
|
"summary": "Returns one application's argocd ApplicationSyncWindowState — the answer to \"is anything blocking a sync of this application right now?\".",
|
|
"description": "Returns one application's argocd\nApplicationSyncWindowState — the answer to \"is anything blocking a sync of this\napplication right now?\".\n\nThis platform runs NO sync windows, so the answer is always the permissive\nempty one: canSync true, with no active and no assigned windows. The\napplication is still resolved first, so a name that is not the caller's is not\nfound rather than handed the static body — the endpoint discloses nothing about\nanother tenant's fleet.",
|
|
"tags": [
|
|
"deploy"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Name is the application to read, from the path. It must be a DNS-1123 label\n(lowercase alphanumerics and hyphens, starting and ending alphanumeric) —\nevery operator App CR's metadata.name satisfies that, and anything else is a\n400 rather than a lookup.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/argoSyncWindows"
|
|
}
|
|
}
|
|
},
|
|
"description": "ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/deploy/callback": {
|
|
"get": {
|
|
"operationId": "get_v1_deploy_callback",
|
|
"summary": "Finish the sign-in round trip and mint the console session",
|
|
"description": "Completes the redirect from IAM: it validates `state` against the single-use flow cookie in constant time, redeems the authorization code with the PKCE verifier, and then VERIFIES the resulting token exactly as this deployment's identity boundary will on every later request — so a token that would be refused next request fails here with the real reason instead of producing a sign-in loop. On success it sets the session cookie, bounded by the token's own expiry, and redirects to the validated return path.\n\nIt fails closed, and closes on the ADMIN ORG: a principal whose verified owner claim is not the reserved admin org is told plainly that it lacks the role (403) and no cookie is minted for it. That check is not the authorization decision — every gated route re-derives SuperAdmin from the verified JWT — it exists so nobody is handed a session that silently 403s everything. No flow in progress, or a mismatched `state`, is a 400; a refused or unexchangeable code is a 401.",
|
|
"tags": [
|
|
"deploy"
|
|
]
|
|
}
|
|
},
|
|
"/v1/deploy/clusters": {
|
|
"get": {
|
|
"operationId": "get_v1_deploy_clusters",
|
|
"summary": "Returns the argocd ClusterList of the destinations the caller's applications reconcile into: one entry per distinct destination server, carrying the count of applications reconciling into it.",
|
|
"description": "Returns the argocd ClusterList of the destinations the\ncaller's applications reconcile into: one entry per distinct destination\nserver, carrying the count of applications reconciling into it. The in-cluster\ndestination is always present, so an empty fleet still answers one cluster, and\nno cluster credential can appear — the projected type physically has no config\nfield.\n\nIt is TENANT-SCOPED and reads the SAME App CRs the applications list reads: a\nplatform SuperAdmin counts the whole fleet, a validated org member counts only\nits own org's applications, anyone else is refused.",
|
|
"tags": [
|
|
"deploy"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/argoClusterList"
|
|
}
|
|
}
|
|
},
|
|
"description": "ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/deploy/gitops": {
|
|
"get": {
|
|
"operationId": "get_v1_deploy_gitops",
|
|
"summary": "Lists every Hanzo CD Application in the cluster: the git source each one polls, the commit it last APPLIED, how its last sync operation ended, and its recent deploy history — newest deploy first, ordered by namespace then name.",
|
|
"description": "Lists every Hanzo CD Application in the cluster: the git source\neach one polls, the commit it last APPLIED, how its last sync operation ended,\nand its recent deploy history — newest deploy first, ordered by namespace then\nname.\n\nThis is the layer ABOVE the application board, and the two disagree in exactly\nthe case an operator most needs to see: main carries a new image pin, CD has\nnot applied that commit yet, so every App CR still declares the old tag and the\napplication board is legitimately \"Synced\" while the deploy has not landed.\nOnly the applied revision here can show that.\n\ninstalled is false — with a reason and an empty list — when the CD CRD is not\nserved in this cluster. That is a FACT about the cluster rather than a failure\nof the request, so the caller can say \"no CD plane here\" instead of rendering\nan error it cannot act on; a genuine transport or RBAC failure still errors.\n\nRead-only, and platform SuperAdmin only: the CD plane is fleet infrastructure\nwith no tenant dimension. This view observes CD and never drives it — the sync\npolicy is automated with self-heal, and the actionable verb an operator has is\nthe per-application reconcile at POST /v1/deploy/applications/{name}/sync.",
|
|
"tags": [
|
|
"deploy"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/GitOpsPlane"
|
|
}
|
|
}
|
|
},
|
|
"description": "ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/deploy/health": {
|
|
"get": {
|
|
"operationId": "get_v1_deploy_health",
|
|
"summary": "Whether this control plane can actually reach the cluster it deploys to",
|
|
"description": "Reports the plane's real reachability: 200 only when the Kubernetes API server answers AND the App CRD is served, 503 with the same body shape otherwise, so a caller reads the same `k8s` and `crd` booleans either way rather than parsing an error envelope. It is a genuine dependency probe, not a process liveness ping — a running plane with no cluster behind it reports degraded.\n\nThis is the ONE unauthenticated route that reports state, because liveness must be probe-able without a JWT. It therefore discloses booleans only: the underlying failure — the API server address, an RBAC refusal — is logged server-side and never put on the wire.",
|
|
"tags": [
|
|
"deploy"
|
|
]
|
|
}
|
|
},
|
|
"/v1/deploy/login": {
|
|
"get": {
|
|
"operationId": "get_v1_deploy_login",
|
|
"summary": "Start the sign-in round trip for this console",
|
|
"description": "Redirects the browser to IAM's authorize endpoint, having minted a nonce and a PKCE verifier into a short-lived, single-use flow cookie. The nonce comes back as `state` and is what proves the code belongs to the round trip THIS browser started; the verifier never appears in the address bar.\n\nNecessarily public — this is how a browser gets a principal for this host in the first place — and it grants nothing by itself. An optional `returnTo` names where to land afterwards and is run through the open-redirect guard, so only a same-host path survives. A deployment with no sign-in configured answers 503 rather than redirecting nowhere.",
|
|
"tags": [
|
|
"deploy"
|
|
]
|
|
}
|
|
},
|
|
"/v1/deploy/logout": {
|
|
"post": {
|
|
"operationId": "post_v1_deploy_logout",
|
|
"summary": "End the console session on this host",
|
|
"description": "Clears this console's session cookie and answers the signed-out state with the sign-in URL to start again. IAM's own session is untouched — this ends the console session only, so signing back in may not prompt for credentials.\n\nIt is a POST because it changes state. As a GET it was reachable by a cross-site top-level navigation, which a SameSite=Lax cookie still rides, so any page could sign a SuperAdmin out; a POST is not carried cross-site by that cookie.",
|
|
"tags": [
|
|
"deploy"
|
|
]
|
|
}
|
|
},
|
|
"/v1/deploy/projects": {
|
|
"get": {
|
|
"operationId": "get_v1_deploy_projects",
|
|
"summary": "Returns the argocd AppProjectList this console groups and filters applications by.",
|
|
"description": "Returns the argocd AppProjectList this console groups and\nfilters applications by. Projects are owned by Hanzo IAM rather than by argocd,\nso they are REFLECTED read-only from the IAM project store and nothing is\npersisted here: a validated org member gets its own organization's projects and\na platform SuperAdmin gets every organization's.\n\nA SuperAdmin whose IAM store is not reachable falls back to the real\nargoproj.io AppProject CRs when that CRD is served, and otherwise to one\npermissive synthesized project per distinct project name the App CRs declare.\nA project named \"default\" is always present, because that is what an App CR\ncarrying no project label projects to.",
|
|
"tags": [
|
|
"deploy"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/argoProjectList"
|
|
}
|
|
}
|
|
},
|
|
"description": "ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/deploy/reconcile": {
|
|
"post": {
|
|
"operationId": "post_v1_deploy_reconcile",
|
|
"summary": "Render the configured git source and apply it to the cluster, once",
|
|
"description": "Runs one full GitOps sync through the embedded engine — render the configured repo, ref and path, then three-way server-side apply with scoped prune — and answers the revision it applied, the source it came from, the declared/synced/pruned/failed counts and a per-resource result. This is the WRITE half of the plane: it mutates live cluster objects and, with prune enabled, deletes objects the source no longer declares.\n\nSuperAdmin-only and fail-closed — a non-SuperAdmin is refused before any cluster object is read or touched. The git source is read AS THE CALLER, so the source plane scopes the answer itself rather than trusting this one to have scoped it. It reads no request body; the source is configuration, not a parameter. A deployment with the engine switched off, or with no usable cluster config, answers 503; a failure to start, render or sync is a 502.",
|
|
"tags": [
|
|
"deploy"
|
|
]
|
|
}
|
|
},
|
|
"/v1/deploy/session/userinfo": {
|
|
"get": {
|
|
"operationId": "get_v1_deploy_session_userinfo",
|
|
"summary": "Answers \"is this browser signed in, and if not where does it sign in?\" — the dashboard SPA's bootstrap question, and the only route on this plane that answers for an anonymous caller.",
|
|
"description": "Answers \"is this browser signed in, and if not where does it\nsign in?\" — the dashboard SPA's bootstrap question, and the only route on this\nplane that answers for an anonymous caller.\n\nThe anonymous answer carries loggedIn:false and a URL and NOTHING else: no\nusername, no org, no groups, no issuer, no hint about who the caller might be or\nwhat exists in the cluster. Answering it costs nothing (the caller already knows\nwhether it holds a cookie) and withholding it costs the whole sign-in journey.\n\nThe predicate is the platform SuperAdmin fact — the SAME one every other route\nhere gates on, minted from a validated principal whose org is the reserved admin\norg — so a validated-but-not-SuperAdmin caller is reported as NOT signed in,\nwhich is the truth as this console defines it: they cannot use it.",
|
|
"tags": [
|
|
"deploy"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/sessionUser"
|
|
}
|
|
}
|
|
},
|
|
"description": "ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/deploy/settings": {
|
|
"get": {
|
|
"operationId": "get_v1_deploy_settings",
|
|
"summary": "Returns the argocd AuthSettings object the dashboard SPA awaits before its first render.",
|
|
"description": "Returns the argocd AuthSettings object the dashboard SPA\nawaits before its first render.\n\nEvery value is a CONSTANT of this projection rather than configuration read\nfrom anywhere: the SPA's own login form is reported disabled and its OIDC\nconfig null because Hanzo IAM owns identity at the edge and this console's\nsign-in is GET /v1/deploy/login, and every argocd feature the projection does\nnot implement — status badges, Dex connectors, config-management plugins,\nkustomize versions, the exec terminal, apps-in-any-namespace, the hydrator,\nsync-with-replace — is reported off. Platform SuperAdmin only.",
|
|
"tags": [
|
|
"deploy"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/consoleSettings"
|
|
}
|
|
}
|
|
},
|
|
"description": "ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/deploy/stream/applications": {
|
|
"get": {
|
|
"operationId": "get_v1_deploy_stream_applications",
|
|
"summary": "Live application fleet updates as Server-Sent Events",
|
|
"description": "Holds the connection open as text/event-stream and pushes one watch event per application change. It opens with an `ADDED` frame for every application currently present — the same projection the applications list serves, so a client renders a complete fleet from the stream alone — and then forwards `ADDED`, `MODIFIED` and `DELETED` as they happen, with a keep-alive every 25 seconds that is also how a vanished client is noticed and its watch torn down.\n\nRead-only and TENANT-SCOPED, fail-closed: a platform SuperAdmin streams the whole fleet, a validated org member streams only its own org's applications, anyone else gets 403 and no stream. No cluster client configured is 503. If the deployment is not granted the watch verb the stream degrades to keep-alives only — the initial state still renders, it simply stops updating — rather than failing the connection.",
|
|
"tags": [
|
|
"deploy"
|
|
]
|
|
}
|
|
},
|
|
"/v1/deploy/stream/applications/{name}/resource-tree": {
|
|
"get": {
|
|
"operationId": "get_v1_deploy_stream_applications_by_name_resource-tree",
|
|
"summary": "Live resource tree for one application, as Server-Sent Events",
|
|
"description": "Holds the connection open as text/event-stream and pushes the application's whole resource tree — its live child objects and each one's derived health — once immediately and again on every keep-alive tick, so a client always has a current picture without polling. The refresh IS the keep-alive: it is a cheap rebuild rather than a watch, so there is no multi-resource watch to leak.\n\nTENANT-SCOPED and fail-closed BEFORE the stream opens, which is the rule that matters: the caller's scope and the application's namespace are resolved first, so an unvalidated caller gets a plain 403 and an application belonging to another tenant gets a plain 404 — never an opened stream that emits nothing. A SuperAdmin reaches the whole fleet, an org member only its own org's applications. No cluster client configured is 503.",
|
|
"tags": [
|
|
"deploy"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/v1/deploy/version": {
|
|
"get": {
|
|
"operationId": "get_v1_deploy_version",
|
|
"summary": "Returns the argocd VersionMessage the dashboard SPA reads at bootstrap.",
|
|
"description": "Returns the argocd VersionMessage the dashboard SPA reads at\nbootstrap. There is no argocd binary behind this plane — it is a projection\nover operator App CRs — so the fields say so rather than describing a build:\nVersion names the projection, BuildDate is the moment this response was\ngenerated, and Compiler/Platform/GoVersion are the constants the SPA tolerates\nrather than facts about this process. Platform SuperAdmin only.",
|
|
"tags": [
|
|
"deploy"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/versionMessage"
|
|
}
|
|
}
|
|
},
|
|
"description": "ok"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"components": {
|
|
"schemas": {
|
|
"GitOpsApp": {
|
|
"properties": {
|
|
"automated": {
|
|
"type": "boolean"
|
|
},
|
|
"health": {
|
|
"description": "Healthy|Degraded|Progressing|…",
|
|
"type": "string"
|
|
},
|
|
"history": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/GitOpsDeploy"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"namespace": {
|
|
"type": "string"
|
|
},
|
|
"operation": {
|
|
"$ref": "#/components/schemas/GitOpsOperation"
|
|
},
|
|
"path": {
|
|
"type": "string"
|
|
},
|
|
"project": {
|
|
"type": "string"
|
|
},
|
|
"reconciledAt": {
|
|
"type": "string"
|
|
},
|
|
"repoURL": {
|
|
"type": "string"
|
|
},
|
|
"resources": {
|
|
"type": "integer"
|
|
},
|
|
"revision": {
|
|
"description": "the commit last applied",
|
|
"type": "string"
|
|
},
|
|
"selfHeal": {
|
|
"type": "boolean"
|
|
},
|
|
"sync": {
|
|
"description": "Synced|OutOfSync|Unknown",
|
|
"type": "string"
|
|
},
|
|
"targetRevision": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"GitOpsDeploy": {
|
|
"properties": {
|
|
"automated": {
|
|
"type": "boolean"
|
|
},
|
|
"deployedAt": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "integer"
|
|
},
|
|
"revision": {
|
|
"type": "string"
|
|
},
|
|
"startedAt": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"GitOpsOperation": {
|
|
"properties": {
|
|
"finishedAt": {
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
},
|
|
"phase": {
|
|
"type": "string"
|
|
},
|
|
"revision": {
|
|
"type": "string"
|
|
},
|
|
"startedAt": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"GitOpsPlane": {
|
|
"properties": {
|
|
"applications": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/GitOpsApp"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"installed": {
|
|
"type": "boolean"
|
|
},
|
|
"reason": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"argoApp": {
|
|
"properties": {
|
|
"apiVersion": {
|
|
"type": "string"
|
|
},
|
|
"kind": {
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"$ref": "#/components/schemas/argoMeta"
|
|
},
|
|
"spec": {
|
|
"$ref": "#/components/schemas/argoSpec"
|
|
},
|
|
"status": {
|
|
"$ref": "#/components/schemas/argoStatus"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"argoAppList": {
|
|
"properties": {
|
|
"apiVersion": {
|
|
"type": "string"
|
|
},
|
|
"items": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/argoApp"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"kind": {
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"$ref": "#/components/schemas/argoListMeta"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"argoCluster": {
|
|
"properties": {
|
|
"connectionState": {
|
|
"$ref": "#/components/schemas/argoConnectionState"
|
|
},
|
|
"info": {
|
|
"$ref": "#/components/schemas/argoClusterInfo"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"server": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"argoClusterInfo": {
|
|
"properties": {
|
|
"applicationsCount": {
|
|
"type": "integer"
|
|
},
|
|
"connectionState": {
|
|
"$ref": "#/components/schemas/argoConnectionState"
|
|
},
|
|
"serverVersion": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"argoClusterList": {
|
|
"properties": {
|
|
"items": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/argoCluster"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"metadata": {
|
|
"$ref": "#/components/schemas/argoListMeta"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"argoConnectionState": {
|
|
"properties": {
|
|
"attemptedAt": {
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"argoDestination": {
|
|
"properties": {
|
|
"name": {
|
|
"description": "ArgoCD allows a destination by cluster name; omitted for the in-cluster projection.",
|
|
"type": "string"
|
|
},
|
|
"namespace": {
|
|
"type": "string"
|
|
},
|
|
"server": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"argoGroupKind": {
|
|
"properties": {
|
|
"group": {
|
|
"type": "string"
|
|
},
|
|
"kind": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"argoHealth": {
|
|
"properties": {
|
|
"message": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"argoInfoItem": {
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"argoListMeta": {
|
|
"properties": {
|
|
"resourceVersion": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"argoMeta": {
|
|
"properties": {
|
|
"creationTimestamp": {
|
|
"type": "string"
|
|
},
|
|
"labels": {
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"namespace": {
|
|
"type": "string"
|
|
},
|
|
"uid": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"argoNode": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string"
|
|
},
|
|
"group": {
|
|
"type": "string"
|
|
},
|
|
"health": {
|
|
"$ref": "#/components/schemas/argoHealth"
|
|
},
|
|
"images": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"info": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/argoInfoItem"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"kind": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"namespace": {
|
|
"type": "string"
|
|
},
|
|
"parentRefs": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/argoResourceRef"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"resourceVersion": {
|
|
"type": "string"
|
|
},
|
|
"uid": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"argoProject": {
|
|
"properties": {
|
|
"apiVersion": {
|
|
"type": "string"
|
|
},
|
|
"kind": {
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"$ref": "#/components/schemas/argoMeta"
|
|
},
|
|
"spec": {
|
|
"$ref": "#/components/schemas/argoProjectSpec"
|
|
},
|
|
"status": {
|
|
"$ref": "#/components/schemas/argoProjectStat"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"argoProjectList": {
|
|
"properties": {
|
|
"items": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/argoProject"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"metadata": {
|
|
"$ref": "#/components/schemas/argoListMeta"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"argoProjectSpec": {
|
|
"properties": {
|
|
"clusterResourceWhitelist": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/argoGroupKind"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"destinations": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/argoDestination"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"sourceRepos": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"argoProjectStat": {
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
"argoResourceRef": {
|
|
"properties": {
|
|
"group": {
|
|
"type": "string"
|
|
},
|
|
"kind": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"namespace": {
|
|
"type": "string"
|
|
},
|
|
"uid": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"argoResourceStatus": {
|
|
"properties": {
|
|
"group": {
|
|
"type": "string"
|
|
},
|
|
"health": {
|
|
"$ref": "#/components/schemas/argoHealth"
|
|
},
|
|
"kind": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"namespace": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"argoRevisionMetadata": {
|
|
"properties": {
|
|
"author": {
|
|
"type": "string"
|
|
},
|
|
"date": {
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
},
|
|
"signatureInfo": {
|
|
"type": "string"
|
|
},
|
|
"tags": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"argoSource": {
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
},
|
|
"repoURL": {
|
|
"type": "string"
|
|
},
|
|
"targetRevision": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"argoSpec": {
|
|
"properties": {
|
|
"destination": {
|
|
"$ref": "#/components/schemas/argoDestination"
|
|
},
|
|
"project": {
|
|
"type": "string"
|
|
},
|
|
"source": {
|
|
"$ref": "#/components/schemas/argoSource"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"argoStatus": {
|
|
"properties": {
|
|
"health": {
|
|
"$ref": "#/components/schemas/argoHealth"
|
|
},
|
|
"reconciledAt": {
|
|
"type": "string"
|
|
},
|
|
"resources": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/argoResourceStatus"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"summary": {
|
|
"$ref": "#/components/schemas/argoSummary"
|
|
},
|
|
"sync": {
|
|
"$ref": "#/components/schemas/argoSyncStatus"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"argoSummary": {
|
|
"properties": {
|
|
"images": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"argoSyncStatus": {
|
|
"properties": {
|
|
"revision": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"argoSyncWindows": {
|
|
"properties": {
|
|
"activeWindows": {
|
|
"items": {
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"assignedWindows": {
|
|
"items": {
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"canSync": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"argoTree": {
|
|
"properties": {
|
|
"hosts": {
|
|
"items": {
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"nodes": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/argoNode"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"orphanedNodes": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/argoNode"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"consoleSettings": {
|
|
"properties": {
|
|
"appsInAnyNamespaceEnabled": {
|
|
"description": "AppsInAnyNamespaceEnabled is false: applications are projected from operator\nApp CRs in the platform namespaces, never declared in an arbitrary one.",
|
|
"type": "boolean"
|
|
},
|
|
"dexConfig": {
|
|
"description": "DexConfig carries no connectors. This console does not run Dex; its sign-in is\nGET /v1/deploy/login, which is an IAM authorization-code round trip.",
|
|
"properties": {
|
|
"connectors": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/deployEmpty"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"execEnabled": {
|
|
"description": "ExecEnabled is false: this plane serves no container terminal.",
|
|
"type": "boolean"
|
|
},
|
|
"googleAnalytics": {
|
|
"description": "GoogleAnalytics carries no tracking id and anonymizes users — this console\nreports no analytics.",
|
|
"properties": {
|
|
"anonymizeUsers": {
|
|
"type": "boolean"
|
|
},
|
|
"trackingID": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"help": {
|
|
"description": "Help carries no chat link and no binary download URLs.",
|
|
"properties": {
|
|
"binaryUrls": {
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"type": "object"
|
|
},
|
|
"chatText": {
|
|
"type": "string"
|
|
},
|
|
"chatUrl": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"hydratorEnabled": {
|
|
"description": "HydratorEnabled is false: there is no manifest hydrator on this plane.",
|
|
"type": "boolean"
|
|
},
|
|
"kustomizeVersions": {
|
|
"description": "KustomizeVersions is always empty: an App CR is an image pin, not a kustomize\nbuild.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"oidcConfig": {
|
|
"$ref": "#/components/schemas/deployEmpty",
|
|
"description": "OidcConfig is always null. The SPA's own OIDC flow is deliberately not\nconfigured — identity is owned by Hanzo IAM at the edge and minted for this\nhost by GET /v1/deploy/login."
|
|
},
|
|
"plugins": {
|
|
"description": "Plugins is always empty: this plane loads no argocd config-management plugins.",
|
|
"items": {
|
|
"$ref": "#/components/schemas/deployEmpty"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"statusBadgeEnabled": {
|
|
"description": "StatusBadgeEnabled is false: no badge endpoint is served.",
|
|
"type": "boolean"
|
|
},
|
|
"statusBadgeRootUrl": {
|
|
"description": "StatusBadgeRootUrl is always empty, for the same reason.",
|
|
"type": "string"
|
|
},
|
|
"syncWithReplaceAllowed": {
|
|
"description": "SyncWithReplaceAllowed is false: a sync here asks the operator to reconcile an\nApp CR, and never replaces an object.",
|
|
"type": "boolean"
|
|
},
|
|
"uiBannerContent": {
|
|
"description": "UiBannerContent is always empty: this console shows no banner.",
|
|
"type": "string"
|
|
},
|
|
"uiCssURL": {
|
|
"description": "UiCssURL is always empty: no stylesheet is injected.",
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"description": "Url is the console's public origin, https://cd.hanzo.ai.",
|
|
"type": "string"
|
|
},
|
|
"userLoginsDisabled": {
|
|
"description": "UserLoginsDisabled is true: the SPA must not render its own username/password\nform. Signing in goes through IAM, at GET /v1/deploy/login.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"deployEmpty": {
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
"sessionUser": {
|
|
"properties": {
|
|
"groups": {
|
|
"description": "Groups is the caller's group list, always empty here: this console\nauthorizes on the platform SuperAdmin fact alone, not on argocd RBAC groups.\nAbsent for an anonymous caller.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"iss": {
|
|
"description": "Iss is the token issuer as the SPA expects to see it — the literal \"argocd\",\nso the UI never triggers an SSO redirect of its own. Absent for an anonymous\ncaller.",
|
|
"type": "string"
|
|
},
|
|
"loggedIn": {
|
|
"description": "LoggedIn reports whether this browser holds a session this console accepts.",
|
|
"type": "boolean"
|
|
},
|
|
"loginUrl": {
|
|
"description": "LoginURL is where an anonymous caller signs in. Absent once signed in.",
|
|
"type": "string"
|
|
},
|
|
"logoutUrl": {
|
|
"description": "LogoutURL is where a signed-in caller ends the session. Absent when anonymous.",
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"description": "Username is the validated principal's user ID — the opaque gateway id, which\nis what argocd's UI renders as the signed-in user here — or \"admin\" when the\nprincipal carries none. Absent when anonymous.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"versionMessage": {
|
|
"properties": {
|
|
"BuildDate": {
|
|
"description": "BuildDate is the time THIS RESPONSE was generated, in RFC 3339 — not a build\ntimestamp. There is no argocd build here to report one for.",
|
|
"type": "string"
|
|
},
|
|
"Compiler": {
|
|
"description": "Compiler is the constant \"gc\" the SPA expects; it is not read from this\nprocess.",
|
|
"type": "string"
|
|
},
|
|
"GoVersion": {
|
|
"description": "GoVersion is always empty.",
|
|
"type": "string"
|
|
},
|
|
"Platform": {
|
|
"description": "Platform is the constant \"linux/amd64\" the SPA expects; it is not this\nprocess's own GOOS/GOARCH.",
|
|
"type": "string"
|
|
},
|
|
"Version": {
|
|
"description": "Version names the projection, \"hanzo-cd (projection)\".",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
}
|