Skip to content

fix: updated README to align with sdk#33

Open
rsharath wants to merge 4 commits intomainfrom
fix
Open

fix: updated README to align with sdk#33
rsharath wants to merge 4 commits intomainfrom
fix

Conversation

@rsharath
Copy link
Copy Markdown
Contributor

Summary

Updated to align with SDK changes

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Chore (refactoring code, technical debt, workflow improvements)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactor (does not change functionality, e.g. code style improvements, linting)
  • This change requires a documentation update

Testing

  • Manually tested
  • Unit tests added/updated
  • No tests required

Impact / Risks


📸 Screenshots / Logs (if applicable)


@rsharath rsharath requested review from KunalJavelin and saucam March 27, 2026 01:20
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the documentation to reflect SDK changes, specifically promoting the new session() and session_from_request() methods for token verification and introspection. It updates Python and TypeScript examples to use these helpers and simplifies token management in the provided scenarios. Additionally, it fixes typos and updates the feature roadmap. Feedback was provided regarding the removal of cURL examples, noting that they are valuable for users not using the SDKs and should be retained.

I am having trouble creating individual review comments. Click here to see my feedback.

README.md (364-395)

medium

The cURL examples provided a useful reference for interacting with the API endpoints directly, without using an SDK. While the PR's goal is to align with SDK changes, completely removing these examples might make it harder for users who are not using the Python or TypeScript SDKs, or for debugging purposes. Consider keeping the cURL examples, perhaps within a collapsed

Details tag, to ensure the documentation remains comprehensive for all users. Additionally, ensure that tenant-specific headers (e.g., X-Account-ID, X-Project-ID) are not presented as mandatory in these examples, as they are specific to certain deployments and not part of the core functionality.

References
  1. Tenant-specific headers (e.g., X-Account-ID, X-Project-ID) should not be mandatory for API calls as they are specific to certain deployments and not part of the core functionality.

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.

1 participant