Add OpenAPI spec-drift detector#8
Open
andrewyu47 wants to merge 2 commits into
Open
Conversation
Flags affected docs.pinecone.io guide pages and impacted SDKs when an OpenAPI spec changes, with breaking changes called out first. PR mode comments a checklist on the PR; scheduled mode diffs the two newest version snapshots and opens a draft PR in pinecone-io/docs. Breaking-change classification covers removed/required-added params, type changes, removed properties/enums, and removed operations. Pure Python stdlib + pyyaml. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…ion, removed response codes Audit against the design's breaking-change rule table surfaced three rows that weren't implemented or were misclassified: - format changes (e.g. int32->int64, date->date-time) on params and schema properties are now flagged breaking (previously only type/$ref compared) - parameter location change (e.g. query->path) is reported once as breaking instead of a misleading remove + add pair - removed response codes are flagged breaking (responses were not diffed) Adds 5 unit tests (11 total, all passing). On the real 2025-10 -> 2026-04 snapshot pair the detector now finds 33 changes / 5 breaking (was 30 / 2), the extra items being genuine response-code removals and param changes. Also dedups the breaking-changes section of the PR comment so a change mapped to multiple guide pages is listed once. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Draft. Adds a CI detector that flags when an OpenAPI spec change requires docs/SDK updates.
pinecone-io/docs.pyyaml. The symbol→docs/SDK mapping lives in.github/spec-manifest.json(hand-seeded; unmapped surface is logged tospec-gaps-unmapped.jsonso the manifest stays current).Before the scheduled half can run: add a
DOCS_GITHUB_TOKENrepo secret (PAT withreposcope onpinecone-io/docs). PR comments use the defaultGITHUB_TOKEN.Validated locally on the
2025-04 → 2025-10db_datadiff: 42 changes, 25 breaking (e.g. the newly-requiredX-Pinecone-Api-Versionheader). Unit tests under.github/scripts/tests/.Generated with Claude Code.