Добавили историю по OpenAPI документации с 1.12.2024

README.md

@@ -25,10 +25,15 @@ HeadHunter API — это инструментарий для интеграци
 
 ## [OpenAPI](https://api.hh.ru/openapi/redoc)
 
-Доступная в [OpenAPI](https://api.hh.ru/openapi/redoc) документация будет со временем дополняться.
+Доступная в [OpenAPI](https://api.hh.ru/openapi/redoc) документация содержит всю актуальную информацию на текущий момент.
 Методы, описанные в данной документации и доступные в OpenAPI, имеют соответствующую ссылку.
 
-Спецификация HeadHunter API: [openapi.yml](https://api.hh.ru/openapi/specification/public).
+История версий хранится в папке [versions](versions), [/versions/openapi.yml](versions/openapi.yml) содержит общую документацию, 
+предоставлен для ознакомления, информация в нем может "отставать", поэтому для получения актуальной документации лучше пользоваться страницей https://api.hh.ru/openapi/redoc.
+Если не удается посмотреть изменения в файле openapi.yml в конкретном комите ([пример](https://github.com/hhru/api/commit/28745291577c518a72540bc1243415da26cbec64), 
+ github не отображает крупные изменения в виде diff), можно сформировать файл с изменениями самостоятельно по [инструкции](docs/diff_instruction.md).  
+
+Актуальная спецификация HeadHunter API: [openapi.yml](https://api.hh.ru/openapi/specification/public).
 
 <a name="content"></a>
 ## Содержание

docs/diff_instruction.md

@@ -0,0 +1,31 @@
+# Получить diff “как на GitHub” для двух больших файлов документации
+
+## Шаг 1 — Сгенерировать diff через git diff
+Убедитесь, что git установлен:
+
+```
+git --version
+```
+Сгенерируйте diff для двух файлов и сохрани в файл:
+```
+git diff --no-index --minimal --histogram -- file1 file2 > changes.diff
+```
+где file1 и file2 — пути к сравниваемым файлам, файлы документации можно взять в папке [history](../versions/2026/history)
+
+
+## Шаг 2 — Установить diff2html и отрисовать diff в HTML
+Проверьте, что есть Node.js и npm:
+```
+node -v
+npm -v
+```
+
+Сгенерируйте HTML (side-by-side как на GitHub):
+```
+npx diff2html-cli -i file -o preview -s side -- changes.diff
+```
+
+# Результат
+После выполнения команды выше файл открывается автоматически, если этого не произошло, то надо открыть файл diff.html самостоятельно.
+
+Также можно воспользоваться онлайн ресурсами, например https://www.oasdiff.com/diff или похожими. 

versions/2024/changelog_2024.md

@@ -0,0 +1,51 @@
+# Обновления API
+
+<details>
+<summary><strong>1.2.0 (2024-12-24)</strong></summary>
+
+| Эндпоинт | Breaking | Пояснение |
+| --- | --- | --- |
+| `GET /negotiations` | Да ⚠️ | • изменены поля ответа: items<br>• изменены поля ответа: source |
+| `GET /negotiations/active` | Да ⚠️ | • изменены поля ответа: items<br>• изменены поля ответа: source |
+| `GET /negotiations/response` | Да ⚠️ | • изменены поля ответа: items |
+| `GET /negotiations/{id}` | Да ⚠️ | • изменены поля ответа: source |
+
+</details>
+
+<details>
+<summary><strong>1.1.0 (2024-12-17)</strong></summary>
+
+| Эндпоинт | Breaking | Пояснение |
+| --- | --- | --- |
+| `GET /dictionaries` | Нет | • добавлены поля ответа: employment_form, fly_in_fly_out_duration, work_format, work_schedule_by_days, working_hours |
+| `GET /resumes/{resume_id}/similar_vacancies` | Нет | • изменены поля ответа: items<br>• добавлены поля ответа: employment_form, fly_in_fly_out_duration, internship, night_shifts, work_format, work_schedule_by_days, working_hours<br>• изменены поля ответа: employment, schedule, working_days, working_time_intervals, working_time_modes |
+| `GET /vacancies` | Нет | • изменены поля ответа: items<br>• добавлены поля ответа: employment_form, fly_in_fly_out_duration, internship, night_shifts, work_format, work_schedule_by_days, working_hours<br>• изменены поля ответа: employment, schedule, working_days, working_time_intervals, working_time_modes |
+| `POST /vacancies` | Да ⚠️ | • добавлены поля тела запроса: employment_form, fly_in_fly_out_duration, internship, night_shifts, work_format, work_schedule_by_days, working_hours<br>• изменены поля тела запроса: employment, schedule, working_days, working_time_intervals, working_time_modes<br>• изменены поля ответа: errors<br>• изменены поля ответа: reason |
+| `POST /vacancies/drafts` | Нет | • добавлены поля тела запроса: employment_form, fly_in_fly_out_duration, internship, night_shifts, work_format, work_schedule_by_days, working_hours<br>• изменены поля тела запроса: employment, schedule, working_days, working_time_intervals, working_time_modes |
+| `GET /vacancies/drafts/{draft_id}` | Нет | • добавлены поля ответа: employment_form, fly_in_fly_out_duration, internship, night_shifts, work_format, work_schedule_by_days, working_hours<br>• изменены поля ответа: employment, schedule, working_days, working_time_intervals, working_time_modes |
+| `PUT /vacancies/drafts/{draft_id}` | Нет | • добавлены поля тела запроса: employment_form, fly_in_fly_out_duration, internship, night_shifts, work_format, work_schedule_by_days, working_hours<br>• изменены поля тела запроса: employment, schedule, working_days, working_time_intervals, working_time_modes |
+| `GET /vacancies/{vacancy_id}` | Нет | • добавлены поля ответа: employment_form, fly_in_fly_out_duration, internship, night_shifts, work_format, work_schedule_by_days, working_hours<br>• изменены поля ответа: employment, schedule, working_days, working_time_intervals, working_time_modes |
+| `PUT /vacancies/{vacancy_id}` | Да ⚠️ | • добавлены поля тела запроса: employment_form, fly_in_fly_out_duration, internship, night_shifts, work_format, work_schedule_by_days, working_hours<br>• изменены поля тела запроса: employment, schedule, working_days, working_time_intervals, working_time_modes<br>• изменены поля ответа: errors<br>• изменены поля ответа: reason |
+| `GET /vacancies/{vacancy_id}/related_vacancies` | Нет | • изменены поля ответа: items<br>• добавлены поля ответа: employment_form, fly_in_fly_out_duration, internship, night_shifts, work_format, work_schedule_by_days, working_hours<br>• изменены поля ответа: employment, schedule, working_days, working_time_intervals, working_time_modes |
+| `GET /vacancies/{vacancy_id}/similar_vacancies` | Нет | • изменены поля ответа: items<br>• добавлены поля ответа: employment_form, fly_in_fly_out_duration, internship, night_shifts, work_format, work_schedule_by_days, working_hours<br>• изменены поля ответа: employment, schedule, working_days, working_time_intervals, working_time_modes |
+| `GET /vacancy_conditions` | Нет | • добавлены поля ответа: employment_form, fly_in_fly_out_duration, work_format, work_schedule_by_days, working_hours<br>• изменены поля ответа: employment, schedule, working_days, working_time_intervals, working_time_modes |
+
+</details>
+
+<details>
+<summary><strong>1.0.1 (2024-12-09)</strong></summary>
+
+| Эндпоинт | Breaking | Пояснение |
+| --- | --- | --- |
+| `GET /negotiations/response` | Нет | • изменены поля ответа: items<br>• добавлены поля ответа: university_acronym |
+| `GET /negotiations/{id}` | Нет | • изменены поля ответа: resume<br>• изменены поля ответа: education<br>• добавлены поля ответа: university_acronym |
+| `GET /resumes` | Нет | • изменены поля ответа: items<br>• изменены поля ответа: education<br>• добавлены поля ответа: university_acronym |
+| `POST /resumes` | Нет | • изменены поля тела запроса: education<br>• добавлены поля тела запроса: university_acronym |
+| `GET /resumes/mine` | Нет | • изменены поля ответа: items<br>• изменены поля ответа: education<br>• добавлены поля ответа: university_acronym |
+| `GET /resumes/{resume_id}` | Нет | • изменены поля ответа: education<br>• добавлены поля ответа: university_acronym |
+| `PUT /resumes/{resume_id}` | Нет | • изменены поля тела запроса: education<br>• изменены поля тела запроса: primary<br>• добавлены поля тела запроса: university_acronym |
+| `GET /vacancies/{vacancy_id}/resumes_by_status` | Нет | • изменены поля ответа: already_applied<br>• изменены поля ответа: education<br>• добавлены поля ответа: university_acronym |
+| `GET /vacancies/{vacancy_id}/suitable_resumes` | Нет | • изменены поля ответа: items<br>• изменены поля ответа: education<br>• добавлены поля ответа: university_acronym |
+| `GET /vacancies/{vacancy_id}/visitors` | Нет | • изменены поля ответа: items<br>• добавлены поля ответа: university_acronym |
+
+</details>