nacos-api-doc-update

Sync Swagger/OpenAPI api.json with Nacos markdown docs via per-endpoint updates.

115|205|Updated Jul 20, 2018
One-click install
npx skills add https://github.com/nacos-group/nacos-group.github.io --skill nacos-api-doc-update
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: nacos-api-doc-update
Source: https://github.com/nacos-group/nacos-group.github.io/tree/main/.agents/skills/nacos-api-doc-update
Command: npx skills add https://github.com/nacos-group/nacos-group.github.io --skill nacos-api-doc-update

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

The Nacos API documentation often drifts from the underlying Swagger/OpenAPI specs; this Skill automates refreshing the api.json and updating the markdown docs in place to reflect the latest API definitions, reducing drift and manual effort.

Core Features & Use Cases

  • Auto-refresh and validate api.json from Swagger/OpenAPI for console, admin, and client APIs.
  • Compare generated markdown fragments with existing docs and apply targeted in-place updates (add/remove params, fix URLs, adjust curl samples) without overwriting manual notes.
  • Supports exemptions and per-endpoint rules to avoid unintended changes when APIs are deprecated or ignored.

Quick Start

Run the update to synchronize all OpenAPI docs from the latest api.json into the repository.

Frequently Asked Questions about nacos-api-doc-update

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

FAQPage Schema
How do I sync Nacos API markdown docs with Swagger OpenAPI specs?

To sync Nacos API markdown docs with Swagger OpenAPI specs, this Skill automates refreshing the api.json and updates markdown documentation in place, comparing changes per endpoint to reflect the latest API definitions.

Can I update API documentation parameters without overwriting manual markdown notes?

You can update API parameters, URLs, and curl examples without overwriting manual markdown notes, because this Skill applies targeted in-place updates to existing docs and preserves manual edits during the synchronization process.

What is the best way to automate refreshing api.json for Nacos console and admin APIs?

The best way to automate refreshing api.json for Nacos console and admin APIs is using this Skill to auto-refresh and validate the Swagger/OpenAPI definitions, then apply targeted markdown updates to reduce documentation drift.

Does updating Nacos OpenAPI documentation generate a diff report for review?

Updating Nacos OpenAPI documentation generates a diff report for review, enforcing safety rules by attempting curl refreshes first and avoiding bulk replacements to ensure you can verify all parameter and endpoint changes before finalizing.

How do I prevent unintended changes when syncing deprecated Nacos API endpoints?

To prevent unintended changes when syncing deprecated Nacos API endpoints, this Skill supports exemptions and per-endpoint rules, allowing you to avoid overwriting docs when specific APIs are deprecated or ignored.

Why does Nacos API documentation drift from the underlying Swagger specs?

Nacos API documentation drifts from underlying Swagger specs when manual markdown updates lag behind code changes, a problem this Skill solves by automating the synchronization of api.json definitions directly into the repository docs.