abdurahimov_dev/trustme
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: endpoint develop rules made

Browse Source
This commit is contained in:
Fazliddin Abdurahimov
2025-08-06 17:32:07 +05:00
parent ab9dd2ec9c
commit d57e3b8bf0
1 changed files with 4 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/ENDPOINTS.md
View File

@@ -11,11 +11,14 @@ This document provides a categorized and role-specific overview of all API endpo
> Status Legend:
>
> * `ok` — Fully implemented and tested
> * `done` - Fully implemented and Tested
> * `ok` — Implemented but not tested
> * `partial` — Implemented but incomplete or unstable
> * `TODO` — Needs implementation
> * `not ok` — Implemented but incorrect or buggy
Testers will write `done`, `not ok` and developers will define status that is not tested or something like that, so developers can write code with no communication and fully peace.
---
## 🔑 Auth & Users
@@ -43,25 +46,16 @@ This document provides a categorized and role-specific overview of all API endpo
#### 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
* filters: `folder`, `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
---
@@ -69,15 +63,10 @@ This document provides a categorized and role-specific overview of all API endpo
## 💳 Company Accounts
* `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
* required: `phone`, `code`
@@ -97,17 +86,11 @@ This document provides a categorized and role-specific overview of all API endpo
## 📍 Contracts
* `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
---
@@ -115,23 +98,14 @@ This document provides a categorized and role-specific overview of all API endpo
## 📄 Contract Owners
* `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
* `POST /contract-owners/<uuid:pk>/files` — user — not ok
* `GET /contract-owners/<uuid:pk>/files` — user — not ok
* `DELETE /contract-owners/<uuid:pk>/files/<uuid:pk>` — user — ok
* `POST /contract-owners/<uuid:pk>/files/<uuid:pk>/upload` — user — ok
---
@@ -149,15 +123,10 @@ This document provides a categorized and role-specific overview of all API endpo
## 📁 Folders
* `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
---