ores-http-recipes

Compare API route definitions against HTTP recipe documentation to detect mismatches.

25|5|Updated Jun 15, 2024
One-click install
npx skills add https://github.com/OreStudio/OreStudio --skill ores-http-recipes
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ores-http-recipes
Source: https://github.com/OreStudio/OreStudio/tree/main/.claude/skills/ores-http-recipes
Command: npx skills add https://github.com/OreStudio/OreStudio --skill ores-http-recipes

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps maintain consistent API documentation by ensuring HTTP endpoint recipes stay synchronized with the actual route implementations.

Core Features & Use Cases

  • Route-documentation synchronization: Detects undocumented or outdated HTTP recipes by comparing source routes to doc/recipes/http_recipes.org.
  • Change-tracking: Highlights mismatches when routes change or new endpoints appear.
  • Use Case: When a new endpoint is added to projects/ores.http.server/src/routes, generate a corresponding recipe entry in doc/recipes/http_recipes.org, or flag missing entries for manual update.

Quick Start

Run a comparison between the project's route definitions and doc/recipes/http_recipes.org to surface missing or changed entries.

Frequently Asked Questions about ores-http-recipes

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep API documentation synchronized with live route implementations?

To keep API documentation synchronized, compare endpoint definitions like paths, methods, and headers against documented recipes to detect outdated or missing routes and generate updates accordingly.

What is the best way to detect undocumented HTTP endpoints in source files?

Detect undocumented HTTP endpoints by comparing source route definitions against documented recipes in http_recipes.org, which highlights mismatches when new endpoints appear or existing routes change.

How do I update http recipes when API routes change?

Update http recipes by running a comparison between route definitions and recipe entries to surface missing or changed endpoints, then generate corresponding recipe entries for updates.

Can I validate required headers against documented recipes?

Yes, you can validate required headers by comparing endpoint definitions including paths, methods, and headers against documented recipes to identify mismatches and ensure documentation consistency.

Does route-documentation synchronization work without external dependencies?

Route-documentation synchronization works without external dependencies, directly analyzing source files and the http_recipes.org file to flag missing entries and track route changes.