docs: document ThreatLocker extension response shape + add AI topic index#247
Draft
maximelb wants to merge 1 commit into
Draft
docs: document ThreatLocker extension response shape + add AI topic index#247maximelb wants to merge 1 commit into
maximelb wants to merge 1 commit into
Conversation
…ndex Improve discoverability for automation and AI consumers of the docs: - ThreatLocker extension: add a "Response shape" subsection for the approval-request reads, documenting the top-level `data` envelope (array for the search/list read, object for the single-id read), the salient approval-request record fields an automation needs, and the nested threatLockerActionDto. Clarify that an empty `data` array is a successful empty result, not an error. Reinforce the public ThreatLocker Portal Swagger as the authoritative field-set reference (no internal/private pointer involved). - Add docs/index-for-ai.md: a short, curated topic index mapping top-level sections and, importantly, the adapter-vs-extension dual layout to canonical doc paths (one line per integration pointing to BOTH paths). Complements the auto-generated /llms.txt, which is a flat nav dump and cannot express these cross-references. Wired into the Reference nav. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
What
Two discoverability improvements found during routine review of the docs, aimed at automation and AI consumers:
ThreatLocker extension — Response shape. The extension page documented each action's request body but not the response envelope a consumer receives. Added a concise "Response shape" subsection to the approval-request reads:
datakey — an array for the search/list read (approval_request_search), a single object for the single-id read (approval_request_get).approvalRequestId,statusIdwith1=pending,hostname,username,requestorEmailAddress,requestorReason(base64),computerId,organizationId,path,dateTime) plus the nestedthreatLockerActionDto(actionType,sha256,fullPath,certs,osType,processName).dataarray is a successful empty result, not an error.AI topic index. Added
docs/index-for-ai.md: a short, curated map of the top-level sections and — importantly — the adapter-vs-extension dual layout, with one line per integration that has both, pointing to BOTH its adapter path and its extension path (currently ThreatLocker). It carries a header note that it is curated and may lag the tree, and complements the existing auto-generated/llms.txt(a flat nav dump that cannot express these cross-references). Wired into the Reference nav.Notes
REFERENCES.mdpointer in the ThreatLocker docs. None exists — both pages already point readers to the public Portal Swagger for field-set details, and the new Response shape section reinforces that public pointer.llms.txtconvention (generated byhooks/llms_txt.py, never committed) by adding the curated companion asindex-for-ai.mdrather than a staticllms.txtthat would collide with the generated one.Validation
npx markdownlint-cli2 docs/**/*.md— 0 errors.mkdocs build— clean (only the generic Material/MkDocs advisory banner); new page builds, no broken relative links introduced,index-for-ai.mdpresent in nav.🤖 Generated with Claude Code