Conversation
There was a problem hiding this comment.
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)
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
- 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.
Summary
Updated to align with SDK changes
Type of change
Testing
Impact / Risks
📸 Screenshots / Logs (if applicable)