docs: accuracy fixes (salvaged from #185)#201
Merged
Conversation
- scan-api/architecture: API key HMAC and/or bearer token; lowercase x-pan-token / x-payload-hash headers; init() requires at least one - config/env: fill TOKEN_ENDPOINT defaults + EU regional endpoints - architecture/vocabulary: replace fictional ListingOptions (sort/filters) with real per-service pagination (Mgmt offset/limit, MS/RT skip/limit/ search, DLP page/size); document RequestSpec fields; fill domain vocab - red-team-api: enum casing (COMPLETED/STATIC/FAILED/HIGH/API/ACTIVE), updatePrompt uses `prompt` not `content`, corrected goal_type (AGENT, not the invalid JAILBREAK from the original PR) + status filter - index: zod validation note; MS rule instances vs read-only rules - new Runnable Examples guide page (+ sidebar), including the network-broker example the original PR predated Supersedes #185 (conflicting/stale draft); drops its one bad goal_type example and folds in docs added since.
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
1 participant
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.
Salvages the accurate, still-relevant content from #185 (a stale/conflicting draft) and rebases it onto current
main, dropping its one factual error and folding in docs added since.Why not just merge #185
#185 was
CONFLICTING(8 days stale; ~14 PRs — #187–#200 — rewrote several of the same files) and still a DRAFT, and it introduced one bad example (goal_type: 'JAILBREAK', which isn't a valid goal type). Reviewed and verified each claim against source before porting.What's included (all verified against
src/)scan-api.md,architecture.md) — API key HMAC and/or bearer token; lowercasex-pan-token/x-payload-hashheaders;init()requires at least one ofapiKey/apiToken. MatchesApiKeyAuth+constants.ts.TOKEN_ENDPOINTdefaults (configuration.mdx,environment-variables.mdx) — filled inhttps://auth.apps.paloaltonetworks.com/oauth2/access_token(matchesDEFAULT_TOKEN_ENDPOINT) + EU regional endpoint overrides.architecture.md,vocabulary.md) — replaces the fictionalListingOptions(sort/filters<TFilters>— not insrc/listing.ts) with the real per-service contracts: Managementoffset/limit, Model Security / Red Teamskip/limit/search, DLPpage/sizePage<T>. Documents actualRequestSpecfields and fills in the domain vocabulary.red-team-api.md) — enum casing (COMPLETED/STATIC/FAILED/HIGH/API/ACTIVE),updatePromptusesprompt(notcontent— matchesCustomPromptUpdateRequestSchema), and a correctedgoal_type: 'AGENT'(validGoalTypeQueryParam) +status: 'SUCCESSFUL'.index.mdx— zod validation note; "rule instances" vs read-only platform rules.examples.mdx+ sidebar) — all 18 listed scripts verified to exist, plus thered-team-network-broker.tsexample the original PR predated.Verification
Full site build clean (
docs:api+docusaurus build,onBrokenLinks: 'throw'). Lint/format/typecheck/tests green via pre-commit.Closes #185
🤖 Generated with Claude Code