Skip to content

refactor: replace local overlay package with speakeasy-api/openapi/overlay#24

Merged
TristanSpeakEasy merged 1 commit intomainfrom
refactor/use-external-overlay-package
Feb 11, 2026
Merged

refactor: replace local overlay package with speakeasy-api/openapi/overlay#24
TristanSpeakEasy merged 1 commit intomainfrom
refactor/use-external-overlay-package

Conversation

@TristanSpeakEasy
Copy link
Member

@TristanSpeakEasy TristanSpeakEasy commented Feb 11, 2026

Summary

  • Removes the local pkg/overlay/ package (~1,700 lines) in favor of the upstream github.com/speakeasy-api/openapi/overlay package
  • Bumps overlay spec version from 1.0.0 to 1.1.0 in web defaults
  • Upgrades Go from 1.22 to 1.24.3 and updates dependencies
  • Rebuilds WASM binary with the new dependency

Motivation

The overlay logic was duplicated between this repo and the openapi module. Consolidating on the upstream package reduces maintenance burden and keeps overlay behavior consistent across projects.

Test plan

  • Verify WASM build works correctly in the web UI
  • Confirm overlay apply/compare functionality is intact via the playground

@TristanSpeakEasy TristanSpeakEasy added the enhancement New feature or request label Feb 11, 2026
@vercel
Copy link

vercel bot commented Feb 11, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
jsonpath Ready Ready Preview, Comment Feb 11, 2026 10:16am

Request Review

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Refactors the project to stop using the local overlay implementation and instead rely on the upstream github.com/speakeasy-api/openapi/overlay, while updating overlay defaults and Go/dependencies.

Changes:

  • Replace local pkg/overlay implementation (and its tests/testdata) with the upstream overlay module.
  • Bump web overlay defaults from spec 1.0.0 to 1.1.0.
  • Update Go version and module dependencies; rebuild WASM against the new overlay dependency.

Reviewed changes

Copilot reviewed 17 out of 19 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
web/src/defaults.ts Updates default overlay spec version strings to 1.1.0.
pkg/overlay/validate.go Removes local overlay validation logic (file deleted).
pkg/overlay/schema.go Removes local overlay schema types and YAML serialization (file deleted).
pkg/overlay/parse.go Removes local overlay parse/format helpers (file deleted).
pkg/overlay/parents.go Removes local YAML parent indexing utility (file deleted).
pkg/overlay/apply.go Removes local overlay apply/merge implementation (file deleted).
pkg/overlay/compare.go Removes local overlay compare/diff implementation (file deleted).
pkg/overlay/apply_test.go Removes overlay apply snapshot test (file deleted).
pkg/overlay/compare_test.go Removes overlay compare + roundtrip test (file deleted).
pkg/overlay/parse_test.go Removes overlay parse/format test (file deleted).
pkg/overlay/testdata/* Deletes overlay/openapi fixtures used by removed snapshot tests.
go.mod Updates Go version and pulls in github.com/speakeasy-api/openapi dependency.
cmd/wasm/functions.go Switches WASM code to import and use the upstream overlay package.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@TristanSpeakEasy TristanSpeakEasy merged commit 85d5832 into main Feb 11, 2026
6 of 10 checks passed
@TristanSpeakEasy TristanSpeakEasy deleted the refactor/use-external-overlay-package branch February 11, 2026 10:59
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.

2 participants