api-field-descriptions
Provides specific patterns for documenting API field descriptions with clear templates for different data types. Includes table formats, required/optional indicators, and practical examples for UUIDs, strings, enums, booleans, and other common field types.
Packaged view
This page reorganizes the original catalog entry around fit, installability, and workflow context first. The original raw source lives below.
Install command
npx @skill-hub/cli install lerianstudio-ring-api-field-descriptions
Repository
Skill path: tw-team/skills/api-field-descriptions
Provides specific patterns for documenting API field descriptions with clear templates for different data types. Includes table formats, required/optional indicators, and practical examples for UUIDs, strings, enums, booleans, and other common field types.
Open repositoryBest for
Primary workflow: Write Technical Docs.
Technical facets: Tech Writer, Backend, Data / AI.
Target audience: Documentation teams looking for install-ready agent workflows..
License: Unknown.
Original source
Catalog source: SkillHub Club.
Repository owner: LerianStudio.
This is still a mirrored public skill entry. Review the repository before installing into production workflows.
What it helps with
- Install api-field-descriptions into Claude Code, Codex CLI, Gemini CLI, or OpenCode workflows
- Review https://github.com/LerianStudio/ring before adding api-field-descriptions to shared team environments
- Use api-field-descriptions for documentation workflows
Works across
Favorites: 0.
Sub-skills: 0.
Aggregator: No.