Vicharak is a collaborative platform that allows users to create, manage, and share thoughts or ideas (Vichars) while controlling access through a role-based permission system. It enables multiple users to collaborate on a Vichar with predefined roles and permissions.
Postman collection for Vicharak API is available below:
Here’s a structured documentation for all the entities in the system:
Users are the primary entity in the system. They can create Vichars, manage collaborations, and perform actions based on their assigned roles.
✅ Users can Create, Read, Update, and Delete (CRUD) their own profile.
✅ Users can create Vichars.
✅ Users can be added as collaborators to a Vichar with a specific role.
Roles define a set of permissions that can be assigned to users when they collaborate on a Vichar.
name(string) - The name of the role (e.g., Editor, Viewer).permissions(list) - A list of permissions granted to this role.
| Permission | Description |
|---|---|
VIEW_VICHAR |
Allows viewing a Vichar |
EDIT_VICHAR |
Allows editing a Vichar |
DELETE_VICHAR |
Allows deleting a Vichar |
ADD_COLLABORATOR |
Allows adding collaborators |
REMOVE_COLLABORATOR |
Allows removing collaborators |
VIEW_COLLABORATORS |
Allows viewing the list of collaborators |
✅ Only staff users can create or manage roles.
A Vichar represents a thought or idea created by a user.
user(ForeignKey to User) - The creator of the Vichar.title(string) - Title of the Vichar.body(text) - The content of the Vichar.created_at(datetime) - Timestamp when the Vichar was created.updated_at(datetime) - Timestamp when the Vichar was last updated.deleted_at(datetime, nullable) - If deleted, stores the deletion timestamp (soft delete).
✅ The owner of a Vichar can perform CRUD operations.
✅ Collaborators can perform actions based on their assigned role permissions.
❌ Unauthorized users cannot access private Vichars.
- Soft Delete: When a Vichar is deleted, it is not permanently removed but marked as
deleted_at = timestamp. - Restore Soft Deleted Vichar: Users with delete permissions can restore soft-deleted Vichars.
- Permanent Delete: Users with DELETE_VICHAR permission can permanently remove a Vichar from the system.
| Action | Description | Access Control |
|---|---|---|
| Soft Delete | Marks deleted_at timestamp without removing the Vichar |
Owner or collaborator with DELETE_VICHAR permission |
| List Deleted Vichars | Fetches all soft-deleted Vichars | Owner or staff |
| Restore Vichar | Restores a soft-deleted Vichar by setting deleted_at = None |
Owner or collaborator with DELETE_VICHAR permission |
| Permanent Delete | Completely removes the Vichar from the database | Owner or collaborator with DELETE_VICHAR permission |
Collaborators are users who are invited to work on a Vichar with a specific role.
vichar(ForeignKey to Vichar) - The Vichar the user is collaborating on.owner(ForeignKey to User) - The user who owns the Vichar.collaborator(ForeignKey to User) - The user being added as a collaborator.role(ForeignKey to Role) - The assigned role of the collaborator.created_at(datetime) - Timestamp when the collaborator was added.
✅ Only the Vichar owner can add or remove collaborators.
✅ Collaborators can perform actions based on the role assigned to them.
| Action | Description | Access Control |
|---|---|---|
| Add Collaborator | Owner can add a user as a collaborator | Owner or authorized collaborator |
| Update Collaborator | Owner can update a collaborator’s role | Owner or authorized collaborator |
| Remove Collaborator | Owner or user with REMOVE_COLLABORATOR permission |
Owner or authorized collaborator |
- A User can create multiple Vichars.
- A Vichar can have multiple Collaborators.
- A Collaborator has a Role, which defines their permissions.
- Only Staff Users can manage roles.