Skip to main content

SDK Generator

The vectrade-sdk-generator is an internal tool that ensures all VecTrade SDKs remain aligned with the API contract defined in the OpenAPI spec.
This tool is primarily for VecTrade SDK maintainers and contributors. End users should use the published SDKs directly.

What It Does

  1. Contract Validation — Verifies that SDK implementations match the OpenAPI spec exactly
  2. Coverage Analysis — Reports which endpoints each SDK covers
  3. Alignment Testing — Cross-references Python, Node, and CLI implementations
  4. Report Generation — Produces coverage reports for CI pipelines

Installation

Usage

Validate Contracts

Generate Coverage Report

Run Alignment Check

Contract Files

The generator uses YAML contract files (one per resource group):

CI Integration

The SDK generator runs in CI for all SDK repositories:

Architecture

GitHub Repository

Source code, contract definitions, and CI integration guides.