Releases: speakeasy-api/openapi
v1.8.0
🧹 New Feature: Sanitize Command
This release introduces a new sanitize command that removes non-standard extensions and unknown properties from OpenAPI specifications, helping you create clean, standards-compliant API documentation.
✨ Key Features
- Extension Removal: Automatically removes all
x-*extensions and other non-standard properties - Pattern Matching: Keep specific extensions using glob patterns (e.g.,
x-speakeasy-*) - Flexible Configuration: Use command-line flags or YAML config files
- Component Cleanup: Optional removal of unused component schemas
- JSON Schema Support: Also cleans non-standard properties from JSON Schema definitions
📖 Usage
Basic usage - remove all extensions:
openapi sanitize openapi.yamlKeep specific extensions:
openapi sanitize openapi.yaml --keep-extensions "x-speakeasy-*,x-internal-*"Use configuration file:
openapi sanitize openapi.yaml --config sanitize-config.yamlExample config file:
extensions:
keep:
- x-speakeasy-*
- x-internal-*
components:
removeUnused: true📚 Documentation
Full documentation and examples are available in openapi/cmd/README.md.
🔧 Implementation Details
- Added
Sanitize()function inopenapi/sanitize.go - Added CLI command in
openapi/cmd/sanitize.go - 10 comprehensive test cases with various scenarios
- Integrated with CI pipeline
🙏 Credits
This feature was requested and inspired by @zdunecki in Issue #46.
Full Changelog: v1.7.12...v1.8.0
OpenAPI CLI v1.8.0
This release includes binaries for Linux, macOS, and Windows on both x86_64 and ARM64 architectures.
Installation
Download the appropriate binary for your platform from the assets below, extract it, and add it to your PATH.
Changes
Changelog
Features
Bug fixes
Full Changelog: v1.7.12...v1.8.0
Released by GoReleaser.
v1.7.12
What's Changed
Bug Fixes
- Fixed parent directory references (
../) not being bundled correctly during the bundling process (#58) - References now properly converted to absolute paths for consistent deduplication and proper bundling
- Fixed issue where
../references remained in bundled output instead of being resolved
Code Quality Improvements
- Added helper functions to eliminate code duplication:
isInternalReference()- eliminates ~22 lines of duplicationextractSimpleNameFromReference()- eliminates ~60 lines of duplicationfindCircularReferenceMatch()- eliminates ~26 lines of duplication
- Removed unused
parentLocationparameter (~110 lines total reduction)
Tests
- Added comprehensive test case for issue #50 with parent directory references
- All bundle and inline tests passing (8/8)
Full Changelog: v1.7.11...v1.7.12
Fixes #50
OpenAPI CLI v1.7.12
This release includes binaries for Linux, macOS, and Windows on both x86_64 and ARM64 architectures.
Installation
Download the appropriate binary for your platform from the assets below, extract it, and add it to your PATH.
Changes
Changelog
Bug fixes
- 70b4b68 fix: convert references to absolute paths for proper parent directory handling and deduplication (#58)
Others
Full Changelog: v1.7.11...v1.7.12
Released by GoReleaser.
v1.7.11
Changes
- chore(jsonschema): Add convenience methods for schema and boolean value access (#57)
- Added semantic methods
IsSchema(),GetSchema(),IsBool(),GetBool()to replace less intuitiveLeft/Rightterminology - Updated internal usage throughout the
jsonschema/oas3package - Improved API clarity and developer experience
- Added semantic methods
Full Changelog
OpenAPI CLI v1.7.11
This release includes binaries for Linux, macOS, and Windows on both x86_64 and ARM64 architectures.
Installation
Download the appropriate binary for your platform from the assets below, extract it, and add it to your PATH.
Changes
Changelog
Others
Full Changelog: v1.7.10...v1.7.11
Released by GoReleaser.
v1.7.10
Full Changelog: v1.7.9...v1.7.10
OpenAPI CLI v1.7.10
This release includes binaries for Linux, macOS, and Windows on both x86_64 and ARM64 architectures.
Installation
Download the appropriate binary for your platform from the assets below, extract it, and add it to your PATH.
Changes
Changelog
Bug fixes
- c42a384 fix: use model's RootNode instead of parameter for consistency in GetMapKeyNodeOrRoot methods
Full Changelog: v1.7.9...v1.7.10
Released by GoReleaser.
v1.7.9
Full Changelog: v1.7.8...v1.7.9
OpenAPI CLI v1.7.9
This release includes binaries for Linux, macOS, and Windows on both x86_64 and ARM64 architectures.
Installation
Download the appropriate binary for your platform from the assets below, extract it, and add it to your PATH.
Changes
Changelog
Bug fixes
- b1bc1fe fix: introduced methods for accessing map key nodes for getting line numbers and improved agent testing behaviour
Full Changelog: v1.7.8...v1.7.9
Released by GoReleaser.
v1.7.8
Changes
- Add YAMLToJSONCompatibleGoType function to convert YAML nodes to JSON-compatible Go types
- Add comprehensive test coverage for json package functions
- Fix YAML merge key handling to properly merge referenced maps
- Update mise test task to support package-specific test execution
Bug Fixes
- YAML merge keys are now properly handled, merging referenced map values instead of treating merge key as a literal key
Testing
- Added 34 new tests with full coverage of YAML-to-JSON conversion scenarios
- All tests follow project conventions with parallel execution and testify assertions
OpenAPI CLI v1.7.8
This release includes binaries for Linux, macOS, and Windows on both x86_64 and ARM64 architectures.
Installation
Download the appropriate binary for your platform from the assets below, extract it, and add it to your PATH.
Changes
Changelog
Bug fixes
- a30e6a1 fix(json): add YAMLToJSONCompatibleGoType, tests, and fix YAML merge keys
Full Changelog: v1.7.7...v1.7.8
Released by GoReleaser.
v1.7.7
Full Changelog: v1.7.6...v1.7.7
OpenAPI CLI v1.7.7
This release includes binaries for Linux, macOS, and Windows on both x86_64 and ARM64 architectures.
Installation
Download the appropriate binary for your platform from the assets below, extract it, and add it to your PATH.
Changes
Changelog
Bug fixes
- 903dfce fix: fixed issues with navigating with jsonpointers through unknown properties
Full Changelog: v1.7.6...v1.7.7
Released by GoReleaser.
v1.7.6
Full Changelog: v1.7.5...v1.7.6
OpenAPI CLI v1.7.6
This release includes binaries for Linux, macOS, and Windows on both x86_64 and ARM64 architectures.
Installation
Download the appropriate binary for your platform from the assets below, extract it, and add it to your PATH.
Changes
Changelog
Full Changelog: v1.7.5...v1.7.6
Released by GoReleaser.
v1.7.5
Full Changelog: v1.7.4...v1.7.5
OpenAPI CLI v1.7.5
This release includes binaries for Linux, macOS, and Windows on both x86_64 and ARM64 architectures.
Installation
Download the appropriate binary for your platform from the assets below, extract it, and add it to your PATH.
Changes
Changelog
Bug fixes
- 34d01b0 fix: improved handling of type validation errors and their message content
Full Changelog: v1.7.4...v1.7.5
Released by GoReleaser.
v1.7.4
What's Changed
Bug Fixes
- Improved EitherValue error handling - Enhanced unmarshalling and validation error messages for
EitherValuetypes to make it easier to identify the root cause of failures (#55)- Enhanced error context in unmarshalling to provide clearer information about which type alternatives failed
- Improved validation error formatting to better indicate the source of validation failures
- Updated unmarshaller logic to capture and report more detailed error information
- Added comprehensive test coverage for edge cases
This release improves the developer experience when working with EitherValue types by making validation errors more actionable and easier to debug.
Full Changelog: v1.7.3...v1.7.4
OpenAPI CLI v1.7.4
This release includes binaries for Linux, macOS, and Windows on both x86_64 and ARM64 architectures.
Installation
Download the appropriate binary for your platform from the assets below, extract it, and add it to your PATH.
Changes
Changelog
Bug fixes
- 3e915b0 fix(deps): bump github.com/testcontainers/testcontainers-go (#53)
- d2f8ee3 fix: improved unmarshalling and validation errors of eithervalues (#55)
Full Changelog: v1.7.3...v1.7.4
Released by GoReleaser.