Skip to content

feat(DI-1787): update quickstart and api integration#313

Merged
aotella merged 1 commit intomainfrom
feat/DI-1787
Jul 22, 2025
Merged

feat(DI-1787): update quickstart and api integration#313
aotella merged 1 commit intomainfrom
feat/DI-1787

Conversation

@aotella
Copy link
Copy Markdown
Contributor

@aotella aotella commented Jul 22, 2025

This commit updates the documentation for the Insights product to align with the new v3 API. The quickstart and API integration guides have been overhauled to reflect the new endpoints and workflow.

Key changes:

  • API endpoints have been updated to v3. This includes:
    • POST /v3/fiData (from /v2/fiData)
    • POST /v3/insight (from /v2/insight)
    • GET /v3/insight (from /v1/insight)
    • POST /v3/template (from /v2/template)
    • POST /v3/purge (from /v2/purge)
  • The insight generation process is now documented as a two-step asynchronous flow: first triggering the generation, then polling for the result.
  • All request and response examples have been updated to match the v3 API schemas.
  • The description of refId and the data ingestion process have been clarified.

@aotella aotella self-assigned this Jul 22, 2025
@github-actions
Copy link
Copy Markdown

github-actions bot commented Jul 22, 2025

Checklist to merge a PR 🚀

To merge this pull request, please take time to complete the checklist.

What action did you perform?

Review the corresponding checklist items for the action you performed and mark them done.

Edit an existing content (MDX) page

Checklist

  • Review changes using the MDX preview option
  • If the length of content >15000 chars, use the Content preview portal to view changes
  • If a redirect is needed to the existing page, add a key, value pair in redirects.json

Edit an existing API reference page

Checklist


Add a new content (MDX) page

Checklist

  • Create a .mdx file with the path as its name in the content folder
  • Add frontmatter with all the metadata
  • Review the order of items in Sidebar using the Sidebar preview option
  • Review changes using the MDX preview option
  • If the length of content >15000 chars, use the Content preview portal to view changes
  • Created a folder with the same name, if any children were to be added to the page
  • Once all changes are done, update the menu items by using the Menu Items option
  • Add a key, and value pair in redirects.json if you wish to have a redirect to the new page

Add a new API reference page

Checklist

  • Create a .json file with the product path as its name
  • Create an api-reference.mdx file in the respective product folder inside content folder
  • Add frontmatter with all the metadata
  • Review the order of items in Sidebar using the Sidebar preview option
  • Add API reference in JSON format (OpenAPI or Swagger) into created .json file.
  • Used the Content preview portal to view changes
  • Once all changes are done, update the menu items by using the Menu Items option

@aotella aotella merged commit 27978f9 into main Jul 22, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants