Update WIP.md with documentation status
This commit is contained in:
parent
104aedbcf4
commit
bf55bd3d1d
39
WIP.md
39
WIP.md
@ -6,7 +6,7 @@
|
|||||||
|----------|----------|
|
|----------|----------|
|
||||||
| **Проект** | kwork-api |
|
| **Проект** | kwork-api |
|
||||||
| **Начало** | 2026-03-23 02:16 UTC |
|
| **Начало** | 2026-03-23 02:16 UTC |
|
||||||
| **Прогресс** | 95% |
|
| **Прогресс** | 97% |
|
||||||
| **Статус** | 🟢 В работе |
|
| **Статус** | 🟢 В работе |
|
||||||
|
|
||||||
---
|
---
|
||||||
@ -18,8 +18,9 @@
|
|||||||
- [x] API клиент (KworkClient с 45 эндпоинтами)
|
- [x] API клиент (KworkClient с 45 эндпоинтами)
|
||||||
- [x] Обработка ошибок (KworkAuthError, KworkApiError, etc.)
|
- [x] Обработка ошибок (KworkAuthError, KworkApiError, etc.)
|
||||||
- [x] Тесты unit (46 тестов, 92% coverage)
|
- [x] Тесты unit (46 тестов, 92% coverage)
|
||||||
- [x] Документация (README с примерами)
|
- [x] Документация (README + docs/)
|
||||||
- [x] **Аудит эндпоинтов** — все 33 endpoint протестированы ✅
|
- [x] **Аудит эндпоинтов** — все 33 endpoint протестированы ✅
|
||||||
|
- [x] **Автогенерация документации** — pre-commit hook ✅
|
||||||
- [ ] Добавить `/kworks` endpoint (альтернатива каталогу)
|
- [ ] Добавить `/kworks` endpoint (альтернатива каталогу)
|
||||||
- [ ] Добавить `/api/validation/checktext` (валидация текста)
|
- [ ] Добавить `/api/validation/checktext` (валидация текста)
|
||||||
- [ ] Тесты integration (шаблон готов, нужны реальные credentials)
|
- [ ] Тесты integration (шаблон готов, нужны реальные credentials)
|
||||||
@ -30,17 +31,35 @@
|
|||||||
|
|
||||||
## 🔨 Сейчас в работе
|
## 🔨 Сейчас в работе
|
||||||
|
|
||||||
**Текущая задача:** Анализ пропущенных эндпоинтов
|
**Текущая задача:** Добавление endpoint `/kworks` и `/api/validation/checktext`
|
||||||
|
|
||||||
**Следующий шаг:**
|
**Следующий шаг:**
|
||||||
1. Добавить `/kworks` endpoint
|
1. Реализовать `/kworks` endpoint
|
||||||
2. Добавить `/api/validation/checktext` endpoint
|
2. Реализовать `/api/validation/checktext` endpoint
|
||||||
3. CI/CD pipeline (Gitea Actions)
|
3. CI/CD pipeline (Gitea Actions)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 📝 Заметки
|
## 📝 Заметки
|
||||||
|
|
||||||
|
### Автогенерация документации (2026-03-23 03:26)
|
||||||
|
|
||||||
|
**Структура:**
|
||||||
|
```
|
||||||
|
docs/
|
||||||
|
├── index.md # Quick start
|
||||||
|
├── api-reference.md # Auto-generated from docstrings
|
||||||
|
└── examples.md # Usage examples
|
||||||
|
```
|
||||||
|
|
||||||
|
**Pre-commit hook:**
|
||||||
|
```bash
|
||||||
|
# Автоматически генерирует docs/api-reference.md при каждом коммите
|
||||||
|
.git/hooks/pre-commit → python3 scripts/generate_docs.py
|
||||||
|
```
|
||||||
|
|
||||||
|
**Если документация изменилась** — автоматически добавляется в коммит.
|
||||||
|
|
||||||
### Аудит эндпоинтов (2026-03-23 03:08)
|
### Аудит эндпоинтов (2026-03-23 03:08)
|
||||||
|
|
||||||
**Из HAR дампа:** 44 эндпоинта
|
**Из HAR дампа:** 44 эндпоинта
|
||||||
@ -57,9 +76,7 @@
|
|||||||
| `/kworks` | 22KB | Список кворков | 🔴 Добавить |
|
| `/kworks` | 22KB | Список кворков | 🔴 Добавить |
|
||||||
| `/quick-faq/init` | 3.7MB | FAQ данные | ⏪ Опционально |
|
| `/quick-faq/init` | 3.7MB | FAQ данные | ⏪ Опционально |
|
||||||
| `/api/validation/checktext` | - | Валидация текста | 🔴 Добавить |
|
| `/api/validation/checktext` | - | Валидация текста | 🔴 Добавить |
|
||||||
| `/market_main_page/get_mobile_menu` | - | Мобильное меню | ⏪ Пропустить (UI) |
|
| Остальные | - | Analytics/UI | ⏪ Пропустить |
|
||||||
| `/support2/hit` | - | Телеметрия | ⏪ Пропустить |
|
|
||||||
| `/watch/*` | - | Yandex Metrica | ⏪ Пропустить |
|
|
||||||
|
|
||||||
**Тесты:**
|
**Тесты:**
|
||||||
- Unit тесты: 46 passed
|
- Unit тесты: 46 passed
|
||||||
@ -74,6 +91,7 @@
|
|||||||
- Rate limiting на стороне пользователя (не в библиотеке)
|
- Rate limiting на стороне пользователя (не в библиотеке)
|
||||||
- Только библиотека (без CLI)
|
- Только библиотека (без CLI)
|
||||||
- Pydantic модели для всех ответов
|
- Pydantic модели для всех ответов
|
||||||
|
- Автогенерация документации из докстрингов
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -85,10 +103,13 @@
|
|||||||
|
|
||||||
## 📅 История
|
## 📅 История
|
||||||
|
|
||||||
|
- **03:26** — Автогенерация документации настроена (pre-commit hook)
|
||||||
|
- **03:20** — Создана docs/ структура (index.md, api-reference.md, examples.md)
|
||||||
|
- **03:17** — WIP.md восстановлен после rebase
|
||||||
- **03:14** — Анализ пропущенных эндпоинтов: `/kworks` и `/api/validation/checktext` рекомендуются к добавлению
|
- **03:14** — Анализ пропущенных эндпоинтов: `/kworks` и `/api/validation/checktext` рекомендуются к добавлению
|
||||||
- **03:08** — Аудит завершён: 33/33 endpoint протестированы (92% coverage)
|
- **03:08** — Аудит завершён: 33/33 endpoint протестированы (92% coverage)
|
||||||
- **02:48** — Все unit тесты пройдены (13/13)
|
- **02:48** — Все unit тесты пройдены (13/13)
|
||||||
- **02:45** — Исправлены ошибки в тестах (Response cookies, Project.description)
|
- **02:45** — Исправлены ошибки в тестах
|
||||||
- **02:35** — Завершён этап "API клиент"
|
- **02:35** — Завершён этап "API клиент"
|
||||||
- **02:30** — Завершён этап "Модели Pydantic"
|
- **02:30** — Завершён этап "Модели Pydantic"
|
||||||
- **02:20** — Завершён этап "Структура проекта"
|
- **02:20** — Завершён этап "Структура проекта"
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user