reports/docs/api/teams.md

52 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

# Команды (Team)
← [Сводка API](README.md)
Сущность **Team** — команда разработки. Является корневым элементом навигации в интерфейсе.
## Связанные сущности
- [Спринты](sprints.md) — спринты команды: `GET /api/teams/{teamId}/sprints`
- [Задачи](tasks.md) — все задачи команды: `GET /api/teams/{teamId}/tasks`
---
## Модель данных
### Team
```json
{
"id": 1,
"name": "ts"
}
```
| Поле | Тип | Описание |
|------|-----|----------|
| `id` | `integer` | Идентификатор команды |
| `name` | `string` | Название команды (`teams.team_name`, без пробелов по краям) |
---
## Эндпоинты
### `GET /api/teams`
Возвращает все команды, отсортированные по названию.
**Ответ:** `200` — массив `Team[]`
```json
[
{ "id": 1, "name": "ts" },
{ "id": 4, "name": "bryansk" }
]
```
**Пример**
```bash
curl http://localhost/api/teams
```