Conversation
…k MSSP search Combines the legacy /v1 Search Job API and the new OpenAPI-based /v2 Search Job Management API into a single doc with a shared section for common concepts (prerequisites, roles, limits, errors, process flow) and separate sections for what's unique to each version. Cross-links MSSP multi-org search to the new API's childOrgIds/includeAllChildOrgs params, and adds a release note for the _orgName field.
amee-sumo
left a comment
There was a problem hiding this comment.
Reviewed the full diff — clean restructuring, no blocking issues.
Verified:
- All internal links/anchors across the repo that point into
search-job.md(7 docs + 2 blog posts) still resolve — heading text didn't change, only nesting level, so slugs are stable. - No orphaned second page — the "instead of two separate pages" framing refers to a design decision made within this branch itself, not a leftover doc.
<ApiIntro/>relocation into the new "Search Job Management API" section is correct — its content is OpenAPI/Swagger-specific and doesn't apply to the Legacy API.- The
_orgNamefield the new release note announces is already documented insearch-across-child-orgs.md, so the note isn't ahead of the docs. toc_max_heading_level: 4is a legitimate Docusaurus option, justified by the doc's new 4-level heading depth.
Minor nit, not blocking: the bash script code block has some trailing-whitespace-only diff noise (e.g. the PROTOCOL=$1 ... lines look unchanged but show as modified). Harmless since it's in a code fence, but worth a quick cleanup pass if you touch this file again.
ReviewSolid restructure and the mechanics check out (anchors, frontmatter, conventions). Two things worth resolving before merge, both content-accuracy rather than formatting. Should fix before merge1. "Shared" sections still carry legacy-only session semantics Everything above the
A reader landing on the Search Job Management API (the one we're recommending) will reasonably conclude they must poll every 20–30s to avoid cancellation. Please confirm whether keepalive/inactivity-cancellation and the 8-hour query timeout apply to the Management API; if they're legacy-only, scope those sentences to the Legacy section or add a qualifying note. The 2. Release note backdated a month
Nits (non-blocking)
Verified OK
🤖 Generated with Claude Code |
kimsauce
left a comment
There was a problem hiding this comment.
Inline notes for the findings from my summary comment above.
Scopes the 20-30s keepalive/inactivity-cancellation language to the
Legacy API (the Management API doesn't need it), fixes wording nits
("earlier version", "slower"), adds a parameter table for
childOrgIds/includeAllChildOrgs, and restores original whitespace in
the bash script code block.
Purpose of this pull request
Combines the legacy Search Job API and the new OpenAPI-based Search Job Management API into a single doc (
docs/api/search-job.md), instead of two separate pages, with a shared section for concepts common to both (prerequisites, required role capabilities, result limits, rate limits, process flow, errors) and dedicated sections for what's specific to each version:childOrgIds/includeAllChildOrgsparameters.Also:
_orgNamefield for multi-child-org search results, and mentioning the programmatic option.Verified via
yarn build(no broken links/anchors) after each change.Select the type of change
Ticket (if applicable)
https://sumologic.atlassian.net/browse/DOCS-1841