Sync OrionIQ docs with 3 months of API and product changes - #960
Conversation
Add an OrionIQ API reference and a Memory page, and correct the OrionIQ user guide against changes merged between 2026-05-27 and 2026-08-27. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016YV5STTjgrMt8UX44CVHjr
✅ Deploy Preview for deluxe-empanada-3ebf3b ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Rename Utilities to Integrations, correct the catalog and auth data from oiq-resources, add the Management, Settings, and Triggers surfaces, drop the lessons endpoints that aren't surfaced in the product, and fix the alert and SIEM security rule AI Analysis sections. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016YV5STTjgrMt8UX44CVHjr
|
All 13 review comments addressed and pushed in c529e1b — replied on each thread with what changed. Two items from the separate feedback: 1. The pages that were missed — done in this push.
2. The duplicate
I didn't delete them because it isn't a cleanup:
So it's a migration with a decision behind it: which tree survives, and where the AI Agent chat content lands. Happy to do it as a follow-up PR once you say which way — the mechanical part (repoint links, add redirects, delete) is straightforward. I've written the constraint into Generated by Claude Code |
I think we should have a follow up task to do a cleanup(more of a refactor). The rest of the AI related info should live only in OrionIQ section like it does in the product. |
…cation history Document the Agent Definition fields including Agent tools, correct the "AI Agent chat history" claim to the agent's invocation history, and add the configurable AI Analysis agent (integrations, tools, daily cap) to the alert and security rule pages. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016YV5STTjgrMt8UX44CVHjr
|
Second round addressed and pushed in 3d55bcd — replied on all four threads.
On the refactorAgreed, and thanks for making the call — that's a much better target than "delete the duplicates". I've written the direction into
Keeping it out of this PR as you suggested. Rough shape when we pick it up, so it's estimable:
The one dependency worth flagging: step 1 needs the OrionIQ chat page that doesn't exist yet — still the open gap in Generated by Claude Code |
OrionIQ docs sync over 3 months of commit history (2026-05-27 → 2026-08-27) across
Artemis,OIQ-AI-service, andgaia-hermes-ws.oiq-resourceswas read at HEAD as the source of truth for catalog data (integration categories, auth methods, marketplace templates), not scanned for history.Public API endpoints documented (
/v2,x-api-token)POST /v2/ai-agent/:agentId— run an agentGET /v2/ai-agent/:agentId/:sessionId— poll run statusPOST /v2/ai-agent/:agentId/:sessionId— follow-upPOST /v2/ai-agent/:agentId/enable·/disablePOST /v2/ai-agent/:agentId/feedback— newcommentfield (ORIONIQ-1011)GET /v2/ai-agent/:agentId/feedback/:sessionId— new (ORIONIQ-1011)Lessons (
GET .../lessons,PUT .../lessons/:lessonId/status) are live inpublic.routes.tsbut have no UI in the product, so they're not documented — recorded inagents.mdto document when the UI lands.Doc paths
docs/user-guide/orioniq/api.mddocs/user-guide/orioniq/memory.mddocs/user-guide/orioniq/settings.mddocs/user-guide/orioniq/integrations.mdutilities.md; real 16 categories and auth methods fromoiq-resources; Catalog + Management tabs; Logz.io API scopes (ORIONIQ-1222)docs/user-guide/orioniq/agents-hub.mddocs/user-guide/orioniq/create-agent.mddocs/user-guide/orioniq/usage-performance.mddocs/user-guide/orioniq/index.mddocs/open360/settings/ai-settings.mddocs/open360/alerts/configure-alerts-explore.md+docs/user-guide/explore/explore-log-alerts/configure-alerts-explore.mddocs/user-guide/cloud-siem/security-rules/manage-security-rules.mdstatic/_redirectsutilities/→integrations/agents.mdyarn buildpasses (onBrokenLinks: 'throw'); all cross-page anchors verified in the build output.Still not documented — recorded in
agents.md: