diff --git a/README.MD b/README.MD index 6319944..ff1232b 100644 --- a/README.MD +++ b/README.MD @@ -1,155 +1,18 @@ +# Trustme -endpoints from models shoule be realized: +Trustme is a clean and purpose-built API-only application. It follows best practices for clarity and scalability, while minimizing surface complexity. -accounts: - users +This application does not include a frontend or UI layer — it is purely an API backend built to power external systems or interfaces. -banks: - banks +## 📚 Documentation -companies: - companies - company-accounts - company-folders +To make development fast and debugging effortless, this project maintains two documentation files: -contracts: - contracts - contract-owners - contract-attached-files - contract-file-contents +* [`./docs/ENDPOINTS.md`](./docs/ENDPOINTS.md) — a list of implemented endpoints and their intended usage +* [`./docs/COMMENTS.md`](./docs/COMMENTS.md) — a standard format for documenting views to quickly identify failing or related API routes -individuals # contract-owner-part -legal-entities # contract-owner-part +These are meant to be readable, searchable, and helpful directly from the code editor or terminal. +--- -Endpoints should be created: - - -# admin - endpoint is only for admins -# user - endpoint can be used by regular users with given -# credentials - - -================================================================== - - -users: - -POST /auth/register # user # remake -POST /auth/verify # user # ok -GET /auth/me # user # ok - -GET /me/companies # user # ok -POST /me/companies # user # ok - -GET /users//companies # user # ok -POST /users//companies # user # ok - - -================================================================== - - -companies: -GET /companies # admin # ok -POST /companies # admin # ok -GET /companies/ # admin # ok -DELETE /companies/ # admin # ok -PATCH /companies/ # admin # ok - -GET /companies//contracts # user # partial -- - folder: uuid | None -- - status: list[str] - -GET /companies//folders # user # ok -POST /companies//folders # user # ok - -GET /companies//accounts # user # ok -POST /companies//accounts # user #! TODO - - -================================================================== - - -GET /company-accounts # admin # ok -POST /company-accounts # admin # ok -GET /company-accounts/ # admin # ok -PATCH /company-accounts/ # admin # ok -DELETE /company-accounts/ # admin # ok - -POST /accounts/verify # user #! TODO -- - phone -- - code - - -================================================================== - - -GET /banks # admin # ok -POST /banks # admin # ok -GET /banks/ # admin # ok -DELETE /banks/ # admin # ok -PATCH /banks/ # admin # ok - - -================================================================== - - -GET /contracts # admin # ok -POST /contracts # user # ok -GET /contracts/ # admin # ok -DELETE /contracts/ # admin # ok -PATCH /contracts/ # admin # ok - -GET /contracts//files # user # ok - -GET /contracts//owners # user # ok - - -================================================================== - - -GET /contract-owners # admin # ok -POST /contract-owners # admin # ok -GET /contract-owners/ # admin # ok -DELETE /contract-owners/ # admin # ok -PATCH /contract-owners/ # admin # ok - -GET /contract-owners//contract # user # ok | full contract data return - -POST /contract-owners//files # user #! not ok -GET /contract-owners//files # user #! not ok | full data return -DELETE /contract-owners//files/ # user # ok - -POST /contract-owners//files//upload # user # ok - - -================================================================== - - -GET /files # admin # ok -POST /files # admin # ok -GET /files/ # admin # ok -DELETE /files/ # admin # ok -PATCH /files/ # admin # ok - - -================================================================== - - -GET /folders # admin # ok -POST /folders # admin # ok -GET /folders/ # admin # ok -DELETE /folders/ # admin # ok -PATCH /folders/ # admin # ok - -GET /folders//contracts # admin # ok - - -================================================================== - - -GET /file-contents # admin # ok -POST /file-contents # admin # ok -GET /file-contents/ # admin # ok -DELETE /file-contents/ # admin # ok -PATCH /file-contents/ # admin # ok +Feel free to explore or extend the codebase. The documentation files are the best place to start.