Hashini/docs#61
Closed
Hashini-Deshappriya wants to merge 31 commits into
Closed
Conversation
Reorganize and enhance documentation for Adopters API, including purpose, architecture, security, endpoints, validation rules, error handling, and testing strategies.
…d validation and hashing to createUser
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
5 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.
Adopters API – Summary Description
The Adopters API is a core module in the TreeO2 backend that manages adopter records through a secure, role-based, and fully validated CRUD system. It supports creating, retrieving, updating, deleting, and listing adopters with pagination.
The module follows the project’s enterprise architecture pattern with clear separation of routes, controller, and service layers, using Prisma for database operations and centralized error handling for consistency.
All endpoints are protected with authentication and role-based access control, ensuring only authorised users (primarily ADMIN and MANAGER roles for read access, and ADMIN for mutations) can perform operations.
It also enforces strict validation rules for input data, standardized response structures, and comprehensive test coverage (unit and integration tests). Swagger documentation is provided for full API visibility and testing.
Overall, the Adopters API provides a secure, scalable, and maintainable implementation aligned with the TreeO2 backend engineering standards.