This collection contains all endpoints for the Code A2Z platform, a collaborative blogging and project-sharing platform. It provides APIs to manage users, projects, notifications, likes, comments, collections, and collaborations.
\nThe APIs are organized into folders based on feature domains:
\nEndpoints for user search, profile fetching, and profile updates.
\nSearch users by username.
\nFetch a user profile by username.
\nUpdate authenticated user’s profile details and profile image.
\nEndpoints to create, fetch, update, delete, and manage projects.
\nCreate, edit, and delete projects.
\nFetch all projects, trending projects, search projects, or user-written projects.
\nPaginate and filter projects with counts.
\nEndpoints to handle user notifications.
\nFetch notifications (with pagination and filters).
\nCheck if new notifications are available.
\nGet total notifications count.
\nMarks notifications as seen when fetched.
\nEndpoints to like or unlike a project and check like status.
\nLike or unlike a project.
\nCheck if a project is liked by the authenticated user.
\nEndpoints to add, fetch, delete, and reply to comments on projects.
\nAdd comments or replies.
\nFetch comments with pagination.
\nFetch replies of a comment.
\nDelete a comment along with its replies (if authorized).
\nEndpoints to manage user project collections.
\nCreate or delete collections.
\nSave projects to a collection or remove them.
\nFetch projects of a collection and sort them by likes, newest, or oldest.
\nEndpoints to manage project collaboration.
\nInvite a user to collaborate on a project.
\nAccept or reject collaboration invitations using a secure token.
\nFetch the list of collaborators for a project (project author only).
\nNotes:
\nAll endpoints requiring authentication need a valid user token.
\nEndpoints follow RESTful standards with proper HTTP methods for GET, POST, PATCH, and DELETE.
\nResponses are standardized with status, message, and data.
Sensitive user information (like passwords) is never exposed.
\nPagination, filtering, and sorting are implemented wherever applicable for efficient data handling.
\nThis folder contains endpoints used to monitor the overall system health and database connectivity.
\nThese APIs help in regularly pinging the server and database to ensure optimal performance and prevent latency issues.
\nEndpoints:
\n/monitor/health – Checks the server’s health status and confirms if the API is responsive.
/monitor/db-status – Verifies the database connection status and ensures it’s active.
This folder contains all endpoints related to user authentication and account management.
\nIt handles secure user registration, login, token management, password changes, and logout.
\nEndpoints:
\n/signup (POST) – Register a new user account.
/login (POST) – Authenticate a user and issue access and refresh tokens.
/refresh (POST) – Refresh the access token using a valid refresh token.
/logout (POST) – Log out the user by clearing authentication cookies.
/change-password (PATCH) – Change the user’s password (requires authentication).
Notes:
\nTokens are stored in secure, HTTP-only cookies to prevent XSS attacks.
\nAccess tokens are short-lived (~15 min) for security.
\nRefresh tokens are long-lived (~7 days) and used to obtain new access tokens.
\nThis folder manages newsletter subscriptions and subscriber data.
\nIt allows users to subscribe, unsubscribe, and admins to fetch all active subscribers.
\nEndpoints:
\n/subscribe (POST) – Add a new subscriber to the newsletter.
/unsubscribe (PATCH) – Unsubscribe a logged-in user from the newsletter.
/all (GET) – Retrieve all active subscribers (requires authentication).
Notes:
\nOnly authenticated users can unsubscribe or fetch subscriber lists.
\nEmail validation is applied to ensure correct input.
\nisSubscribed flag tracks subscription status.
This folder contains endpoints related to media uploads.
\nEndpoints:
\n/upload-image (POST) – Upload an image file to the server.
Requires the user to be authenticated.
\nUses multipart/form-data to send the image.
Notes:
\nOnly logged-in users can upload images.
\nFile uploads are handled securely with middleware to prevent unauthorized access.
\nThis folder contains endpoints related to user search, profile fetching, and profile updates.
\nEndpoints:
\n/search (GET) – Search users by username.
Accepts a query parameter q.
Returns a list of up to 50 users with fullname, username, and profile_img.
/profile (GET) – Fetch a single user’s profile by username.
Accepts a query parameter username.
Returns user details excluding sensitive info like password, projects, or collaborations.
\nThe email is returned as a plain string, populated from the subscribers collection.
\n/update-profile-img (PATCH) – Update the authenticated user’s profile image.
Requires authentication.
\nAccepts url of the new profile image.
/update-profile (PATCH) – Update the authenticated user’s profile details.
Requires authentication.
\nCan update username, bio, and social_links.
Validates username length, bio length, and social link formats.
\nNotes:
\nAuthentication is required for updating profile data.
\nEndpoints are designed to prevent exposing sensitive information.
\nAll read operations use GET with query parameters to follow RESTful standards.
\nThis folder contains endpoints related to project creation, fetching, searching, and management.
\nEndpoints:
\n/create (POST) – Create or update a project (draft or published).
Requires authentication.
\nValidates title, description, banner, repository, tags, and content before publishing.
If id is provided, updates the existing project instead of creating a new one.
/all (GET) – Fetch all published projects.
Supports pagination using the page query parameter.
Returns project details such as title, description, banner, tags, author, and publishedAt.
/trending (GET) – Fetch top 5 trending projects.
Sorts projects based on total_reads, total_likes, and publishedAt.
Returns limited metadata for better performance.
\n/search (GET) – Search projects by tag, author, or text query.
Accepts query parameters tag, author, q, page, and limit.
Excludes drafts and supports pagination for efficient results.
\n/total-count (GET) – Get total count of all published projects.
/search-count (GET) – Get total count of projects matching search filters.
Accepts the same query parameters as /search.
Useful for pagination in search results.
\n/:project_id (GET) – Fetch a single project by its unique ID.
Public projects are accessible to anyone.
\nDraft projects are only accessible in edit mode by the author.
\nAutomatically increments project read count for public views.
\n/user (GET) – Fetch projects authored by the authenticated user.
Requires authentication.
\nSupports pagination and filtering using draft and query parameters.
/user/count (GET) – Get total count of projects authored by the authenticated user.
Requires authentication.
\nSupports filtering by draft and query parameters.
/delete (DELETE) – Delete a project permanently.
Requires authentication.
\nDeletes the project and all associated notifications and comments.
\nAutomatically updates the user’s project count.
\nNotes:
\nAuthentication is required for creating, updating, and deleting projects.
\nPublic endpoints like /all, /trending, and /search are accessible without authentication.
Pagination is implemented to optimize response performance.
\nAll read operations use GET and follow RESTful standards.
\nThis folder contains endpoints related to liking/unliking projects and checking the like status for the authenticated user.
\nEndpoints:
\n/ (PATCH) – Like or unlike a project.
Requires authentication.
\nAccepts _id (project ID) and islikedByUser (boolean) in the request body.
Toggles the like status for the project.
\nCreates or deletes a corresponding like notification for the project author.
\nReturns liked_by_user flag indicating the current like state.
/ (GET) – Check if the authenticated user has liked a specific project.
Requires authentication.
\nAccepts _id (project ID) as a query parameter.
Returns isLiked boolean indicating if the user has liked the project.
Notes:
\nAuthentication is required for both endpoints.
\nDesigned to ensure real-time like toggling and accurate like status retrieval.
\nEndpoints follow RESTful standards, using PATCH for updates and GET for fetching status.
\nThis folder contains endpoints for adding, fetching, replying, and deleting comments on projects.
\nEndpoints:
\n/ (POST) – Add a new comment or reply to a project.
Requires authentication.
\nAccepts _id (project ID), comment, and optional replying_to (parent comment ID) in the request body.
Creates a new comment or reply and triggers a corresponding notification.
\nReturns the newly created comment data including _id, comment, createdAt, user_id, and children.
/ (GET) – Fetch comments for a project.
Accepts project_id as a query parameter and optional skip for pagination.
Returns a list of parent comments (non-replies) along with commenter details (username, fullname, profile_img).
/replies (GET) – Fetch replies for a specific comment.
Accepts _id (comment ID) and optional skip for pagination.
Returns a list of replies with commenter details.
\n/:comment_id (DELETE) – Delete a comment or reply.
Requires authentication.
\nOnly the comment author or the project author can delete.
\nRemoves the comment/reply, updates parent comment/project counters, and deletes related notifications.
\nReturns a success message upon deletion.
\nNotes:
\nAuthentication is required for adding and deleting comments.
\nEndpoints are designed to maintain project activity counts and handle nested replies.
\nGET endpoints follow RESTful standards with query parameters for filtering and pagination.
\nThis folder contains endpoints related to fetching and managing notifications for the authenticated user.
\nEndpoints:
\n/status (GET) – Check if there are any new/unseen notifications.
new_notification_available./ (GET) – Fetch paginated notifications for the authenticated user.
Accepts query parameters: page, filter (all, like, comment, reply), and deletedDocCount.
Populates project, user, comment, reply, and replied_on_comment details.
\nAutomatically marks the fetched notifications as seen.
\nReturns a list of notifications including type, seen status, and relevant references.
\n/count (GET) – Get the total count of notifications for the authenticated user.
Accepts a query parameter filter to count by type (all, like, comment, reply).
Returns totalDocs.
Notes:
\nAuthentication is required for all endpoints.
\nUsers do not see notifications generated by themselves (user: { $ne: user_id } logic is applied).
All endpoints use GET with query parameters to follow RESTful standards.
\nDesigned to ensure efficient fetching, pagination, and accurate seen/unseen status.
\nThis folder contains endpoints related to user project collections, including creating collections, saving/removing projects, sorting projects within a collection, and deleting collections.
\nEndpoints:
\n/ (POST) – Create a new collection for the authenticated user.
Requires authentication.
\nAccepts collection_name.
Returns the newly created collection details.
\nPrevents creating collections with duplicate names for the same user.
\n/save-project (POST) – Save a project to a collection.
Requires authentication.
\nAccepts collection_id and project_id.
Validates that both the collection and project exist.
\nPrevents duplicate projects within the same collection.
\n/sort-projects (GET) – Fetch projects from a collection sorted by criteria.
Requires authentication.
\nAccepts query parameters collection_id and sortBy (likes, newest, oldest).
Returns projects with author details.
\nReturns a message if the collection has no projects.
\n/remove-project (PATCH) – Remove a project from a collection.
Requires authentication.
\nAccepts collection_id and project_id.
Returns success if project is removed or error if project not found in the collection.
\n/ (DELETE) – Delete an entire collection.
Requires authentication.
\nAccepts collection_name.
Deletes the collection for the authenticated user.
\nReturns error if the collection is not found.
\nNotes:
\nAll endpoints require authentication, except GET requests, which require the user ID context from authentication.
\nProjects are referenced via their _id and validated before operations.
Collection names are case-insensitive and unique per user.
\nSorting of projects is supported to facilitate organized display within collections.
\nThis folder contains endpoints related to project collaboration management, including sending collaboration invitations, accepting/rejecting invitations, and fetching collaborators for a project.
\nEndpoints:
\n/invite (POST) – Send a collaboration invitation to a project author.
Requires authentication.
\nAccepts project_id in the request body.
Sends an email invitation to the project author and creates a pending collaboration record in the database.
\n/accept/:token (POST) – Accept a collaboration invitation.
Requires authentication.
\nAccepts token as a route parameter.
Marks the collaboration request as accepted and invalidates the token.
\n/reject/:token (POST) – Reject a collaboration invitation.
Requires authentication.
\nAccepts token as a route parameter.
Marks the collaboration request as rejected and invalidates the token.
\n/list/:project_id (GET) – Fetch the list of collaborators for a project.
Requires authentication.
\nAccepts project_id as a route parameter.
Returns all collaborators where the authenticated user is the project author.
\nNotes:
\nOnly authenticated users can send, accept, or reject collaboration invitations.
\nTokens are invalidated after accepting or rejecting an invitation to prevent reuse.
\nFetching collaborators is restricted to the project author to ensure privacy.
\n