docs: add TSDoc to SecurityPlugin, policy engine interfaces, and InMemoryPolicyEngine#399
Closed
nuthalapativarun wants to merge 1 commit into
Closed
Conversation
…cyEngine, InMemoryPolicyEngine, and SecurityPlugin
2 tasks
Contributor
Author
|
Closing in favour of the consolidated PR #413, as requested by @kalenkevich. All changes from this PR are included there. |
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.
Please ensure you have read the contribution guide before creating a pull request.
Link to Issue or Description of Change
Adds TSDoc to
core/src/plugins/security_plugin.ts, which was missing inline documentation on its public interfaces and class members:PolicyCheckResult— documentsoutcomeandreasonfieldsToolCallPolicyContext— documentstoolandtoolArgsfieldsBasePolicyEngine.evaluate()— adds@paramand@returnsInMemoryPolicyEngine.evaluate()— adds description and@returnsSecurityPluginconstructor — adds@param paramsSecurityPlugin.beforeToolCallback— adds@paramdescriptions fortool,toolArgs,toolContextand documents the return valueTesting Plan
Unit Tests:
Manual End-to-End (E2E) Tests:
Documentation-only change; no runtime behavior is altered. Verified with
npm run build,npm run lint, andnpm test— all pass.Checklist