Files

T

efdcfba68d feat(api): purge Cloudflare CDN before and after OpenAPI spec upload (#704 )

* feat(api): purge Cloudflare CDN before and after OpenAPI spec upload

Purge api.cdn.clsrio.com edge cache for openapi-latest and the dated
spec URL so deploys are not blocked by the 1h Cache-Control TTL on R2
objects. Uses the same CLOUDFLARE_API_TOKEN and CLOUDFLARE_ZONE_ID
pattern as embed uploads; skips when credentials are unset.

Co-authored-by: Rotimi Best <[email protected]>

* fix(api): purge OpenAPI CDN cache only after upload

Match the embeds upload pattern: update R2 first, then invalidate
edge cache so clients refetch the new spec.

Co-authored-by: Rotimi Best <[email protected]>

* fix(api): treat Cloudflare purge 2xx as success when body is unparseable

Avoid false upload failures when the purge API returns 200 with a
non-JSON body. Addresses Greptile review on #704.

Co-authored-by: Rotimi Best <[email protected]>

---------

Co-authored-by: Cursor Agent <[email protected]>
Co-authored-by: Rotimi Best <[email protected]>

2026-07-02 12:11:00 +01:00

2.4 KiB

Raw Blame History

OpenAPI Spec Generator Script

This script generates the OpenAPI specification for the public API routes only and optionally uploads it to a Cloudflare R2 bucket.

Usage

Generate and Upload OpenAPI spec

pnpm run upload:openapi

Direct script usage

tsx scripts/upload-openapi-spec.ts

Examples

# Generate spec locally only
pnpm upload:openapi

Environment Variables

For R2 upload functionality, set these environment variables:

CLOUDFLARE_ACCESS_KEY=your_access_key
CLOUDFLARE_SECRET_ACCESS_KEY=your_secret_key
CLOUDFLARE_ACCOUNT_ID=your_account_id

Optional — purge Cloudflare CDN cache for api.cdn.clsrio.com (after R2 upload):

CLOUDFLARE_API_TOKEN=your_api_token   # Zone → Cache Purge → Purge
CLOUDFLARE_ZONE_ID=your_zone_id
OPENAPI_SKIP_CDN_PURGE=1              # skip purge when set

Output

The script will:

Generate the OpenAPI specification from your Hono app routes
Filter the output to /public-api/v1/*
Save locally to dist/openapi/public-api/openapi.json
Upload to R2 (if credentials provided):
- openapi/public-api/openapi-YYYY-MM-DD.json (dated version)
- openapi/public-api/openapi-latest.json (latest version)
Purge Cloudflare CDN (if CLOUDFLARE_API_TOKEN and CLOUDFLARE_ZONE_ID are set) for both public URLs, after upload

GitHub Action Integration

This script is integrated with a GitHub Action that automatically generates and uploads the OpenAPI spec on code changes.

Automatic Workflow

The GitHub Action runs on:

Push to main - Automatically uploads to R2
Pull Requests - Generates spec for review (no upload)
Manual dispatch - Allows manual triggering with custom parameters

Setup

Required secrets:
- CLOUDFLARE_ACCESS_KEY
- CLOUDFLARE_SECRET_ACCESS_KEY
- CLOUDFLARE_ACCOUNT_ID
Optional secrets (CDN cache purge for api.cdn.clsrio.com):
- CLOUDFLARE_API_TOKEN
- CLOUDFLARE_ZONE_ID

Features

✅ Automatic OpenAPI spec generation from Hono routes
✅ Local file generation for development
✅ Cloudflare R2 upload with versioning
✅ Optional Cloudflare CDN cache purge (after upload)
✅ GitHub Action integration
✅ Environment-specific deployments
✅ PR previews and artifacts
✅ Error handling and logging
✅ CLI help with --help flag

2.4 KiB Raw Blame History