Использование серверной документации

Серверный репозиторий уже содержит документацию по API в каталоге netrunner-server/docs/nrunner. Она подходит как источник истины для ручной проверки API.

Где лежит документация

Основные файлы:

• docs/nrunner/opencollection.yml — корневое описание структуры документации;
• docs/nrunner/environments/local.yml — локальное окружение;
• вложенные каталоги auth, host, group, task, template, credentials, logs и другие — конкретные запросы.

Локальное окружение

В environments/local.yml сейчас задано:

base_url = http://127.0.0.1:3002/api/v1

Также там сохраняются access_token и refresh_token, которые используются после выполнения логина и refresh-запроса.

Базовый сценарий работы

1. Открыть каталог netrunner-server/docs/nrunner.
2. Выбрать окружение local.
3. Выполнить POST /auth/login.
4. Проверить, что после входа доступны access_token и refresh_token.
5. После этого запускать защищённые запросы к users, hosts, groups, templates, tasks и другим разделам.

Что полезно проверить первым

• GET /admin/exists — создан ли первый администратор;
• POST /admin — первичная инициализация администратора;
• POST /auth/login — получение токенов;
• GET /users/me — подтверждение роли и текущего пользователя;
• GET /liveness и GET /readiness — состояние сервера;
• GET /hosts, GET /groups, GET /tasks/active — базовые прикладные данные.

Практическое замечание

Markdown-раздел в этой документации даёт обзор по структуре API, а серверная документация из репозитория лучше подходит для точной проверки формата тел запросов, query-параметров и реальных примеров.