Skip to content

CHANGELOG.md

Latest commit

 

History

History
78 lines (65 loc) · 3.86 KB

CHANGELOG.md

File metadata and controls

78 lines (65 loc) · 3.86 KB

Changelog

All notable changes to the LeadMagic OpenAPI specification will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

Changed

  • README: companion-surfaces table and pairing copy for leadmagic-cursor-plugin (skills, rules, agent, commands, OAuth MCP); contrast with local stdio plugins (e.g. Encore); hosted MCP section lists 10 tools with REST hints and jobs/ads API-only note
  • Synced top-level repository docs to the current leadmagic.io/docs route layout under /v1/...
  • Reworked the smoke-test utility as test-api.ts with typed test cases, secure interactive API-key entry, compact output previews, and pass/fail reporting against current documented endpoints
  • Updated LLM-oriented docs to stop claiming full parity with the public docs when docs-only endpoints now exist outside this local snapshot
  • Clarified how this OpenAPI snapshot aligns with the hosted MCP setup and the public Cursor plugin package
  • Clarified that the current MCP surface includes competitors, technographics, and job-change tooling, while ad-search endpoints remain part of the broader API snapshot rather than the current MCP tool set
  • Removed stale blanket claims that all current responses use uniform snake_case naming

Clarified

  • This repository still models the 19 core endpoints already present locally, while the live docs currently expose additional APIs such as analytics, technographics, competitors search, and extra jobs metadata endpoints

[1.0.0] - 2025-01-26

Added

  • 🎯 Complete OpenAPI 3.1 specification for LeadMagic API
  • 📋 Full documentation for all 19 API endpoints:
    • Credits management
    • Email services (validation, finding, enrichment)
    • Mobile & contact services
    • Profile & people services
    • Company services (search, funding intelligence)
    • Jobs services (search, metadata)
    • Advertisement intelligence (Google, Meta, B2B)
  • ✨ 249 comprehensive examples in OpenAPI 3.1 format
  • 🔐 Secure testing framework with environment variable configuration
  • 📚 Platform-agnostic documentation (no vendor lock-in)
  • 🧪 Comprehensive test suite for all endpoints
  • 💰 Transparent credit cost documentation
  • 🛠️ Developer-friendly features:
    • Copy-paste ready curl examples
    • Real API response examples
    • Multi-language code generation support
    • Rate limiting documentation
    • Complete error handling specifications

Features

  • Authentication: API key-based authentication via X-API-Key header
  • HTTP Methods: POST for data endpoints, GET for metadata
  • Error Handling: Standardized error response format
  • Security: Environment variable configuration, no hardcoded credentials

Technical Details

  • OpenAPI Version: 3.1.0
  • JSON Schema: 2020-12 support
  • File Formats: Both YAML (60,883 bytes) and JSON (90,756 bytes)
  • Examples: All using OpenAPI 3.1 examples format (no legacy example fields)
  • Validation: Complete schema validation for all endpoints

Documentation

  • Complete API reference with 19 endpoints
  • Use case examples for sales, recruitment, and business intelligence
  • Environment setup instructions
  • Credit consumption breakdown
  • Platform-agnostic B2B profile integration
  • Comprehensive testing and validation guide

Repository Setup

  • MIT License
  • Contributing guidelines
  • GitHub issue templates (bug reports, feature requests, documentation)
  • GitHub Actions for automated validation
  • Professional repository metadata with topics and description

For the current credit cost table and route mapping, see the README. The 1.0.0 snapshot above documented the legacy unversioned routes; see the [Unreleased] section for the current /v1/... layout.