Update API Reference

Generates API reference + guides updates from new schema changes with samples and changelog entries.

Published by @gtmagents·from gtmagents/gtm-agents·0 agent reads / 30d·0 saves·

Command: update-api-reference

Inputs

  • spec – OpenAPI/AsyncAPI file path or URL.
  • audience – developers | partners | internal | admins.
  • outputs – reference, guide, changelog, tutorial (comma-separated).
  • languages – code sample languages (js, python, curl, java, go, ruby, csharp).
  • breaking-change – true/false toggle for migration guidance.

Workflow

  1. Spec Diff & Analysis – compare schema version vs prior baseline, note new/changed/deprecated endpoints.
  2. Content Scope – determine docs to update (reference tables, tutorials, SDK snippets, changelog entries).
  3. Drafting – produce updated endpoint descriptions, parameters, responses, usage notes, and code samples per language.
  4. Review Loop – route drafts to engineering/product for validation and to editorial for style compliance.
  5. Publishing & Versioning – push updates, tag version support, update changelog + migration guidance.

Outputs

  • Updated API reference markdown/HTML with highlighted changes.
  • Code sample bundle per requested languages.
  • Changelog excerpt + migration guidance (if applicable).

Agent/Skill Invocations

  • api-docs-editor – leads spec diff + doc updates.
  • documentation-architect – ensures IA + governance alignment.
  • api-style-guide skill – enforces terminology, formatting, and code sample rules.
  • versioning-dashboard skill – logs version info + deprecation timelines.

More on the bench

SKILL0

Skill Creator

Create new skills, modify and improve existing skills, and measure skill performance. Use when users want to create a skill from scratch, edit, or optimize an existing skill, run evals to test a skill, benchmark skill performance with variance analysis, or optimize a skill's description for better triggering accuracy.

ai-prompt-engineering+1
6
SKILL0

Bash Pro

Master of defensive Bash scripting for production automation, CI/CD pipelines, and system utilities. Expert in safe, portable, and testable shell scripts.

ai-prompt-engineering+3
4
SKILL0

Documentation

Creates, structures, and reviews technical documentation following the Diátaxis framework (tutorials, how-to guides, reference, and explanation pages). Use when a user needs to write or reorganize docs, structure a tutorial vs. a how-to guide, build reference docs or API documentation, create explanation pages, choose between Diátaxis documentation types, or improve existing documentation structure. Trigger terms include: documentation structure, Diátaxis, tutorials vs how-to guides, organize docs, user guide, reference docs, technical writing.

software-engineering
4