Skip to content

feat: Pin the OpenAPI schema used by APIRequest - #33714

Merged
mvvmm merged 2 commits into
productionfrom
feat/openapi-schema-pinning
Sep 25, 2026
Merged

mvvmm merged 2 commits into
productionfrom
feat/openapi-schema-pinning

Conversation

@mvvmm

@mvvmm mvvmm commented Sep 25, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Pins the OpenAPI schema <APIRequest> renders against, so upstream changes land via a reviewed PR instead of breaking every build (see #33645).

  • openapi.lock.json pins a cloudflare/api-schemas SHA + sha256. Prebuild fetches and verifies that middlecache snapshot.
  • Weekly workflow opens a bump PR listing removed operations and broken <APIRequest> usages.
  • OPENAPI_SCHEMA=latest renders against the newest snapshot (local only).
  • Schema SHA is part of the incremental-build cacheKey.

After merge: run the workflow once via workflow_dispatch to confirm the bot App can push and open PRs.

- openapi.lock.json pins an upstream cloudflare/api-schemas SHA + archive sha256
- prebuild/predev fetch the pinned middlecache snapshot and verify its sha256
- OPENAPI_SCHEMA=latest renders against the newest published snapshot
- schema SHA feeds the docs-page incremental-build cacheKey
- weekly workflow opens a bump PR with an operation diff and broken <APIRequest> usages
@mvvmm
mvvmm marked this pull request as ready for review September 25, 2026 20:22
@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

AI Review

✅ Reviewed d11cf86 · 0 findings · incremental

Resolved (1) · Dismissed (0)
  • Resolved: Branch rebuild runs git checkout over a dirty openapi.lock.json · At head the step saves the rewritten lock to $RUNNER_TEMP, switches with git checkout --force -B (discards working-tree changes instead of aborting), then restores the lock before git diff. The dirty-lock checkout abort described can no longer occur.
Commands
  • /review Run a review now.
  • /full-review Review the entire PR diff.
  • /disable-auto-review Stop automatic reviews.
  • /rebase Rebase against production.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Sep 25, 2026 •

Copy link
Copy Markdown

🚀 Deploying Preview to Cloudflare 🚀

Preview URL: https://feat-openapi-schema-pinning.previews.developers.cloudflare.com (commit baf4715)

This URL reflects your latest Preview deployment

Preview Deployments by commit

Status Deployment URL Commit Updated (UTC) See this deployment's details
  • Build: In progress 🔵

View logs ↗
d11cf86 2026-09-25T23:26:25.429Z View logs ↗
  • Build: Success ✅
  • Deployment: Success ✅

View logs ↗
https://51365a4f.previews.developers.cloudflare.com baf4715 2026-09-25T20:30:18.405Z Visit the dashboard ↗

@github-actions

github-actions Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

@mvvmm
mvvmm enabled auto-merge (squash) September 25, 2026 23:34
@mvvmm
mvvmm merged commit 7c35bcd into production Sep 25, 2026
15 of 16 checks passed
@mvvmm
mvvmm deleted the feat/openapi-schema-pinning branch September 25, 2026 23:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants