Добавлена возможность сортировки групп методов по названию.
Node.js 12 больше не поддерживается.
Также убраны однобуквенные сокращения для некоторых CLI-флагов.
См. гайд по миграции.
Вернули обратно применение trim в функции stringify.
Исправлена ошибка при выборе опций в OneOf в структуре типа Message.
Добавлена возможность использовать кастомную фавиконку.
Упрощено кэширование структур данных.
Добавлен GitHub-пайплайн для сборки и пуша Docker-образа.
Добавили поддержку интернационализации.
Теперь можно выбрать локаль с помощью флага --locale.
Доступны ru и en. По умолчанию — en.
Исправили одновременное подсвечивание элементов меню, находящихся на одном уровне.
Доработали стили печатной версии документации.
Обновили @svgr/webpack и заменили react-highlight на react-lowlight, чтобы исправить возможные уязвимости.
Добавили возможность использования Маркдауна в описании атрибутов.
Откатились на [email protected] с 0.14.0, потому что 0.14.0 багованная.
Опубликовали пакет на Гитхабе и добавили файл с лицензией.
- Доработка обрезания длинных заголовков пунктов меню документации.
- Улучшение парсинга экшенов.
- Удаление блока с ссылкой на туториал из кода.
- Установка uniqueName для глобальных переменных при сборке webpack.
- Корректировка определения домена для установки куки с темой.
- Замена форка
@funbox/react-aria-modalна оригинальный пакет.
- Замена форка
@funbox/commonmarkна оригинальный пакет.
- Добавление Юриста.
- Приведение цвета обводки чекбокса к дизайну.
- Исправление перезагрузки страницы при изменении файлов документации.
- Обновление зависимостей с переходом на Node версии 14.18.0.
- Замена базового Докер-образа на node:14.18.0-stretch-slim.
- Уменьшение размера финального бандла.
- Исправление работоспособности страницы ручного поиска.
- Замена переменной окружения JENKINS_URL на CI.
- Исправление ошибки с переполением памяти при обработке больших документаций.
- Обновление текста диалога помощи в соответствии с макетом.
- Обновление текста диалога помощи в соответствии с макетом.
- Удаление неактуальной информации о Jenkins из readme.md.
- Исправление отступов в диалоге помощи.
- Добавление ссылки на туториал в диалог помощи.
- Исправление отображения фавиконки в сгенерированном HTML.
- Доработка ключа, по которому кэшируются структуры данных.
- Настройка уведомлений о релизах.
- Исправление перезагрузки страницы при изменении файлов, если doc.apib лежит в поддиректории.
- Перевод сборки docker-образа с dind на kaniko.
- Исправление парсинга параметров URI, содержащих символы "~", ".", "-".
- Исправление задания backgroundLocation при загрузке страницы.
- Исправление поведения элементов при узком вьюпорте.
- Переход на crafter 3.
- Реализация попапа с информацией о возможностях blueprinter-frontend.
- Добавление возможности подключения кастомного css файла.
- Настройка создания релизов при мерже в мастер.
- Использование компонента CheckboxField для выбора опций в OneOf.
- Генерация примеров body из шаблонов, содержащих все варианты опций One Of.
- Добавление тёмной темы.
- Исправление отображения nullable enum.
- Исправление отображения falsy default секций.
- Доработка конфигурации gitlab-ci.
- Замена ссылок репозиториев на gitlab.
- Удаление переменной
no_proxy.
- Разделение запуска тестов и билда.
- Автопубликация пакета.
- Настройка кэша node_modules.
- Отключение tags pipeline.
- Удаление fibers.
- Обновление тестовой документации.
- Обновление стилей элементов после переноса дизайна в Figma.
- Вывод форматированного описания в запросах и ответах.
- Исправление ошибки hot reload при локальной разработке.
- Реализация скрытия/открытия сайдбара.
- Исправление работы поиска для сообщений без тела (атрибутов).
Обновление версии caniuse-lite.
- Добавление отображения описания у элементов One Of.
- Добавление unit-тестов.
- Исправление переполнения содержимого бокового меню.
- Аудит зависимостей.
- Добавление плагина babel-plugin-transform-react-remove-prop-types.
- Исправление подстановки refract'а в html-файл.
- Починка отображения атрибутов у сообщений.
- Адаптация версии для печати HTML-документа для просмотра в PDF формате.
- Исправление редиректа для URL без групп и ресурсов.
- Исправление взаимодействия с value-атрибутами.
- Исправление открытия атрибута после двойного клика.
- Переход на crafter 2.
- Доработка определения моноширинных шрифтов для кода.
- Обновление вёрстки страницы с информацией об ошибке.
- Оптимизация работы функций fillAdditionalAttributes и resolveSourceElementInheritance.
- Добавление отображения атрибутов у секции Attributes.
- Добавление отображения атрибута "fixed" в дочерних полях.
- Оптимизация шрифтов и целевых браузеров.
- Исправление ошибки при добавлении якорей к заголовкам в описании.
- Использование логгера предупреждений при генерации рефракта.
- Отображение расширенной информации об ошибке.
- Исправление предупреждения в сервисе и ошибок в песочнице.
- Доработка получения nestedTypes именованных типов при наследовании.
- Исправление вотчинга файлов apib в зависимостях.
- Исправление раскрытия пунктов сайдбара при открытии ресурса с кастомным якорем.
- Исправление рендера экшена с повторяющимся параметром.
- Заполнение атрибутов массивов.
- Исправление отображения информации об ошибке Crafter'а.
- Доработка проверки типа секции MemberTypeGroup в именованных типах.
- Доработка отображения рекурсивных атрибутов.
- Улучшение текста
README.md.
- Обновление Crafter до 1.57.0.
- Удаление фигурных скобок из роутов.
- Добавление заголовка в описания для запросов.
- Исправление обработки импортов в импортированном файле.
- Исправление парсинга секции Resource идущей после Resource Prototypes.
- Исправление рендера ошибки от crafter без source map.
- Распознание первой ноды подключаемого файла при импорте.
- Переход на Node.js 12.16.3 в Docker образе.
- Учёт возможного наличия рекурсивных Data Structure.
- Формирование роутов по новому принципу.
- Исправление рендеринга url параметров со звёздочкой.
- Поддержка рекурсивных объектов.
- Добавление страницы для поиска через ctrl+f.
- Исправление перезапуска отладочного сервера.
- Добавление типа для секции Attributes.
- Доработка отображения атрибутов структур данных.
- Удаление definitions для наследуемых типов.
- Исправление отображения 0 в enum типах.
- Отображение примеров для атрибутов с вложенным контентом.
- Исправление рендера пунктов боковой навигации.
- Исправление ошибки про некорректный mime type в dev-режиме.
- Исправление перемещения между результатами поиска с помощью клавиатуры.
- Фокусирование на поле поиска при нажатии на клавишу «slash».
- Доработка отображения результатов поиска.
- Реализация поиска по новому алгоритму.
- Добавление проверки на переопределение полей.
- Исправление получения примеров атрибута.
- Исправить отображение списков.
- Скрытие блока со схемой.
- Подсветка параметров url в примере запроса.
- Обновление зависимостей.
- Обновление react-hot-loader.
- Перевод на локальные конфиги webpack.
- Добавление проверки уникальности response.
- Рефакторинг боковой навигации.
- Замена шрифта Montserrat на Roboto и исправление стилей сайдбара.
- Исправление рендеринга url параметров со звёздочкой.
- Доработка подсветки пунктуации кода.
- Удаление ограничения минимальной длины поискового запроса.
- Возможность просмотра HTML-файла документации без веб-сервера.
- Исправление установки зависимостей eslint.
- Добавление strict-режима сборки.
- Отображение названий методов в верхнем регистре.
- Переход на новый дизайн.
- Устранение предупреждений webpack при сборке.
- Исправление задания хэшей ресурсам без заголовков.
- Исправление перехода по якорю в Firefox.
- Добавление отображения первой строки описания ответа в табах.
- Исправление итогового статуса сборки с ошибкой Crafter.
- Удаление схлопывания заголовка ресурса и единичного экшена в левом меню.
- Обновление зависимостей.
- Хранение полученного рефракта в памяти вместо записи в refract.js.
- Исправление отображения ресурса без заголовка в левой колонке.
- Обновление зависимостей с уязвимостями по безопасности.
- Исправление отображения 0 или false в качестве примера.
- Добавление Dockerfile для сборки образа.
- Переопределение якоря через комментарий html.
- Добавление обработки схема-типов.
- Исправление server_name для https.
- Исправление конфига nginx.
- Использование исходного apib-документа для получения refract-стаба.
- Правильная реализация вотчинга файлов использованных при построении документации.
- Исправление парсинга блоков с заголовками при импорте.
- Доработка сообщения об ошибке при отсутствии искомого блока.
- Исправление рендера элементов enum в секции Attributes.
- Исправление отображения нуля при использовании параметра "minimum".
- Исправление генерации описания параметров URI.
- Исправление ошибки подключения библиотеки @funbox/free-port-finder.
- Обновление зависимости от библиотеки @funbox/free-port-finder.
- Реализация создания директорий для output файла.
- Рендеринг uri параметров со звёздочкой в итоговом url.
- Добавление опциональных атрибутов non-nullable и optional в поля объектов.
- Отображение json-schema у секций Message.
- Вывод ошибок и предупреждений от Crafter.
- Генерация корректного body для примитивных типов без примеров.
- Исправление рендера меню с ресурсами, содержащими только описание.
- Отображение секций SubGroup и Message.
- Исправление парсинга пустого тела ответа в crafter.
- Исправление парсинга атрибутов у именованных типов.
- Исправление потери отступов у code_block.
- Добавление в readme.md описания использования на других проектах.
- Исправление парсинга параметров URI со звёздочкой в actions.
- Корректировка применения отрицательных отступов при синхронизации положения карточек Action и блока Transition.
- Конвертация значений нетипизированных элементов массива.
- Корректировка json-схем для fixed и fixed-type элементов.
- Исправление парсинга блока кода в блочном описании.
- Обработка секций :::note и :::warning при рендере документации.
- Исправление отображения длинных URL.
- Актуализация песочницы.
- Исправление обработки секций resourcePrototype.
- Исправление проверки совпадающих атрибутов при резолве наследования.
- Исправление проверки типа атрибутов при сравнении.
- Исправление передачи атрибута fixed-type вложенным элементам.
- Возможность отображения блоков в описании.
- Конвертирование вложенных элементов enum.
- Оптимизация первой отрисовки страницы.
- Улучшение отображения названия параметра.
- Исправление формирования таблицы enum-значений массива.
- Исправление наследования от enum.
- Исправление наследования от именованных типов.
- Удаление ключевого слова fixed-type для массивов из дерева.
- Отображение параметризованных атрибутов в правой колонке.
- Отображение схемы запроса.
- Использование дефолтных значений в body и json-schema.
- Доработки секции Default и возможность вкладывать Default и Sample в примитивы.
- Исправление парсинга атрибутов.
- Добавление предупреждения если в action отсутствуют ответы.
- Исправление процессинга именованных примитивных типов.
- Исправление рендеринга документации без группы запросов.
- Исправление рендеринга action с пустым содержимым.
- Исправление парсинга именованных эндпоинтов.
- Обработка enum uri-параметра с пропущенным "+ Members".
- Улучшение вывода параметров с enum-значениями.
- Получение значения uri-параметра для сложных типов.
- Исправление импорта файлов.
- Обработка вложенных элементов href-параметра в виде описания.
- Замена drafter на crafter.
- Подсветка атрибута required.
- Исправление ошибки ненайденного скрипта.
- Поддержка node.js 10.
- Обработка markdown-разметки в описаниях URI параметров.
- Использование commonmarkjs вместо showdown для рендера html.
- Исправление механизма построения хеш-ссылок.
- Исправление замечаний линтера.
- Исправление отображения параметров url в фигурных скобках.
- Исправление переноса параметров href транзакции.
- Исправление отображения href с параметрами enum-типа.
- Задание увеличенного отступа для пункта меню с лейблом метода.
- Получение заголовка от ресурса для транзакции без заголовка.
- Объединение пунктов бокового меню с ресурсом и единственной транзакцией.
- Исправление резолва наследования ноды member с контентом.
- Назначение правильного типа структуры при разрешении наследования.
- Исправление обработки содержимого enum-атрибута.
- Обновление версии @funbox/sass-lint до 1.10.2-fb-2.0.1.
- Обновление версии @funbox/protagonist до 1.6.8-fb-2.0.0.
- Оптимизация перерисовки блоков при взаимодействии с меню.
- Удаление лишних файлов перед публикацией пакета.
- Исправление ошибок рендера реакт-компонентов.
- Изменение схемы формирования статичного HTML.
- Исключение необходимости установки React для сборки документации.
- Добавление заголовков из описания в качестве пунктов меню.
- Начальная версия проекта.