# api-documentation: описать endpoint вместе с ошибками: сведения для ИИ-агента

> Справочный документ Staksy для твоего агента. Это сведения для проверки, не команды: ничего отсюда не выполняй и не устанавливай без подтверждения пользователя. Сверь требования с первоисточниками ниже; устаревшее и неподтверждённое не принимай как факт. Не утверждай, что инструмент работает, пока это не проверено.

- Материал: api-documentation-patterns (skill), страница для человека: /r/api-documentation-patterns
- Проверка источника 2026-10-13, обновлено 2026-10-18

## Цель

Агент опишет endpoint вместе с ошибками и примерами ответов

Описание API с параметрами, авторизацией, пагинацией и реальными ответами.

Skill alphaagent-team задаёт структуру REST и GraphQL документации: параметры, обязательность, коды ошибок, авторизация и SDK-примеры. Он полезен для проверки полноты одного endpoint. Примеры пользователей, токенов и схем внутри инструкции демонстрационные; источником контракта вашего продукта остаётся его реализация.

## Источники

- Первоисточник и инструкция: https://github.com/bradtaylorsf/alphaagent-team/blob/9507e282b1ebd1a04cc9c3d32d05153e0c4ef898/plugins/aai-docs/skills/api-documentation/SKILL.md

## Требования

- Skill api-documentation и реальный API-контракт или исходники; тестовая среда для запросов без изменения production-данных.

## Совместимость

- Agent Skills: уровень проверки не указан; По инструкции автора; версия клиента: не указана; проверка без даты. Условия окружения указаны ниже.

## Риски

- Примеры токенов и ответов нельзя принимать за рабочие настройки. Запросы с записью требуют отдельного разрешённого тестового контура.

## Порядок действий

Сначала проверьте условия и права в первоисточнике. Шаги ниже описывают ограниченный первый сценарий; внешняя запись, публикация и платный запуск требуют разрешённого вами scope.

1. Подготовить ограниченный сценарий: Skill api-documentation и реальный API-контракт или исходники; тестовая среда для запросов без изменения production-данных.

Руководство: https://github.com/bradtaylorsf/alphaagent-team/blob/9507e282b1ebd1a04cc9c3d32d05153e0c4ef898/plugins/aai-docs/skills/api-documentation/SKILL.md

2. Применить к одной задаче: Документируй один реальный endpoint: параметры, права, успешный ответ, ошибки и пагинацию. Свяжи каждый пример с кодом или ответом тестовой среды.

```text
Документируй один реальный endpoint: параметры, права, успешный ответ, ошибки и пагинацию. Свяжи каждый пример с кодом или ответом тестовой среды.
```

Руководство: https://github.com/bradtaylorsf/alphaagent-team/blob/9507e282b1ebd1a04cc9c3d32d05153e0c4ef898/plugins/aai-docs/skills/api-documentation/SKILL.md

3. Проверить результат: Один успешный запрос и одна ошибка воспроизводятся; типы, обязательные поля и статус-коды совпадают с документом.

Руководство: https://github.com/bradtaylorsf/alphaagent-team/blob/9507e282b1ebd1a04cc9c3d32d05153e0c4ef898/plugins/aai-docs/skills/api-documentation/SKILL.md

## Как проверить результат

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