skills.rest
foxzool
foxzoolCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

openlark-api-validation

Compare exported API CSV to Rust source for coverage reports.

103|27|Updated Apr 9, 2024
Search Tags:#reporting#coverage#api-validation#ci#openlark#csv-comparison
One-click install
npx skills add https://github.com/foxzool/open-lark --skill openlark-api-validation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: openlark-api-validation
Source: https://github.com/foxzool/open-lark/tree/main/.agents/skills/openlark-api-validation
Command: npx skills add https://github.com/foxzool/open-lark --skill openlark-api-validation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the detection of missing, extra, and implemented API definitions by comparing the exported API CSV with the repository source, removing manual and error-prone inspection work when maintaining large SDK crates.

Core Features & Use Cases

  • CSV vs Code Comparison: Cross-check api_list_export.csv entries against actual Rust source files to identify missing implementations.
  • Per-crate and per-bizTag Reports: Generate human-readable Markdown reports with overall statistics, module breakdowns, missing API lists, and extra files.
  • CI / Pre-commit Integration: Run as part of CI pipelines or pre-commit hooks to enforce API coverage and keep CSV mappings in sync.

Quick Start

Run the tools/validate_apis.py script against the target crate or source directory with api_list_export.csv to produce a markdown coverage report.

Frequently Asked Questions about openlark-api-validation

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

FAQPage Schema
How do I validate API coverage by comparing exported CSV files against Rust source code?▼

OpenLark API validation cross-checks api_list_export.csv entries against actual Rust source files to identify missing implementations. It detects missing, extra, and implemented APIs by comparing exported API definitions with repository implementations automatically.

Can I generate per-crate or per-bizTag API coverage reports in Markdown?▼

OpenLark API validation generates human-readable Markdown reports with overall statistics, module breakdowns, missing API lists, and extra files. It supports both per-crate and per-bizTag reporting for granular coverage analysis across SDK crates.

How do I integrate API validation into CI pipelines or pre-commit hooks?▼

OpenLark API validation integrates into CI pipelines or pre-commit hooks by running the tools/validate_apis.py script against target crates with api_list_export.csv. This enforces API coverage and keeps CSV mappings in sync during automated builds or commits.

What files and directory mappings are required to run OpenLark API coverage validation?▼

Running OpenLark API coverage validation requires the api_list_export.csv file, the tools/validate_apis.py script, and correct crate src mappings in the repository. These inputs are needed to compare exported APIs against source implementations and generate reports.

Why do I have extra or missing APIs when maintaining large Rust SDK crates?▼

Missing or extra APIs occur when exported CSV mappings fall out of sync with repository source code. OpenLark API validation solves this by automating the detection of missing, extra, and implemented API definitions, removing manual and error-prone inspection work.

Related Skills

Explore More Software Engineering Skills→
blueif16blueif16

create-command

Create slash command files and initialize plugin structure in Claude plugins.

Community
Basic
chrislyonschrislyons

test.result.analyzer

Parse ctest, Google Test, and sanitizer reports to generate Markdown test analysis summaries.

Community
Intermediate
ZaxbyHubZaxbyHub
437

rust-crate-ci

Run pre-push validation for the swarm-sandbox-runner Rust crate.

Official
Intermediate
vvieira010-pixelvvieira010-pixel

coverage-audit

Audit curriculum frameworks against external requirements and generate coverage tables.

Community
Intermediate