Skip to content

Conversation

@nerpaula
Copy link
Contributor

@nerpaula nerpaula commented Nov 27, 2025

Description

Upstream PRs

  • 3.10:
  • 3.11:
  • 3.12:
  • 4.0:

Note

Clarifies Graph Analytics docs with explicit AI Data Platform vs AMP URL structures, authentication guidance, and standardized cURL examples across Management and Engine APIs.

  • Docs (Graph Analytics)
    • URL structures:
      • Clarify and standardize endpoints for AI service, Management API, and Engine API with explicit paths (e.g., https://<EXTERNAL_ENDPOINT>:8529/gral/<SERVICE_ID>/v1/…, https://<APPLICATION_ENDPOINT>:8829/graph-analytics/api/graphanalytics/v1/…).
    • Per-platform organization:
      • Add tabs splitting instructions/examples for AI Data Platform vs AMP across all operations.
    • Authentication:
      • Detail token acquisition and usage (oasisctl login, JWT session tokens), with bearer header examples and verification calls.
    • AI service / Management:
      • Add cURL examples to start/list/stop graphanalytics services and list/deploy/get/delete engines; include placeholder values and info callouts.
    • Engine API:
      • Provide per-platform examples for loaddata, algorithms (pagerank, wcc, scc, betweennesscentrality, linerank), and results management.
      • Add examples for storeresults, job lifecycle (/v1/jobs list/get/delete), and graph lifecycle (/v1/graphs list/get/delete).
    • Usability:
      • Introduce variables (EXTERNAL_ENDPOINT, SERVICE_ID, APPLICATION_ENDPOINT, ENGINE_ID) and tips to simplify requests; add info/tip blocks and sample responses.

Written by Cursor Bugbot for commit 445eea5. This will update automatically on new commits. Configure here.

@arangodb-docs-automation
Copy link
Contributor

Deploy Preview Available Via
https://deploy-preview-841--docs-hugo.netlify.app

@cla-bot cla-bot bot added the cla-signed label Nov 27, 2025
@nerpaula nerpaula self-assigned this Nov 27, 2025
@nerpaula nerpaula marked this pull request as ready for review December 10, 2025 14:55
@nerpaula nerpaula requested a review from Simran-B December 10, 2025 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants