Обновите пример, заморозьте побочный эффект: карты возможностей для внутренних API

Внутренняя страница возврата средств находилась в вики команды в течение шести недель. Пример с завитком все еще анализируется. Повторить предложение не удалось. Во время отката во вторник дежурный инженер проследил за созданной заметкой, в которой говорилось, что POST /v2/refunds «безопасно повторить». Обработчик не был идемпотентным. Два кредита выставлены против одного платежа. Пример был просто устаревшим. Обещание было придумано. Сгенерированные документы API терпят неудачу в течение двух тактов. Документы формы портятся, когда поля перемещаются. Документы обещаний терпят неудачу, когда модель пишет эксплуатационные гарантии, которые никто не подписывал. Смешение этих часов в одном файле Markdown — обычная случайность. В этой статье предлагается карта возможностей: одна короткая пара файлов на каждую внутреннюю конечную точку или инструмент агента. Модель может иметь эскизную форму. Человек должен владеть побочными эффектами. Шашка проваливает сборку, когда дорожки смешиваются. Приведенный ниже рабочий процесс представляет собой предложение. Сценарии — это локальные примеры, а не производственная телеметрия. Два часа, а не одна страница Рассматривайте каждую конечную точку как два документа, склеенных стабильным идентификатором. Часы А — форма (регенерируемая) Строка цели переработана из сводки OpenAPI. Таблица параметров Пример запроса и ответа Ссылки на родственные пути Часы B — обещание (заморожено до тех пор, пока его не отредактирует человек) Аутентификация и авторизация