Updated Team Management API docs in Users and Authentication#191
Merged
Conversation
- Add GET /v1/user/team (Get Team) - Add POST /v1/user/team (Create Workspace) - Add PATCH /v1/user/team (Update Team) - Add DELETE /v1/user/team (Delete Team) - Add GET /v1/user/team/member (Get Team Members) - Add POST /v1/user/team/member (Add Team Member) - Add PATCH /v1/user/team/member (Update Team Member) - Add DELETE /v1/user/team/member (Delete Team Member) Fixes broken API reference pages for internal team operations
…oints Manually enhanced all 8 internal API endpoint pages with: Team Management Endpoints: - get-team.mdx: Added use cases, response info, and best practices - create-workspace.mdx: Added creation workflow, naming conventions, and warnings - update-team.mdx: Added update guidelines, limitations, and best practices - delete-team.mdx: Added critical warnings, prerequisites, and recommended workflow Team Member Management Endpoints: - get-team-members.mdx: Added member status info, auditing guidelines - add-team-member.mdx: Added role descriptions, invitation process, and scenarios - update-team-member.mdx: Added role transition examples and permission impacts - delete-team-member.mdx: Added security scenarios, workflows, and alternatives Each page now includes: ✅ Detailed descriptions and context ✅ Practical use cases ✅ Important notes and warnings ✅ Best practices and recommendations ✅ Step-by-step workflows ✅ Common scenarios and examples ✅ Security considerations
Removed verbose sections to make documentation more concise: Team Management: - get-team.mdx: Removed Use Cases section - create-workspace.mdx: Removed Use Cases section - update-team.mdx: Removed Use Cases, What This Endpoint Does NOT Do, and Best Practices sections - delete-team.mdx: Renamed Prerequisites to Disclaimer, removed team member requirement, removed Recommended Workflow and Alternative Options sections Team Member Management: - get-team-members.mdx: Removed Best Practices section - add-team-member.mdx: Removed Invitation Process section - update-team-member.mdx: Removed Temporary Elevation from use cases, removed What You Can Update, Role Transition Examples, Best Practices, and Common Use Cases sections - delete-team-member.mdx: Removed Recommended Workflow, Security Scenarios, and Alternative Options sections Documentation now focuses on essential information with cleaner, more focused content.
- add-team-member.mdx: Removed Common Scenarios section - create-workspace.mdx: Removed Best Practices section - delete-team.mdx: Removed 'Before deleting a team:' line from Disclaimer Documentation now even more concise and focused.
shivankar-singh
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.