Skip to content

Updates to the final task to move it to Swagger Editor#1919

Open
kravaring wants to merge 4 commits intomasterfrom
feat/2026q2-final-task
Open

Updates to the final task to move it to Swagger Editor#1919
kravaring wants to merge 4 commits intomasterfrom
feat/2026q2-final-task

Conversation

@kravaring
Copy link
Copy Markdown
Collaborator

Title of Pull Request

🤔 This is a

  • 🌟 New task
  • 🌐 New module
  • ⚙️ Update to an existing task
  • 🔧 Update to an existing module
  • 🔗 Update or addition of external resources or links
  • 🐛 Fix in a task or related content
  • 🛠 Fix in a module or related content
  • ✏️ Fixed a typo or grammatical error
  • 🔗 Fixed a broken link
  • ❓ Other (specify: ****____****)

Description

  • Brief Overview:
  • Implementation Approach:

Additional Information

  • Screenshots/Links:
  • Related Issues:

Checklist

  • ✅ I have performed a self-review of my own code.
  • 📝 I have commented my code, particularly in hard-to-understand areas.
  • 🔧 I have made corresponding changes to the documentation (if applicable).
  • 🚫 My changes generate no new warnings or errors.

## Application Prototype

You can use existing solutions like [Thunder Client for VSCode](https://marketplace.visualstudio.com/items?itemName=rangav.vscode-thunder-client) as a source of inspiration.
You can use existing solutions like [Swagger Editor](https://editor.swagger.io/) as a source of inspiration.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

- Live schema validation and error indication
- Support for OpenAPI 3.0.x and Swagger 2.0 specifications
- Example schemas dropdown (optional nice-to-have)
- Clear/reset schema button
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are we sure it should be in swagger editor, not in swagger viewer?

Copy link
Copy Markdown
Collaborator

@Margaryta-Maletz Margaryta-Maletz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Требования из описания, не покрытые оцениваемыми критериями

1. Репозиторий и процесс разработки (нет в критериях вообще)

  • [L80] Название репозитория: swagger-editor-app и правила именования веток (develop / main)
  • [L79] Соответствие соглашению о коммитах
  • [L80] Деплой демо-версии на gh-pages / netlify / heroku и т.п.
  • [L81] Создание Pull Request из develop в main (без мержа)
  • [L82] Инструкции по локальному запуску прокси-сервиса (если используется)
  • [L83] Открыть репозиторий публично после дедлайна

2. Технические требования (только штрафы, но не баллы за выполнение)

  • [L97] Семантическая вёрстка — упомянута в требованиях, в критериях отсутствует
  • [L99] Страница 404 — обязательна по структуре приложения, не оценивается
  • [L99] Error Boundary — обязателен, не оценивается
  • [L101] React 18+ — обязательное требование, нет критерия
  • [L111] TypeScript — обязательное требование, нет позитивного критерия (только штраф за @ts-ignore)
  • [L112] Тесты / покрытие 80% — только штрафы за нарушение, нет позитивных баллов
  • [L113] Lint / format — только штрафы за отсутствие, нет позитивных баллов
  • [L114] Husky hooks — только штрафы за отсутствие, нет позитивных баллов

3. Требования к дизайну (не оцениваются)

  • [L119] Не более 3 шрифтов на странице, размер шрифта ≥ 14px, контрастность
  • [L120] Hover-эффекты на интерактивных элементах
  • [L120] Разные стили для активного и неактивного состояния элементов
  • [L120] Плавные анимации
  • [L121] Единство стилей всех страниц (одинаковые шрифты, кнопки, отступы, цвета из одной палитры)

4. Footer (частично не оценивается)

Feature 1 упоминает ссылку на About в футере [10 pts], но остальные требования футера — не оцениваются:

  • [L213] Ссылки на GitHub авторов
  • [L213] Год создания приложения
  • [L213] Логотип RS School со ссылкой на курс
  • [L214] Футер отображается на всех страницах

5. Header (частично не оценивается)

Оценивается в Feature 1, но не оценивается:

  • [L205] Ссылка на Main page через логотип

6. Swagger Editor (частично не оценивается)

Feature 3 покрывает основное, но не оценивается:

  • [L150] Поддержка OpenAPI 3.0.x и Swagger 2.0 (два стандарта)
  • [L151] Дропдаун с примерами схем (optional, nice-to-have)
  • [L152] Кнопка Clear / Reset schema
  • [L154] Session-based editing (данные очищаются после сессии у неавторизованных)
  • [L156] Syntax highlighting с номерами строк
  • [L158] Copy/paste friendly interface

7. Swagger Viewer (частично не оценивается)

Feature 4 покрывает основное, но не оценивается:

  • [L175] Поддерживаемые content types (application/json, application/xml…)
  • [L181] Response headers (если задокументированы)
  • [L192–194] Request Preview — предпросмотр полного запроса перед выполнением (метод, URL, заголовки, тело)

8. История и аналитика (частично не оценивается)

Feature 5 покрывает основное, но не оценивается:

  • [L242] Lazy loading кода страницы — есть только штраф за отсутствие (-50 pts), позитивного балла нет
  • [L244] Отображение запросов через кликабельные ссылки с детальной аналитикой
  • [L256] Явное условие: нет повторного запуска (replay) запросов из истории

9. About Page (частично не оценивается)

Feature 6 оценивает основное, но не оценивается:

  • [L234] Technologies used — упомянуто в описании, но не в Acceptance Criteria
  • [L235] Links to relevant resources — аналогично
  • [L237] Responsive layout страницы About

10. Аутентификация (не оценивается технический выбор)

  • [L218–222] Обязательное использование Firebase / Supabase / Convex / NextAuth.js не оценивается как критерий

Итог

Наиболее значимые «мёртвые зоны» между описанием и критериями:

Область Строки в задании Что описано, но не оценивается
Репозиторий L79–83 Деплой, название репо, ветки, коммиты
Технические L97–114 404, Error Boundary, семантика, React 18, TypeScript
Дизайн L119–121 Все требования к дизайну (шрифты, hover, анимации, единство стилей)
Footer L213–214 GitHub-ссылки, год, логотип RS School
Editor L150–158 Clear/reset, syntax highlighting, session-based editing
Viewer L175–194 Request Preview, response headers, content types
History L242–256 Lazy loading (только штраф), кликабельные ссылки, запрет replay
About L234–237 Responsive layout, technologies, resources

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants