From d57e3b8bf02522b3a6328dc1d1bf869faf3cb0a3 Mon Sep 17 00:00:00 2001 From: Fazliddin Abdurahimov Date: Wed, 6 Aug 2025 17:32:07 +0500 Subject: [PATCH] fix: endpoint develop rules made --- docs/ENDPOINTS.md | 39 ++++----------------------------------- 1 file changed, 4 insertions(+), 35 deletions(-) diff --git a/docs/ENDPOINTS.md b/docs/ENDPOINTS.md index 3e24f6d..8545674 100644 --- a/docs/ENDPOINTS.md +++ b/docs/ENDPOINTS.md @@ -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/` — admin — ok - * `DELETE /companies/` — admin — ok - * `PATCH /companies/` — admin — ok - * `GET /companies//contracts` — user — partial * filters: `folder`, `status: list[str]` - * `GET /companies//folders` — user — ok - * `POST /companies//folders` — user — ok - * `GET /companies//accounts` — user — ok - * `POST /companies//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/` — admin — ok - * `PATCH /company-accounts/` — admin — ok - * `DELETE /company-accounts/` — 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/` — admin — ok - * `DELETE /contracts/` — admin — ok - * `PATCH /contracts/` — admin — ok - * `GET /contracts//files` — user — ok - * `GET /contracts//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/` — admin — ok - * `DELETE /contract-owners/` — admin — ok - * `PATCH /contract-owners/` — admin — ok - * `GET /contract-owners//contract` — user — ok - * `POST /contract-owners//files` — user — not ok - * `GET /contract-owners//files` — user — not ok - * `DELETE /contract-owners//files/` — user — ok - * `POST /contract-owners//files//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/` — admin — ok - * `DELETE /folders/` — admin — ok - * `PATCH /folders/` — admin — ok - * `GET /folders//contracts` — admin — ok ---