Skills
.Work. You
Rest

update-contest-api-docs

Community

Sync contest API OpenAPI docs with code.

Software Engineering#documentation#api#openapi#contest#update#schemas
AuthorThe-INTJ
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Keeps the OpenAPI documentation for the /api/contest endpoints in sync with the actual API implementation as routes evolve.

Core Features & Use Cases

  • Analyze all relevant route files under app/api/contest (current, contests, entries, scores, docs) to extract HTTP methods, path parameters, and request/response schemas.
  • Update the OpenAPI file at app/api/contest/openapi.json to reflect current implementation and ensure consistency with existing components/schemas and the security scheme.
  • Provide a maintainable spec that supports developers and tooling by documenting endpoints, request bodies, and response structures.

Quick Start

After updating any contest API route, run the skill to refresh and align the OpenAPI specification.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: update-contest-api-docs
Download link: https://github.com/The-INTJ/item-dc-calculator/archive/main.zip#update-contest-api-docs

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.