Skip to content

docs: update agent templating functions#5727

Merged
varonix0 merged 4 commits into
mainfrom
daniel/agent-templating-funcs-docs
Mar 17, 2026
Merged

docs: update agent templating functions#5727
varonix0 merged 4 commits into
mainfrom
daniel/agent-templating-funcs-docs

Conversation

@varonix0
Copy link
Copy Markdown
Member

Context

Updated agent templating functions to reflect latest change here: Infisical/cli#150

Type

  • Fix
  • Feature
  • Improvement
  • Breaking
  • Docs
  • Chore

Checklist

  • Title follows the conventional commit format: type(scope): short description (scope is optional, e.g., fix: prevent crash on sync or fix(api): handle null response).
  • Tested locally
  • Updated docs (if needed)
  • Updated CLAUDE.md files (if needed)
  • Read the contributing guide

@varonix0 varonix0 requested a review from victorvhs017 March 16, 2026 23:31
@maidul98
Copy link
Copy Markdown
Collaborator

maidul98 commented Mar 16, 2026

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Mar 16, 2026

Greptile Summary

This PR updates the Infisical Agent documentation to reflect renamed template functions from the CLI (secretlistSecrets, dynamic_secretdynamicSecret) and adds documentation for a new listSecretsByProjectSlug function that accepts a project slug instead of a project ID.

  • Stale prose in Quick Start section (line 505–506): The code example was correctly updated to use listSecrets, but the surrounding descriptive paragraph still refers to the old secret function name, which will mislead users following the Quick Start guide.
  • Misleading return description on new listSecretsByProjectSlug accordion (line 118): The Returns field says "A single secret object" but the function returns a list (evidenced by the {{- range . }} usage in both examples). The description should read "A list of secret objects" consistent with the getSecretByName entry.
  • Note: The same "A single secret object" wording exists on the listSecrets accordion (line 82), which was pre-existing and not introduced by this PR.

Confidence Score: 4/5

  • Safe to merge after addressing the stale secret function name reference in the Quick Start prose; the rest of the changes are correct and well-structured.
  • This is a pure documentation PR with no code changes. The function renames and new accordion are correct, but there is one clear inconsistency where the Quick Start prose was not updated alongside the code example, which would confuse users following that section.
  • docs/integrations/platforms/infisical-agent.mdx — specifically lines 505–506 (stale function name in prose) and line 118 (misleading return description in new accordion).

Important Files Changed

Filename Overview
docs/integrations/platforms/infisical-agent.mdx Updates agent template function names (secretlistSecrets, dynamic_secretdynamicSecret) and adds a new listSecretsByProjectSlug function; the Quick Start prose still references the old secret function name and the new listSecretsByProjectSlug accordion has a misleading "single secret object" return description.

Comments Outside Diff (1)

  1. docs/integrations/platforms/infisical-agent.mdx, line 505-506 (link)

    Stale prose still references old secret function name

    The code example on line 509 was correctly updated to listSecrets, but the surrounding descriptive text still mentions the old function name secret. This will confuse users reading the Quick Start section.

Last reviewed commit: bb21027

Comment thread docs/integrations/platforms/infisical-agent.mdx Outdated
varonix0 and others added 3 commits March 17, 2026 04:35
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@victorvhs017 victorvhs017 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@varonix0 varonix0 merged commit 96c026c into main Mar 17, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants