docs: add postman environment #77
Conversation
kshitij-k-osmosys
added
documentation
WalkthroughThe Postman collection was updated to use a configurable Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Postman
participant API
User->>Postman: Selects "Transcript Summarization" environment
User->>Postman: Sends API request (uses {{base_url}} and auth-token)
Postman->>API: Makes request to {{base_url}}/graphql with Bearer token
API-->>Postman: Returns response
Postman-->>User: Displays API response
Possibly related PRs
Suggested reviewers
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
apps/api/Transcript Summarization.postman_environment.json (2)
6-10: Add variable descriptions for clarity.
Consider adding a"description"field to theauth-tokenentry (e.g., “Replace with your Microsoftaccess_tokenfrom the Portal login response”) to guide users when replacing the placeholder.
12-15: Add variable descriptions and examples.
Forbase_url, include a"description"(e.g., “Base URL of the Transcript Summarization API, e.g.,https://api.example.com”) so users know what value to supply.apps/api/docs/usage-guide.md (1)
86-89: Include Postman Environment link and refine its path.
Great addition of the environment file link. For consistency with the collection link, simplify the relative path:- - [Postman Environment](./../Transcript%20Summarization.postman_environment.json) + - [Postman Environment](../Transcript%20Summarization.postman_environment.json)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
apps/api/Transcript Summarization.postman_collection.json(5 hunks)apps/api/Transcript Summarization.postman_environment.json(1 hunks)apps/api/docs/usage-guide.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Build
- GitHub Check: build
🔇 Additional comments (8)
apps/api/Transcript Summarization.postman_environment.json (2)
1-4: Environment file structure is valid.
The JSON schema,id,name, and scope fields align with Postman's export format.
18-21: Export metadata is correct.
The_postman_exported_attimestamp and Postman version reflect a recent export.apps/api/Transcript Summarization.postman_collection.json (5)
95-98: Templatized base_url in File Upload — Success.
The hardcoded endpoint is correctly replaced with{{base_url}}/graphqlin bothrawandhost.
187-190: Templatized base_url in File Upload — No Attachments.
Consistent use of the environment variable ensures users can configure their API endpoint dynamically.
267-270: Templatized base_url in Fetch All Summaries — Success.
Bothrawandhostnow correctly reference{{base_url}}/graphql.
334-337: Templatized base_url in Fetch All Summaries — Unauthorized.
The change aligns with the new Postman environment variables.
401-404: Templatized base_url in Fetch All Summaries — Bad Request.
All instances of the fixed URL have been replaced, ensuring full collection consistency.apps/api/docs/usage-guide.md (1)
76-79: Clarified DevTools instructions for token retrieval.
The added steps to open browser developer tools and navigate to the Network tab will help users locate and extract theaccess_tokenmore reliably.
API PR Checklist
Task Link
Osmosys Developers must include the Pinestem task link in the PR.
REST-1563
Pre-requisites
PR Details
PR details have been updated as per the given format (see below)
feat: add admin login endpoint)Additional Information
ready for reviewshould be added if the PR is ready to be reviewed)Description:
Add postman environment
Documentation changes:
Update usage guide with clearer steps to extract auth token
Summary by CodeRabbit
Chores
Documentation