docs: clarify Polygon auth and API contracts
This commit is contained in:
@@ -1,4 +1,4 @@
|
||||
# polygon v0.5.17
|
||||
# polygon v0.5.18
|
||||
|
||||
Эмулятор REST API облачной платформы Nubes для интеграционных тестов app-autotest.
|
||||
|
||||
@@ -11,13 +11,14 @@
|
||||
polygon/
|
||||
├── requirements.txt # Flask>=3.0, gunicorn>=21.2, PyYAML>=6.0
|
||||
├── tests/
|
||||
│ ├── test_converter.py # тесты from_stands.py
|
||||
│ ├── test_state_machine.py # тесты state_machine.py
|
||||
│ ├── test_converter.py # тесты from_stands.py
|
||||
│ ├── test_loader.py # тесты CWD-independent loader
|
||||
│ ├── test_state_machine.py # тесты state_machine.py
|
||||
│ └── test_route_regressions.py # локальные регрессионные тесты API
|
||||
└── site/
|
||||
├── app.py # Flask: только blueprint'ы + app.run() (57 строк)
|
||||
├── routes/ # blueprint-файлы по доменам
|
||||
│ ├── root.py # /health, /
|
||||
│ ├── root.py # /health, /, /swagger
|
||||
│ ├── services_routes.py# /api/v1/svc/services
|
||||
│ ├── instances_routes.py# /api/v1/svc/instances
|
||||
│ ├── operations_routes.py# /api/v1/svc/instanceOperations/*
|
||||
@@ -35,7 +36,8 @@ polygon/
|
||||
├── static/
|
||||
│ └── style.css # тёмная тема
|
||||
├── templates/
|
||||
│ └── index.html # Jinja2-шаблон
|
||||
│ ├── index.html # главная и инструкции API
|
||||
│ └── swagger.html # Swagger UI и инструкция Authorize
|
||||
└── services/ # fallback YAML, также генерируются from_stands.py
|
||||
```
|
||||
|
||||
@@ -141,6 +143,12 @@ curl https://polygon.pythonk8s.dev.nubes.ru/dev/api/v1/svc/services | python3 -m
|
||||
|
||||
Основные API-маршруты не требуют авторизации. Если задан `MOCK_AUTH_TOKEN`, запросы к `/_mock/*` должны передавать заголовок `X-Mock-Auth`.
|
||||
|
||||
### Где взять и куда вводить токен
|
||||
|
||||
`MOCK_AUTH_TOKEN` задаёт администратор в переменных окружения запущенного сервиса Polygon. Приложение не генерирует и не показывает это значение. Если у вас нет доступа к настройкам сервиса, запросите токен у его администратора.
|
||||
|
||||
В Swagger нажмите **Authorize**, в поле `X-Mock-Auth` → **Value** вставьте выданный токен и нажмите **Authorize** в диалоге. После этого Swagger автоматически добавит заголовок к запросам `/_mock/*`. В curl передавайте его явно: `-H "X-Mock-Auth: <token>"`. Если `MOCK_AUTH_TOKEN` на сервере не задан, токен вводить не нужно.
|
||||
|
||||
## Переменные окружения
|
||||
|
||||
| Переменная | По умолчанию | Описание |
|
||||
|
||||
Reference in New Issue
Block a user