Merged
Conversation
Pretty-print both specs with --sort-keys so unrelated key reordering doesn't trip the check, then attach a unified diff (truncated at 60 KB) to the issue body inside a <details> block. Update the existing open issue on subsequent runs so the diff stays current instead of pinning to whatever week the drift first appeared.
- Capture the diff directly in the existing `if ! diff …` (errexit is already exempt inside `if`), removing the separate `-q` pre-check, the intermediate pretty-printed tempfiles, and the `|| true` workaround. - Replace the multi-echo body wrapper with two `printf`s and a 1-line bash `&&` truncation marker. - Pass `--label vendored --label upstream` to `diff` so the issue body shows meaningful headers instead of `/dev/fd/63`.
Collaborator
Author
|
Concrete preview: running this workflow's logic against the live spec right now produces real drift — the API description's Last updated date has bumped from April 23 → April 30. Here is exactly the issue body that would be posted (or used to update the existing The spec at api.ionq.co/v0.4/api-docs has diverged from the vendored openapi.json. Fetch the new spec and regenerate the client. Diff (sorted, pretty-printed JSON)--- vendored
+++ upstream
@@ -2576,7 +2576,7 @@
"name": "IonQ",
"url": "https://ionq.com/"
},
- "description": "*Last updated: April 23, 2026*\nIonQ's API for accessing the IonQ Quantum Cloud platform\n\nPlease subscribe for automated updates when we perform maintenance or\nexperience an outage.\n\nIn addition, you may use the [status endpoint](#tag/status) to check the\ncurrent status of our API.\n\n## Authentication\n\n<SecurityDefinitions />\n",
+ "description": "*Last updated: April 30, 2026*\nIonQ's API for accessing the IonQ Quantum Cloud platform\n\nPlease subscribe for automated updates when we perform maintenance or\nexperience an outage.\n\nIn addition, you may use the [status endpoint](#tag/status) to check the\ncurrent status of our API.\n\n## Authentication\n\n<SecurityDefinitions />\n",
"title": "IonQ Cloud Platform API",
"version": "v0.4"
},Body size: 1158 bytes (cap is 65 536; |
guenp
previously approved these changes
May 6, 2026
Only `info.description` changed ("Last updated: April 23, 2026" →
"April 30, 2026"); the field is OpenAPI metadata that does not surface
in any generated Python, so re-running the regen pipeline produces no
changes under `ionq_core/`. The upstream-sorted diff matches the
preview posted on this PR.
Resolves #38.
`linguist-vendored=true` only excludes a file from repo language statistics; it does not suppress diffs in PRs (see github-linguist's `generated.rb` and github-linguist/linguist#3234). Add `linguist-generated=true` so reviewers see openapi.json collapsed by default — the spec is fetched from upstream by the regen pipeline and isn't intended for line-by-line review (the actual semantic diff lives in the spec-drift issue body now).
guenp
approved these changes
May 6, 2026
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
2 participants
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.
Summary
Today the weekly spec-drift workflow only says "the spec changed upstream" — you have to go fetch and diff it yourself. This PR pastes the diff directly into the issue body so it's visible at a glance.
--sort-keysso cosmetic key reordering can't trip the check.diff -uof the two pretty-printed files inside a collapsed<details>block, truncated at 60 KB (GitHub's body cap is ~64 KB).spec-driftissue on subsequent runs instead of skipping, so the diff always reflects the latest upstream rather than pinning to whichever week drift first appeared.No change to schedule, label, title, permissions, or anything
tests/test_docs_consistency.pyasserts.Also dogfoods the new behavior by refreshing
openapi.jsonfrom upstream — the only delta isinfo.description's "Last updated" date (April 23 → April 30, 2026), which is OpenAPI metadata that does not surface in any generated Python, so the regen pipeline produces no changes underionq_core/. Resolves #38.Test plan
uv run pytest tests/test_docs_consistency.py— 18 passed; the/v0.4/api-docsmentions both consistency tests check are still in the workflow.yaml.safe_load.<details>collapses, fenced```diffblock renders, truncation marker only appears past 60 KB.openapi.json(oas-patchoverlay →openapi-python-client generate); no changes underionq_core/.uv run ruff check/ruff format --checkclean.