Repository navigation
add the planetscale plugin - #134
Conversation
Watches the PlanetScale API spec (schemas/openapi.yaml in
planetscale/terraform-provider-planetscale, a copy of
planetscale.com/docs/openapi.yaml), pinned to the commit that last
changed it, version = commit date. Deprecations are read from the
start of the operation's description ("Deprecated. Use ... instead.");
keep rule is deprecationsOnly. A fetched file with no paths is refused.
Co-Authored-By: Claude Opus 5.5 <[email protected]>
Signed-off-by: brandonphelps1212 <[email protected]>
…tions by the path a caller sends Move the server's /v1 into the paths with the shared adapter.ServerBasePath, so a spec that moves it can't read as every deprecated operation removed (the trimmed test copies keep the spec's two-line servers block). Test PathTemplates and QuoteDeprecatedOperation. Keep both plugins' rows; badge 26. Signed-off-by: brandonphelps1212 <[email protected]> Co-Authored-By: Claude Opus 5.5 <[email protected]>
Co-Authored-By: Claude Opus 5.5 <[email protected]> Signed-off-by: brandonphelps1212 <[email protected]>
|
Claude finished @brandonphelps1212's task in 1m 41s —— View job ✅ Ready to merge: the plugin follows every repo rule, its tests and checks pass, and I found no path that would emit a wrong event. The one problem I found is a garbled package doc comment, which isn't blocking. Rules
BugsNone blocking. Precision.
Verified
I could not run Non-blocking
|
| // Algolia, Elasticsearch, Sentry, PlanetScale): fetch the newest spec, diff it against the | ||
| // last one seen, normalize the changes into events, and attach migration | ||
| // hints from the API's changelog when it has one. It can also replay two | ||
| // given releases. |
There was a problem hiding this comment.
The merge left the package doc garbled. These 4 lines were added under the old paragraph instead of replacing it, so the doc now reads "…Sentry, Neon): … two given releases. Algolia, Elasticsearch, Sentry, PlanetScale): …". It builds, but this is what pkg.go.dev shows. Convex is missing from the list too. Suggested fix: delete these 4 lines and make lines 1–6 one paragraph:
// Package openapi is the source plugin for an API that publishes an OpenAPI
// spec per release (Stripe, Datadog, GitLab, GitHub, Vercel, Supabase,
// Algolia, Elasticsearch, Sentry, Neon, Convex, PlanetScale): fetch the newest
// spec, diff it against the last one seen, normalize the changes into events,
// and attach migration hints from the API's changelog when it has one. It can
// also replay two given releases.Co-Authored-By: Claude Opus 5.5 <[email protected]> Signed-off-by: brandonphelps1212 <[email protected]>
What this changes
Adds
planetscale, anopenapiplugin for PlanetScale's platform API. Part of #75 (I11.7 · Watch PlanetScale), under #14.Source:
schemas/openapi.yamlin planetscale/terraform-provider-planetscale (Apache-2.0, PlanetScale's own org), read at the newest commit that changed it.https://planetscale.com/docs/openapi.yaml. That has no versions, and Wayback holds 1 snapshot. A weekly bot PR syncs the copy and a maintainer merges it.versionis the commit date.info.versionis a fixedv1.Deprecations are only said in words: the spec has never set
deprecated: true. A description startingDeprecated.orDeprecated:(case-insensitive) marks the operation (DeprecatedDescription). It's matched only at the start and only on the operation, so "Deprecated, storage shrinking…" on a property doesn't count.Rule: Vercel's
deprecationsOnly.Operation names include
/v1(GET /v1/organizations/…), the path a caller sends, via the sharedadapter.ServerBasePath. This protects against a future move of/v1turning deprecated operations into false removals.Refuses a file that isn't a spec: missing, unparseable, or without
paths. One commit in the history deleted the file and it came back the same day. Rather than diffing against that,Runerrors and emits nothing.History: over all 31 consecutive pairs it keeps exactly 5 events, the deprecations on 2026-11-09:
…/bouncers/{bouncer}/resizes;…/neki-changes;…/neki-changes/{id}.The 41 unmarked removals (renames, a method change, routes the Go SDK still calls) are dropped.
For the maintainers: the test data's license
The spec file states no license ("© 2026 PlanetScale, Inc."), although the repo it's in is Apache-2.0. The test data is trimmed:
openapi,info, the path items involved and the 2-lineserversblock, every line unchanged. Please confirm that's acceptable.Needs a client change
planetscalemust be added to the patch-it client's list of date-versioned APIs, likeneonandconvex. That's a separate PR in the client repo.Checklist
docs/plugins.md: new row, statuslive.docs/plugins.jsonregenerated, README badge 27. I compared the row's words with the plugin.e631095a→fc13e09d, 5 deprecation events. Each quote is checked against the YAML as published.b49c3540→f6d6ad4d, the read-only to dedicated read-replica rename, 0 events. With the filter off it gives 7 removals, so the test isn't vacuous.testdata/README.mdrows: URL at the commit, date, license, quote.providers/planetscale.mdfrom the template, with Why this source and Known gaps:/workflows;make checkpasses.Notes for the reviewer
An independent review replayed all 31 history pairs and searched every version and the live spec.
Its two suggestions are in the third commit: tests for the two untested options, and the base-path protection.
🤖 Generated with Claude Code