Skip to content

feat(api): live endpoint audit parity, swagger ui integration, and multi-engine migration guide - #44

Merged
ankur-paan merged 8 commits into
mainfrom
feat/endpoint-audit-swagger-and-migration-guide
Oct 16, 2026
Merged

ankur-paan merged 8 commits into
mainfrom
feat/endpoint-audit-swagger-and-migration-guide

Conversation

@ankur-paan

@ankur-paan ankur-paan commented Oct 16, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

This PR resolves discrepancies uncovered during a live manual audit of all rekuiper REST endpoints, aligns Swagger/OpenAPI documentation with runtime behaviors, fixes documentation UI artifacts, overhauls the legacy migration guide into a comprehensive multi-engine modernization guide, and migrates repository and Docker Hub references to the Indus-Stack organization.

Key Changes

  1. REST Route Aliases & Query Support (crates/rekuiper-server):

    • Added .route("/config", get(get_configs).patch(patch_configs)) alias alongside /configs to match standard CLI and documentation expectations.
    • Enhanced TagMatchQuery with singular aliases (tag and key) alongside plural forms (tags and keys).
    • Extended tag extraction from JSON values to support single-string fields in addition to arrays.
  2. OpenAPI & Swagger UI Synchronized (openapi.json, docs/en_US/public/openapi.json):

    • Added /config path alias with full GET / PATCH operations.
    • Documented complete RuleStatus summary counters (sourceRecordsInTotal, sinkRecordsOutTotal, exceptionsTotal, lastException, last_exception, etc.).
    • Documented /rules/tags/match query parameters for filtering rules by tag and key.
  3. Multi-Engine Migration Guide (docs/en_US/operation/migration.md):

    • Overhauled legacy migration notes into a modern edge stream migration guide.
    • Includes side-by-side SQL syntax, rule definitions, and architecture comparisons for migrating from eKuiper, Telegraf, Node-RED, and Vector to rekuiper.
  4. Repository & Docker Hub Organization Migration (Indus-Stack & indusstack/rekuiper):

    • Migrated all repository links, clone URLs, and badges across the codebase from ankur-paan/rekuiper to Indus-Stack/rekuiper.
    • Updated official Docker images to indusstack/rekuiper:1.0.0-rc4 and indusstack/rekuiper:latest across documentation, Compose files, and the Helm chart.
    • Upgraded GitHub Actions CI workflow to publish and sync Docker Hub metadata to indusstack/rekuiper.
    • Upgraded status badges to dynamic GitHub Actions runner badges.
    • Corrected Helm chart directory references to deploy/chart/rekuiper.

Verification

  • Live Regression Audit: 108/108 endpoint assertions passed with real payloads against a running instance.
  • Cargo Format: cargo fmt --all -- --check passed (0 diffs).
  • Cargo Clippy: cargo clippy --workspace --all-targets -- -D warnings passed with 0 warnings.
  • VitePress Build: npm run build completed cleanly with 0 broken links in 34.33s.

Copilot AI balanced review requested due to automatic review settings October 16, 2026 22:13

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@vercel

vercel Bot commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Building Building Preview Oct 16, 2026 11:12pm UTC
ekuiper Ready Ready Preview Oct 16, 2026 11:12pm UTC

@ankur-paan
ankur-paan merged commit 8fb6031 into main Oct 16, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants