Changelog
Track all notable changes to OpenAPI Sync. We follow Semantic Versioning.
v6.4.2
patch- •add official Model Context Protocol Registry verification with mcpName declaration
- •streamline MCP marketplace integrations and documentation across Cursor Directory, Glama, and Antigravity
- •remove unpublished registries and add direct deep-link 1-click install support
v6.4.1
patch- •publish official standalone openapi-sync-mcp package on npm for zero-install agent workflows
- •add mcp subcommand to main openapi-sync CLI (npx openapi-sync mcp)
- •expand MCP documentation and host setup guides for Cursor, Claude Desktop, Windsurf, and Zed
- •add comprehensive guide to all 4 ways humans and AI agents can access and query the MCP server
v6.4.0
minor- •default output folder is now project root (""), writing directly to ./<apiName>/ without artificial nesting
- •preserve empty baseURL by default in generated clients without unintended URL inference
- •add next-fetch preset and client generation with Next.js App Router caching headers and revalidation
- •add openapi_sync_purge MCP tool and expose complete auth flags and CLI overrides across all 10 MCP tools
- •support full CLI spec authentication flags (--auth-type, --auth-token, etc.) across init, sync, validate, and doctor
- •ensure manifest tracks client type switches to prevent purge from deleting active client files
- •ensure list-endpoints and get-endpoint inspection commands are side-effect free and never write source code
- •provide actionable recovery guidance and SPEC_FETCH_FAILED error codes for 401/403 protected specs
- •support CLI flag aliases across all commands (--output-folder / --folder, --validation-library / --validation-lib)
- •support boolean or object format for infiniteQueries configuration
v6.3.2
patch- •fix schema duplicate type generation preventing conflicting declarations (e.g. duplicate IPet in OpenAPI 3.0 specs)
- •implement robust balanced-bracket type declaration extraction in read-type ensuring full untruncated output with internal comments and JSDocs
- •add optional offset and max-lines pagination support for read-type in programmatic API, CLI, and MCP
- •add in-memory TypeScript config transformation via esbuild for seamless programmatic ESM usage without require hooks
- •add openapi_sync_doctor tool to MCP server for AI agent diagnostics (total 9 MCP tools)
- •add output folder nesting diagnostic warning in doctor command when folder matches API name
- •align dry-run planned file paths accurately with actual sync output in both flat and tag-split modes
v6.3.1
patch- •resolve ESM programmatic import and module syntax issues with tsup shims and __dirname elimination
- •relocate persistent cache to .openapi-sync/cache.json in project root and optimize --use-cache latency
- •fix dry-run path calculations to accurately reflect configured folder and client output directory
- •support flexible endpoint filtering by operationId, generated name, or path with comma-separated token support
- •validate peer dependencies at generation time for react-query, swr, axios, rtk-query, zod, yup, and joi
- •add openapi-sync doctor diagnostic command and programmatic API
- •add $schema references to generated config scaffolds and expose filterKey in list-endpoints --json
- •include ISC license and declare complete package exports map in package.json
v6.3.0
minor- •declare esbuild direct dependency to fix packaging in CI and fresh installs
- •enforce pure JSON stdout when --json is passed across all commands
- •bundle interactive-init entry module and improve non-interactive init -y flow
- •track all client files in filesWritten and separate sync vs client phases in JSON results
- •support compact dry-run output previewing planned file paths without verbosity
- •implement full path parameter pipeline: $ref resolution, schema-derived URL builder parameter types, doc separation, and typed client method calls
- •safely handle schema-less tags by emitting empty types.ts fallbacks and omitting unused type imports in client generators
- •sanitize Python identifiers for class names, DTOs, query types, and endpoint constants
- •enhance get-endpoint lookup with exact, cross-match, normalized, and case-insensitive resolution
- •expand read-type to resolve types across tag folders and shared.ts
- •clarify folderSplit to preserve clean flat layouts when omitted or empty ({})
- •support clientGeneration.outputDir in folder-split mode with automatic relative import resolution
v6.2.0
minor- •ship the latest agent-friendly release with CLI, MCP, and cache-aware endpoint workflows
- •add richer endpoint discovery, pagination, filtering, and deeper endpoint inspection for AI agents
- •expand generated-type inspection and MCP tooling for faster local debugging and automation
v6.1.1
minor- •add cache-aware endpoint reuse for list-endpoints and generate-client workflows
- •add paged endpoint listing with path filtering and offset/limit support
- •add deep endpoint detail lookup for AI agents and CLI inspection flows
- •add generated type declaration inspection for agent-friendly code exploration
- •expand the built-in MCP server with list-endpoints, endpoint-detail, and generated-type tools
v6.1.0
minor- •update Open Collective link to use the correct project handle in README files
- •update Patreon link to use the correct project handle in README files
- •update video tutorial durations and remove placeholder video IDs for clarity
- •add API endpoint definitions and supporting documentation files
- •add documentation and sample specification files for OpenAPI Sync project
- •add donation options and links to README and footer for project support
- •add programmatic API support, machine-readable JSON output for CLI, and agent-safe commands.
- •add runtime validation schema generation support with Zod, Yup, and Joi, including configuration options for selective validation and custom naming
- •add sample OpenAPI specification, supporting artifacts, and documentation schema files
- •Add sample OpenAPI specification, video scripts, and update website contributor display.
- •enhance API client generation with support for headers configuration and infinite query hooks
- •enhance folder splitting configuration for organized code generation with custom logic and tag-based organization
- •enhance OpenAPI sync functionality with auto-sync capability
- •generate typescript API endpoint definitions from OpenAPI specification
- •implement endpoint filtering and operationId-based naming in OpenAPI sync configuration
- •implement folder splitting configuration for generated code based on tags and custom functions
- •introduce custom code preservation functionality with configurable markers and instructions in generated files
- •Introduce OpenAPI specification for authentication and developer endpoints, including supporting files and tests.
- •major release v5.0.0 with enhanced client generation, improved TypeScript support, and comprehensive documentation updates
v6.0.0
major- •Major bump for new architecture and LLM agent integration
v5.0.7
patch- •Update dependencies and fix minor bugs
v5.0.6
patch- •Fix runtime validation schemas resolution
v5.0.5
patch- •Bump version to 5.0.5, update website content, and add sample OpenAPI specification, generated endpoint definitions, and video scripts
- •Equate generated classes with return types instead of using 'value: return types'
- •Fixed errors with python codegen
v5.0.4
patch- •chore: bump version to 5.0.4 in package.json and improve TypeScript type rendering
v5.0.3
patch- •chore: bump version to 5.0.3 in package.json and enhance OpenAPI spec handling
- •docs: add troubleshooting section for macOS Big Sur esbuild installation error
v5.0.2
patch- •chore: bump version to 5.0.2 in package.json
v5.0.1
patch- •chore: bump version to 5.0.1 in package.json
v5.0.0
major- •🎉 MAJOR: Complete client generation overhaul with bug fixes and improvements
- •✅ Fixed SWR mutation hooks type errors - Correct argument type nesting
- •✅ Fixed Fetch client naming conflicts - Auto-aliased endpoint imports with _endpoint suffix
- •✅ Fixed Fetch client default exports - Added named apiClient variable for ESLint compliance
- •✅ Fixed RTK Query folder split - Generates apis.ts with setupApiStore helper for minimal Redux configuration
- •✅ Fixed RTK Query reducer paths - Each API slice now has unique reducerPath based on folder name
- •✅ Fixed CLI argument precedence - CLI options now correctly override config file settings
- •📚 Enhanced SWR hooks - Added comprehensive inline documentation with 230+ lines of usage examples
- •🚀 Improved interactive setup - Automatically enables byTags when folder splitting is selected
- •📦 Non-folder-split mode - Now generates single clients.ts and hooks.ts files at root level
- •🎨 Better developer experience - All generated files include copy-paste-ready examples
- •⚡ Performance improvements - Optimized build and generation processes
v4.0.2
patch- •chore: update version to 4.0.2 in package.json and remove optional peer dependencies
v4.0.1
patch- •Fix minor issues in validation generation
v4.0.0
major- •Added validation schema generation support (Zod, Yup, Joi)
- •Enhanced type generation with better nullable handling
- •Improved documentation generation
- •Breaking: Updated configuration structure for validations
v3.0.2
patch- •chore: update version to 3.0.2 in package.json, enhance custom code extraction logic in helpers.ts, and default type to 'any' in index.ts
v3.0.1
patch- •chore: update version to 3.0.1 in package.json and modify type handling in index.ts to default to 'any'
v3.0.0
major- •Release v3.0.0 with new type extraction logic
v2.1.17
patch- •chore: update version to 2.1.17 in package.json, adjust build scripts, and modify tsup configuration to disable source maps
v2.1.16
patch- •Update tsup build settings
v2.1.15
patch- •Fix type exports
v2.1.14
patch- •chore: update version to 2.1.14 in package.json
v2.1.13
patch- •Fix dts type fixes
- •Clean up tsup build config
- •Introduction of unit testing
- •Improved build performance
v2.1.12
patch- •Add automatic sync support for function-based config
- •Improved handling of missing OpenAPI urls
- •Better error messages
v2.1.11
minor- •Folder splitting configuration for organized code generation
- •Support for tag-based folder organization
- •Custom folder logic support
v2.1.10
minor- •OperationId-based naming for types and endpoints
- •Enhanced filtering and tag support
- •Better endpoint exclusion/inclusion logic
v2.1.9
patch- •correct file extension for OpenAPI sync configuration path
- •enhance JSONStringify function to support array serialization and improve object handling
v2.1.8
patch- •add support for endpoint tags in generated API documentation and update README for clarity
v2.1.7
patch- •add repository metadata and enhance README with comprehensive documentation and usage examples
v2.1.6
patch- •enhance configuration loading by allowing configJS to be a function and update build script to clean dist directory before compilation
v2.1.5
patch- •enhance name formatting functions to include defaultName parameter in OpenAPI sync configuration
- •re-export modules and update package exports for improved usability
v2.1.4
patch- •refactor configuration loading and enhance type handling in OpenAPI sync
v2.1.3
patch- •add support for TypeScript configuration loading and improve config file handling
v2.1.2
patch- •extend OpenAPI schema types to include 'null' and improve type handling for arrays and enums
v2.1.1
patch- •Routine maintenance and dependency updates
v2.1.0
minor- •update OpenAPI configuration to support string server URLs and enhance endpoint content formatting
v2.0.2
patch- •enhance endpoint naming configuration to support operationId and improve formatting options
v2.0.1
patch- •add TODO.md to .gitignore and ensure openapi.sync.json is properly ignored
- •update API key header handling for improved security schema support
- •update publish-package script to use patch versioning
- •enhance type resolution and add description support in schema types
- •initialize database file if it doesn't exist and enhance OpenAPI configuration
v2.0.0
major- •restructure project and enhance type definitions for OpenAPI integration
v1.0.25
patch- •Routine maintenance and dependency updates
v1.0.24
patch- •ensure additionalProperties defaults to 'any' in schema parsing
v1.0.23
patch- •handle database loading with error handling for state initialization
v1.0.22
patch- •add boolean type to IOpenApSchemaSpec
- •enhance schema parsing to support additionalProperties and array item types
v1.0.21
patch- •handle more schema type
v1.0.20
patch- •Routine maintenance and dependency updates
v1.0.19
patch- •Routine maintenance and dependency updates
v1.0.17
patch- •Routine maintenance and dependency updates
v1.0.15
patch- •Routine maintenance and dependency updates
v1.0.14
patch- •Routine maintenance and dependency updates
v1.0.13
patch- •allow endpoint value treatment
- •create IConfigReplaceWord
v1.0.12
patch- •accept options when initialize openapi-sync
- •add refreshinterval flag to CLI
- •create db.json
v1.0.11
patch- •Routine maintenance and dependency updates
v1.0.10
patch- •Routine maintenance and dependency updates
v1.0.9
patch- •Routine maintenance and dependency updates
v1.0.8
patch- •Routine maintenance and dependency updates
v1.0.7
patch- •Routine maintenance and dependency updates
v1.0.6
patch- •Routine maintenance and dependency updates
v1.0.5
patch- •Routine maintenance and dependency updates
v1.0.4
patch- •Routine maintenance and dependency updates
v1.0.3
patch- •Routine maintenance and dependency updates
v1.0.2
patch- •Routine maintenance and dependency updates
v1.0.1
patch- •Routine maintenance and dependency updates
v1.0.0
major- •Routine maintenance and dependency updates
Stay Updated
Follow the project on GitHub to get notified about new releases and updates.