Skip to content

Conversation

@TristanSpeakEasy
Copy link
Member

Summary

Adds the openapi overlay upgrade CLI command for upgrading Overlay documents from 1.0.0 to 1.1.0.

Follow-up to #130 which added full Overlay 1.1.0 support to the overlay package.

Changes

New CLI Command: overlay upgrade

# Preview upgrade (output to stdout)
openapi overlay upgrade my-overlay.yaml

# Upgrade and save to new file
openapi overlay upgrade my-overlay.yaml upgraded-overlay.yaml

# Upgrade in-place
openapi overlay upgrade -w my-overlay.yaml

Files Changed

  • cmd/openapi/commands/overlay/upgrade.go: New upgrade command implementation
  • cmd/openapi/commands/overlay/root.go: Register upgrade command
  • cmd/openapi/commands/overlay/README.md: Add upgrade command documentation
  • overlay/README.md: Update documentation for 1.1.0 release

Features

  • Upgrades overlay version from 1.0.0 to 1.1.0
  • Validates overlay before and after upgrade
  • Supports stdout, file output, and in-place (-w) modes
  • Shows status messages (upgrade performed or already at target version)
  • Clears redundant x-speakeasy-jsonpath: rfc9535 (now default in 1.1.0)

Testing

  • All CI checks pass
  • CLI command tested manually with test fixtures

@TristanSpeakEasy TristanSpeakEasy requested a review from a team as a code owner January 19, 2026 01:36
@TristanSpeakEasy TristanSpeakEasy added the enhancement New feature or request label Jan 19, 2026
@TristanSpeakEasy TristanSpeakEasy enabled auto-merge (squash) January 19, 2026 01:39
@codecov
Copy link

codecov bot commented Jan 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@TristanSpeakEasy TristanSpeakEasy merged commit 361dde0 into main Jan 19, 2026
11 checks passed
@TristanSpeakEasy TristanSpeakEasy deleted the feat/overlay-upgrade-cli branch January 19, 2026 01:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants