docs(guardrails): document bring-your-own (BYOG) guardrail configurations [AL-513] - #2408
docs(guardrails): document bring-your-own (BYOG) guardrail configurations [AL-513]#2408apetraru-uipath wants to merge 2 commits into
Conversation
|
Claude finished @apetraru-uipath's task in 4m 8s —— View job PR Review: docs(guardrails): document bring-your-own (BYOG) guardrail configurations AL-513
SummaryDocuments the new bring-your-own guardrail (BYOG) feature across the Change-by-Change Review1.
|
| Area | Status | Notes |
|---|---|---|
| Frontmatter | Issue | description at 1038 chars, over the 1024-char repo cap |
| E2E Tests | N/A | No CLI CRUD verbs to test against yet — acknowledged |
| Skill Body | OK | Well-structured additions across all four skills |
| References & Assets | OK | New file is clean; all links resolve; no orphaned files |
| Repo Hygiene | OK | CODEOWNERS updated; no secrets; no cross-skill file dependencies; scoped changes |
Issues for Manual Review
- CLI command accuracy:
uip guardrails byo-configurations list,uip agent guardrails list --byo, and the--output-filterJMESPath expressions cannot be verified without a live tenant. The author confirms these ship on a pending CLI branch. - SDK construct
ByoValidator(<ValidatorName>, connection_id=<ConnectionId>): referenced inbyo-configurations.md:47and the coded guardrails section — verify this matches the actual Python SDK once the docs publish. - Output shape fields (
Id,ConnectionId,ValidatorName,ValidatorType,FallbackOnUiPath,Enabled,ValidConnection, etc.): verify against the actual API response once the CLI merges.
Conclusion
Clean, well-structured documentation PR that consistently threads BYOG awareness across four skills without introducing structural cross-skill dependencies. The only actionable finding is the description field exceeding the 1024-char repo cap (Medium) — a ~14-character trim resolves it. Everything else (section placement, anchor links, reference pointer discipline, cross-skill delegation syntax, CODEOWNERS) is correct.
0f0fadb to
c6b49f9
Compare
…ions [AL-513] Covers the new BYOG CLI surface across every guardrail area: agent-authoring (low-code + coded) discovery and wiring via `--byo`/`IsByo`, the disambiguation needed once a validator has both a built-in and a BYO entry sharing the same name, review-side awareness, troubleshoot diagnosis, and a new admin-side reference for `uip guardrails byo-configurations list` mirroring the existing BYO LLM Gateway doc. `uip guardrails byo-configurations list` isn't in the published CLI catalog yet (it ships on cli's feat/al-512-agent-guardrails-byo-configurations, not yet merged), so this trips the CLI Verb Gate until that lands and the catalog snapshot refreshes — expected, not a doc error. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
cli#3298 (AL-512) merged with one review-driven change: non-404 errors now surface the backend's response body, confirming the endpoint requires an org-admin user token (rejects application tokens) and returns 403 with a detail message otherwise. Field names and command shape are unchanged from what this repo already documented. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
c6b49f9 to
a422e45
Compare
What changed?
Documents the new bring-your-own guardrail (BYOG) feature across every guardrail area of the skills repo, mirroring the existing BYO LLM Gateway doc convention:
skills/uipath-platform/references/guardrails/byo-configurations.md— admin-side reference foruip guardrails byo-configurations list(list-only today; registration is Admin UI only). Wired intouipath-platform/SKILL.md(frontmatter, command table, references list) andCODEOWNERS.uipath-agents(low-code + coded guardrails, guardrails-recommend — 4 files): explains the BYOG concept, the--byofilter,IsByo/Byo*fields, thatValidatoris not unique once a BYOG config exists, how to pin a low-code guardrail to one (byoConfigurationId), how a coded agent wires one in (fetch SDK docs first — never hardcodeByoValidator(...)from memory), and a disambiguation fix so recommend/validate lookups don't collide a built-in and BYO entry sharing the same name.uipath-review(2 files): same disambiguation note, plus a callout that a BYO entry'sStatus: Disabledis a tenant config switch, not a schema defect.uipath-troubleshoot: added BYOG as a possible cause of a guardrail violation, a step to cross-check BYOG health, and a resolution path for a dead connection or disabled config.Ticket: AL-513.
How has this been tested?
Ran
scripts/check-skill-verbs.pyagainst every touched file. All findings are either pre-existing soft-stale placeholder noise already present in this repo, or the expected hard-stale hits onuip guardrails byo-configurations list(7 occurrences) — that command isn't in the published CLI catalog snapshot yet because it ships on the CLI'sfeat/al-512-agent-guardrails-byo-configurationsbranch, not yet merged/published. The CLI Verb Gate check on this PR is expected to fail until that CLI change merges andassets/uip-catalog-snapshot.jsonis refreshed — this is a doc-vs-CLI sequencing issue, not a documentation error. No new automated coder-eval test fixtures were added this round (BYOG configs have no CLI create/update/delete verb, so a task can't provision one reliably yet); revisit once the CLI adds BYOG CRUD.Are there any breaking changes?