Глоссарий

Термины и понятия, используемые в документации.

Термины проекта

Технические термины и инструменты, используемые в этом проекте документации.

Инфраструктура

Worker

Cloudflare Worker — бессерверный прокси между Swagger UI и реальным API. Добавляет CORS-заголовки, подставляет Origin/Referer и отдаёт mock-данные при отсутствии токена.

Пайплайн

Автоматизированный процесс сбора и публикации данных: tests → collect → validate → anonymize → publish → worker → mkdocs. Запускается ночью через GitHub Actions.

CORS

Cross-Origin Resource Sharing — механизм безопасности браузера. Журнал API не разрешает кросс-доменные запросы, поэтому воркер добавляет CORS-заголовки к ответам.

Безопасность и авторизация

Bearer-токен

Формат авторизации HTTP. После логина access_token отправляется как Authorization: Bearer <token> с каждым запросом. См. Аутентификация.

Обработка данных

Анонимизация

Процесс замены реальных персональных данных (имёна, ID, даты) на сгенерированные значения через Faker. Гарантирует отсутствие чувствительных данных в публичном репозитории и mock-сервере.

Faker

Библиотека Python (faker) для генерации фиктивных данных. Используется на шаге anonymize пайплайна для подмены имён, сдвига дат и т.д.

Pydantic

Библиотека валидации данных Python. Модели в src/validator/models.py описывают ожидаемую структуру каждого ответа API. При изменении API валидация падает и открывает Issue в GitHub.

Документация

Swagger UI

Интерактивный интерфейс документации API, встроенный в этот сайт. Работает на базе openapi.json и плагина mkdocs-swagger-ui-tag. См. Swagger UI.

Доменные термины журнала

Понятия, описывающие внутреннее устройство и структуру учебного журнала IT Top Academy.

Организационная структура

Stream

Учебный поток — набор студентов, обучающихся вместе. Поток содержит несколько групп. Идентифицируется stream_id и stream_name.

Group

Учебная группа внутри потока. Студенты одной группы делят расписание и ДЗ. Идентифицируется group_id или current_group_id.

Spec

Предмет (дисциплина) в учебном плане. В API встречается как spec_id, spec_name, id_spec, name_spec. Используется в эндпоинтах ДЗ, прогресса и расписания.

Учебный процесс

DZ

Домашнее задание (дз). В UI — вкладка «ДЗ». В API type=0 — обычное ДЗ, type=1 — лабораторная работа.

Теги оценки ДЗ

Теги, отображаемые ученику после сдачи домашнего задания — ученик выбирает теги, описывающие его уверенность и уровень усилий. Возвращаются эндпоинтом /homework/evaluation/operations/get-tags.