Skip to content

docs(connectors): correct Aqua Supply Chain branch guidance (pinning is not the fix) - #16022

Merged
Maffooch merged 2 commits into
bugfixfrom
docs/aqua-branch-correction
Sep 21, 2026
Merged

Maffooch merged 2 commits into
bugfixfrom
docs/aqua-branch-correction

Conversation

@Maffooch

@Maffooch Maffooch commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

[sc-15563]

What

Corrects the Aqua Supply Chain branch guidance added in #16005, which said a non-default branch must be pinned in Aqua before it will import.

Why

Re-verifying against a live tenant with the connector's own API key and secret showed pinning is not the mechanism:

  • The connector imports findings from Aqua's scan-results feed (/codesec/api/v1/scans/results). For the affected repository that feed returns the default branch only, and it returns the same result whether the connector's token is minted with allowed_endpoints: ["ANY"] or ["ANY:*"]. Pinning does not change what that feed returns.
  • The non-default branch is visible through a different Aqua API (/supply_chain/v2/build/.../branches, which needs the ANY:* scope), but that endpoint returns only per-branch severity summaries. We could not find an endpoint that returns per-finding detail for a non-default branch to the connector's identity. So pinning is the wrong advice, and the real gap is that Aqua does not expose a non-default branch's findings through the connector's API path.

Change

Rewrite the Branch handling section to describe the actual behavior: the connector imports whatever branches Aqua returns in its scan-results feed; for some sources (for example Azure DevOps) that feed exposes only the default branch, so a configured non-default branch does not import; and an operator who expects a missing branch should contact support. Broader non-default-branch support is being worked on separately. Docs-only, on the bugfix line.

Follow-up

A connector change to request the correct Aqua token scope (ANY:*) is in progress. Importing a non-default branch's findings additionally depends on Aqua exposing per-finding detail for non-default branches through the API, which the customer has escalated to Aqua. The docs will be updated once multi-branch import is supported.

…is not the fix)

PR #16005 said a non-default branch must be pinned in Aqua before it imports.
Re-verifying against a live tenant with the connector's own credentials showed
that is wrong: Aqua's scan-results feed (which the connector reads) returns a
repository's default branch only for some sources such as Azure DevOps,
regardless of pinning or token scope, so pinning does not make the branch appear
in the feed.

Rewrite the Branch handling section to describe the actual behavior: the
connector imports whatever branches Aqua returns in its scan-results feed, some
sources expose only the default branch, and an operator who expects a missing
branch should contact support. Removes the pinning instruction.

Reported via a customer support ticket.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@github-actions github-actions Bot added the docs label Sep 21, 2026
@Maffooch Maffooch added this to the 3.3.200 milestone Sep 21, 2026
@Maffooch
Maffooch enabled auto-merge September 21, 2026 15:58
@Maffooch
Maffooch added this pull request to the merge queue Sep 21, 2026
Merged via the queue into bugfix with commit d568180 Sep 21, 2026
32 checks passed
@Maffooch
Maffooch deleted the docs/aqua-branch-correction branch September 21, 2026 16:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants