docs: credential strategy for agent runs (REMOTE-1815) [auto-draft] - #415
Draft
rachaelrenk wants to merge 1 commit into
Draft
docs: credential strategy for agent runs (REMOTE-1815) [auto-draft]#415rachaelrenk wants to merge 1 commit into
rachaelrenk wants to merge 1 commit into
Conversation
Add a docs page for the per-run credential_strategy field (EXECUTOR vs CREATOR) that controls which principal's credentials are used for Git and GitLab operations in a cloud agent run. Adds a placeholder sidebar entry. Auto-drafted from the REMOTE-1815 PRODUCT.md spec and codebase-verified facts. Co-Authored-By: Oz <oz-agent@warp.dev>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
Heads up, @rachaelrenk! This is part of some on-going work that I am doing around making it easier to configure run attribution. I think we can hold off on iterating on this until that work is done then do an exhaustive docs page on credential strategies/what principals are used where/how to configure it/etc. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Auto-drafted documentation for Configurable credential strategy for agent runs.
credential_strategy) for cloud agent runsThis adds a per-run
credential_strategyfield (EXECUTORvsCREATOR, defaultEXECUTOR) that controls which principal's credentials Warp mints for Git/GitLab operations in a cloud agent run. New page:src/content/docs/platform/credential-strategy.mdx, plus a placeholder sidebar entry insrc/sidebar.ts.This draft was generated in ambient mode (triggered by
scan-new-specs). Content is derived only fromPRODUCT.mdand codebase-verified facts — noTECH.md-derived content was included.Docs outline (auto-generated)
The following outline was generated from the spec. @captainsafia: please review and check off each item, or leave a comment with corrections.
Content structure
Credential strategycredential_strategycontrols (which principal's credentials are used for Git/GitLab operations, set per run)EXECUTOR/CREATOR/unset semantics, snapshotting onto the run record## GitHub behavior: per-strategy behavior for user vs service account principals## GitLab behavior: per-strategy behavior including the service-account interim limitation## Setting the credential strategywith steps: build request → addcredential_strategytoconfigblock → submit; plus accepted values, curl example, and validation subsectionItems needing engineer verification⚠️
POST /agent/run; PRODUCT.md §15 referencesPOST /api/v1/agent/runs. Confirm the exact endpoint and thatcredential_strategylives in the request'sconfigblock.credential_strategyis returned in run GET responses (PRODUCT.md §15) and is present in the public OpenAPI spec that powers the/apireference. It is not yet in the docs repo's synceddevelopers/agent-api-openapi.yaml, so the Scalar/apireference will not show it untilsync-openapi-specruns.[TODO: docs reviewer — screenshot needed]placeholder is left in the page; computer use was unavailable, so no screenshot was captured.src/sidebar.tswith a// [TODO: docs reviewer — confirm placement]note. Confirm this is the right home (vs. Reference → API & SDK).Verified from codebase ✅
config.credential_strategy— confirmed via the validation error string inrouter/handlers/public_api/agent_webhooks.go(config.credential_strategy %q is not valid; accepted values are %q and %q).CREATORandEXECUTOR— confirmed inmodel/types/enums/credential_strategy.goand related code.400validation for any other non-empty value — consistent with the webhook validation error and PRODUCT.md §16.logic/ai/ambient_agents/credential_strategy_validation.go.logic/ai/ambient_agents/git_credentials.go.Full list of
[UNVERIFIED]/[TODO]items in the draftcredential-strategy.mdx(How it works):[TODO: docs reviewer — screenshot needed]+[UNVERIFIED]whether effective strategy shows in the Oz web app UI.credential-strategy.mdx(Setting the credential strategy):[TODO: engineer to verify]exact endpoint (POST /agent/runvsPOST /api/v1/agent/runs) andconfigblock placement.credential-strategy.mdx(Setting the credential strategy):[TODO: engineer to verify]credential_strategyreturned in GET responses and present in the public OpenAPI spec.src/sidebar.ts:// [TODO: docs reviewer — confirm placement]./cc @captainsafia
Requesting review from @rachaelrenk and @hongyi-chen.
Conversation: https://app.warp.dev/conversation/e8fd611f-bdd4-40ea-af4f-0efa6ccfb970
Run: https://oz.warp.dev/runs/019fae9f-b516-7887-b592-fa53ff7a5e95
This PR was generated with Oz.