Can I manually edit the generated OpenAPI YAML file?

No, this skill enforces a guardrail against hand-editing generated files to ensure the Rust implementation remains the single source of truth.

What is API drift in the ICN ecosystem?

API drift occurs when the actual implementation of the ICN gateway routes diverges from the exported OpenAPI specification or the generated TypeScript SDK, leading to broken integrations.

How does this skill automate SDK updates?

The skill executes a workflow that builds the icnctl utility to export the latest OpenAPI spec and then triggers the npm build scripts within the TypeScript SDK directory to refresh types.

Does this skill run tests during the synchronization process?

Yes, it validates gateway behavior using cargo test with the sled-storage feature to ensure the API is functional before regenerating artifacts.

When is it necessary to trigger the OpenAPI Sync skill?

It should be triggered whenever changes are made to the icn-gateway crates, shared API models, or any authentication logic that affects endpoint contracts.

ICN Gateway OpenAPI Sync

Name: ICN Gateway OpenAPI Sync
Author: InterCooperative-Network

byInterCooperative-Network

•

Desarrollo de API

Synchronizes ICN gateway API implementations with OpenAPI specifications and TypeScript SDK types to prevent integration drift.

The ICN Gateway OpenAPI Sync skill automates the critical workflow of keeping the InterCooperative Network (ICN) gateway's backend behavior in perfect alignment with its external interface definitions. By providing a structured process to validate API routes, regenerate OpenAPI documentation via icnctl, and update TypeScript SDK types, it ensures that backend changes are immediately and accurately reflected in client-side tools. This skill is essential for developers working on the ICN substrate who need to maintain strict contract consistency and avoid integration defects caused by API drift.

Características Principales

01Automated OpenAPI specification generation from Rust source code

02TypeScript SDK type synchronization and validation

03Integrated testing for icn-gateway with sled-storage

04Real-time API drift detection and reporting

055 GitHub stars

06Consistency checks for auth scopes and status code semantics

Casos de Uso

01Updating API authentication scopes or response status behaviors

02Synchronizing client-side TypeScript types with backend API changes

03Modifying ICN gateway routes or request/response models

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add intercooperative-network/icn icn-gateway-openapi-sync

For use in Claude.ai and ChatGPT

Download Skill