reports/docs/api/config.md

50 lines
1.3 KiB
Markdown
Raw Normal View History

# Конфигурация (AppConfig)
← [Сводка API](README.md)
Сущность **AppConfig** — публичные настройки для фронтенда. Секреты (токены, пароли) **не** включаются в ответ.
## Связанные сущности
- [Задачи](tasks.md) — `jira_url` используется для ссылок `{jira_url}/browse/{task_key}` (в том числе для [TeamTask](tasks.md))
---
## Модель данных
### AppConfig
```json
{
"jira_url": "https://your-domain.atlassian.net"
}
```
| Поле | Тип | Описание |
|------|-----|----------|
| `jira_url` | `string` | Базовый URL Jira без завершающего `/`. Берётся из переменной окружения `JIRA_URL` |
---
## Эндпоинты
### `GET /api/config`
Возвращает публичную конфигурацию.
**Ответ:** `200` — объект `AppConfig`
**Пример**
```bash
curl http://localhost/api/config
```
**Использование**
```text
https://your-domain.atlassian.net/browse/TS-1234
```
где `https://your-domain.atlassian.net` — значение `jira_url`, `TS-1234` — поле `task_key` из [SprintTask](tasks.md).