fix: README.MD cleaned
This commit is contained in:
157
README.MD
157
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:
|
This application does not include a frontend or UI layer — it is purely an API backend built to power external systems or interfaces.
|
||||||
users
|
|
||||||
|
|
||||||
banks:
|
## 📚 Documentation
|
||||||
banks
|
|
||||||
|
|
||||||
companies:
|
To make development fast and debugging effortless, this project maintains two documentation files:
|
||||||
companies
|
|
||||||
company-accounts
|
|
||||||
company-folders
|
|
||||||
|
|
||||||
contracts:
|
* [`./docs/ENDPOINTS.md`](./docs/ENDPOINTS.md) — a list of implemented endpoints and their intended usage
|
||||||
contracts
|
* [`./docs/COMMENTS.md`](./docs/COMMENTS.md) — a standard format for documenting views to quickly identify failing or related API routes
|
||||||
contract-owners
|
|
||||||
contract-attached-files
|
|
||||||
contract-file-contents
|
|
||||||
|
|
||||||
individuals # contract-owner-part
|
These are meant to be readable, searchable, and helpful directly from the code editor or terminal.
|
||||||
legal-entities # contract-owner-part
|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
Endpoints should be created:
|
Feel free to explore or extend the codebase. The documentation files are the best place to start.
|
||||||
|
|
||||||
|
|
||||||
# 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/<uuid:pk>/companies # user # ok
|
|
||||||
POST /users/<uuid:pk>/companies # user # ok
|
|
||||||
|
|
||||||
|
|
||||||
==================================================================
|
|
||||||
|
|
||||||
|
|
||||||
companies:
|
|
||||||
GET /companies # admin # ok
|
|
||||||
POST /companies # admin # ok
|
|
||||||
GET /companies/<uuid:pk> # admin # ok
|
|
||||||
DELETE /companies/<uuid:pk> # admin # ok
|
|
||||||
PATCH /companies/<uuid:pk> # admin # ok
|
|
||||||
|
|
||||||
GET /companies/<uuid:pk>/contracts # user # partial
|
|
||||||
- - folder: uuid | None
|
|
||||||
- - status: list[str]
|
|
||||||
|
|
||||||
GET /companies/<uuid:pk>/folders # user # ok
|
|
||||||
POST /companies/<uuid:pk>/folders # user # ok
|
|
||||||
|
|
||||||
GET /companies/<uuid:pk>/accounts # user # ok
|
|
||||||
POST /companies/<uuid:pk>/accounts # user #! TODO
|
|
||||||
|
|
||||||
|
|
||||||
==================================================================
|
|
||||||
|
|
||||||
|
|
||||||
GET /company-accounts # admin # ok
|
|
||||||
POST /company-accounts # admin # ok
|
|
||||||
GET /company-accounts/<uuid:pk> # admin # ok
|
|
||||||
PATCH /company-accounts/<uuid:pk> # admin # ok
|
|
||||||
DELETE /company-accounts/<uuid:pk> # admin # ok
|
|
||||||
|
|
||||||
POST /accounts/verify # user #! TODO
|
|
||||||
- - phone
|
|
||||||
- - code
|
|
||||||
|
|
||||||
|
|
||||||
==================================================================
|
|
||||||
|
|
||||||
|
|
||||||
GET /banks # admin # ok
|
|
||||||
POST /banks # admin # ok
|
|
||||||
GET /banks/<uuid:pk> # admin # ok
|
|
||||||
DELETE /banks/<uuid:pk> # admin # ok
|
|
||||||
PATCH /banks/<uuid:pk> # admin # ok
|
|
||||||
|
|
||||||
|
|
||||||
==================================================================
|
|
||||||
|
|
||||||
|
|
||||||
GET /contracts # admin # ok
|
|
||||||
POST /contracts # user # ok
|
|
||||||
GET /contracts/<uuid:pk> # admin # ok
|
|
||||||
DELETE /contracts/<uuid:pk> # admin # ok
|
|
||||||
PATCH /contracts/<uuid:pk> # admin # ok
|
|
||||||
|
|
||||||
GET /contracts/<uuid:pk>/files # user # ok
|
|
||||||
|
|
||||||
GET /contracts/<uuid:pk>/owners # user # ok
|
|
||||||
|
|
||||||
|
|
||||||
==================================================================
|
|
||||||
|
|
||||||
|
|
||||||
GET /contract-owners # admin # ok
|
|
||||||
POST /contract-owners # admin # ok
|
|
||||||
GET /contract-owners/<uuid:pk> # admin # ok
|
|
||||||
DELETE /contract-owners/<uuid:pk> # admin # ok
|
|
||||||
PATCH /contract-owners/<uuid:pk> # admin # ok
|
|
||||||
|
|
||||||
GET /contract-owners/<uuid:pk>/contract # user # ok | full contract data return
|
|
||||||
|
|
||||||
POST /contract-owners/<uuid:pk>/files # user #! not ok
|
|
||||||
GET /contract-owners/<uuid:pk>/files # user #! not ok | full data return
|
|
||||||
DELETE /contract-owners/<uuid:pk>/files/<uuid:pk> # user # ok
|
|
||||||
|
|
||||||
POST /contract-owners/<uuid:pk>/files/<uuid:pk>/upload # user # ok
|
|
||||||
|
|
||||||
|
|
||||||
==================================================================
|
|
||||||
|
|
||||||
|
|
||||||
GET /files # admin # ok
|
|
||||||
POST /files # admin # ok
|
|
||||||
GET /files/<uuid:pk> # admin # ok
|
|
||||||
DELETE /files/<uuid:pk> # admin # ok
|
|
||||||
PATCH /files/<uuid:pk> # admin # ok
|
|
||||||
|
|
||||||
|
|
||||||
==================================================================
|
|
||||||
|
|
||||||
|
|
||||||
GET /folders # admin # ok
|
|
||||||
POST /folders # admin # ok
|
|
||||||
GET /folders/<uuid:pk> # admin # ok
|
|
||||||
DELETE /folders/<uuid:pk> # admin # ok
|
|
||||||
PATCH /folders/<uuid:pk> # admin # ok
|
|
||||||
|
|
||||||
GET /folders/<uuid:pk>/contracts # admin # ok
|
|
||||||
|
|
||||||
|
|
||||||
==================================================================
|
|
||||||
|
|
||||||
|
|
||||||
GET /file-contents # admin # ok
|
|
||||||
POST /file-contents # admin # ok
|
|
||||||
GET /file-contents/<uuid:pk> # admin # ok
|
|
||||||
DELETE /file-contents/<uuid:pk> # admin # ok
|
|
||||||
PATCH /file-contents/<uuid:pk> # admin # ok
|
|
||||||
|
|||||||
Reference in New Issue
Block a user