Intelliflo Public API Report & Swagger Generator

Generate Public API reports and consolidated OpenAPI 3.0 swagger files.

Updated Nov 11, 2025
One-click install
npx skills add https://github.com/Nshai/Public-API-Report --skill intelliflo-public-api-report-swagger-generator
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Intelliflo Public API Report & Swagger Generator
Source: https://github.com/Nshai/Public-API-Report/tree/main/.claude/skills/api-report-run
Command: npx skills add https://github.com/Nshai/Public-API-Report --skill intelliflo-public-api-report-swagger-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Consolidates service swagger data, filters operations by PublicApi attributes or API Gateway whitelist, and generates comprehensive Public API reports and OpenAPI 3.0 swagger files.

Core Features & Use Cases

  • Unified end-to-end workflow for generating Public API inventories and consolidated Swagger files.
  • Dual-version support (v1 and v2) with portal status tracking for each operation.
  • Template-driven generation using Public Swagger v2 as the canonical structure, including OAuth scopes and server metadata.
  • Outputs include markdown reports and OpenAPI swagger artifacts suitable for portal publication.

Quick Start

Run the full end-to-end workflow from the tools directory to refresh all API documentation.

Frequently Asked Questions about Intelliflo Public API Report & Swagger Generator

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

FAQPage Schema
How do I automate generating a consolidated swagger file from multiple services?

You can automate consolidated swagger generation by filtering operations using PublicApi attributes or an API Gateway whitelist, then applying OpenAPI 3.0 templating to fetch and merge v1 and v2 swagger files into a unified output.

How does filtering public API operations by API Gateway whitelist work?

API Gateway whitelist filtering works by extracting GitHub data to identify permitted operations, cross-referencing them against your service swagger definitions, and excluding any endpoints not explicitly authorized for portal-ready documentation.

Can I generate markdown API reports alongside OpenAPI 3.0 swagger artifacts?

Yes, the generation workflow outputs both markdown API reports and OpenAPI 3.0 swagger artifacts simultaneously. The markdown provides a readable inventory while the swagger files supply the structured specification for portal publication.

What's the best way to consolidate v1 and v2 swagger files for a developer portal?

The best way to consolidate swagger versions is using Public Swagger v2 as the canonical template structure, which captures OAuth scopes and server metadata while tracking portal status for each operation across both versions.

Does this API report generation approach require GitHub data extraction?

Yes, GitHub data extraction is required to identify and filter PublicApi attributes across your repositories. This extraction provides the necessary repository metadata to determine which operations belong in the consolidated public API report.

When do I need to regenerate consolidated public API swagger files?

You need to regenerate consolidated public API swagger files when services are updated, new endpoints receive PublicApi attributes, or API Gateway whitelist configurations change, ensuring portal documentation accurately reflects the current authorized operations.