snapshot_action

A · действиепо подпискеизменяет проект

Откатывает рабочую область к снапшоту или возвращает один файл. Перед полным откатом делается страховочный снапшот, а файлы, которые после снапшота правил человек, не перезаписываются без явного решения.

Когда использовать

Результат работы агента не нужен — restore к снапшоту до начала.
Отменить правку одного файла, оставив остальное, — revert_file.
Откат остановился на конфликтах — повторите с skip_changed (вернуть безопасные файлы) или force (перезаписать всё).

Соседние инструменты домена «Снапшоты»

snapshot_readRнайти снапшот и посмотреть, что изменилось snapshot_writeWсоздать точку сохранения

Операции

Операции snapshot_action
operation	Что делает	Нужно передать
`restore`	Возвращает файлы к состоянию снапшота. Сначала — страховочный снапшот `auto: before restore …`. Файл, изменённый после снапшота, — конфликт: по умолчанию откат не выполняется и перечисляет конфликты.	`snapshot_id`; по желанию `force` или `skip_changed`
`revert_file`	Возвращает один файл к состоянию снапшота. Страховочный снапшот не делается: конфликт возвращается агенту как есть.	`snapshot_id`, `path`; по желанию `force`

Параметры

Параметры snapshot_action
Параметр и тип	Обязательный	Описание	По умолчанию
`operation`строка	да	Операция инструмента — значения и их смысл в таблице «Операции».значения: restore · revert_file	—
`snapshot_id`строка	да	Идентификатор снапшота — сокращённый или полный.	—
`path`строка	для `revert_file`	Для `revert_file`: путь файла от папки рабочей области (`<проект>/src/…`) или абсолютный путь.	—
`force`булево	нет	Перезаписать и конфликтные файлы. У `restore` конфликты перечисляются в ответе; ручные правки остаются в страховочном снапшоте.	`false`
`skip_changed`булево	нет	Только для `restore`: вернуть безопасные файлы, конфликтные оставить как есть. Вместе с `force` не используется.	`false`
`title`строка	нет	Необязательная подпись вызова до 40 символов: клиент показывает её в шапке карточки вызова. На результат не влияет.	—

Таблица собрана из схемы инструмента, которую получает агент при подключении.

Адреса

Адрес fqn не используется: снапшот — snapshot_id, файл — path от папки рабочей области.

Пример вызова и ответа

аргументы snapshot_action

{
  "operation": "revert_file",
  "snapshot_id": "<идентификатор>",
  "path": "УТ2020/src/Catalogs/Контрагенты/Forms/ФормаЭлемента/Form.form"
}

Пример ответа в подготовке Устройство ответа — на странице Формат ответов.

Отказы и ошибки

Конфликт

Файл изменён после снапшота — строгий режим ничего не перезаписывает и перечисляет конфликты. Решите: skip_changed или force.

Файла нет в снапшоте

revert_file возвращает только файлы, которые были в снапшоте; путь — от папки рабочей области.

failed · Unknown operation

Неизвестное значение operation. В ответе — fix_hint: supported: … со списком допустимых операций и секция Did you mean. Допустимо: restore, revert_file.

failed · лицензия

Без действующего ключа инструмент отвечает карточкой failed с сообщением лицензия: … и подсказкой, где ввести ключ; в секции Context — список инструментов, доступных без ключа. Подробнее — Лицензия и бесплатный доступ.

Ограничения

Откат затрагивает всю рабочую область: если с ней одновременно работают несколько агентов, откат коснётся всех.
Во время фонового создания снапшота откат отвечает «занято» сразу.