Relay / Developer documentation

All guides / Reference

Changelog

0.0.5 — 27 October 2026

Published on PyPI, npm and GitHub. Fresh unpinned registry installations and the public cross-runtime realtime workflow passed verification.

• Optional authenticated realtime team statuses for native Python and Node integrations, configured through three backend environment variables.
• One shared service bundled with relay-backend[realtime]; relay team init, add-member and serve support setup without cloning or building.
• Verified updater identities, reader/writer membership, explicit acknowledgements, stale-write rejection, durable status caches and snapshot recovery after reconnect.
• API execution and local notes remain usable during collaboration outages; credentials and API traffic remain local.
• Explicit local, Git and realtime authorities plus a reviewed, create-only Git-status import in /relay/ that preserves Git files and existing team statuses.
• Public API-testing workflow documentation and native package discovery metadata.
• In-place upgrade verification from published Python 0.0.4 and npm 0.0.3, alongside fresh package consumers and cross-runtime sync checks.

0.0.4 — 12 October 2026

• Guided init commands for Python and Node: bounded framework detection, preview-first FastAPI/Express integration edits and manual guidance for ambiguous layouts.
• doctor commands with local runtime/package, OpenAPI, mount and Git configuration checks; sanitized JSON output.
• Local endpoint note editing with explicit Save/Cancel, retained unsaved edits, stale-contract review and recent endpoint activity.
• Persistent contract-change explanations identifying changed parameter/body/response/authentication sections without storing duplicate contracts or traffic.
• Separate schema/team sync feedback, schema change counts and an explicit retry for enabled Git sharing.
• Explicit named request-example loading, preserved body edits during content-type switches and accessible required-input errors.
• Exports use the endpoint's current manual status, including contract-invalidated Needs fixing.
• Bounded local activity history, additive workspace migration and protection against Node status-save/schema-refresh races.
• Windows report compatibility: restore the legacy module entry point and use the canonical module for new associations.

Realtime collaboration, multipart uploads and optional request history/assertion/export-review features remain deferred. Published on PyPI and GitHub. The verified Node 0.0.4 tarball is attached to the GitHub release; npm 0.0.4 was not published; 0.0.5 supersedes that pending upload.

Node 0.0.3 - 9 October 2026

Published on npm. Fresh npm install relay-backend installation, bundled assets, API execution and TypeScript consumers passed registry verification.

• Native relay-backend npm distribution with bundled UI, CommonJS/ESM exports and TypeScript declarations.
• Express middleware, Fastify plugin and Node HTTP adapter use generated OpenAPI on the backend's existing /relay route.
• Real request execution with existing backend auth, bounded responses, manual statuses and optional automatic Git status sharing.
• Standalone npx relay-backend tester and portable .relay report opener without Python.
• Clean npm consumer checks and supported-Node CI release gates.
• Helpful pip install relay-backend startup guidance in the FastAPI example and Ludo consumer when the package is absent.

0.0.3 — 9 October 2026

Published on PyPI and GitHub.

• Canonical relay_backend import with compatibility for existing root relay_agent imports.
• Application-specific Relay - <name> browser titles and versioned bundled favicon refresh.
• Opt-in automatic team status exchange through a separate Git branch, with updater identity and concurrent-edit handling.
• Browser workspace refresh without manual Git commands or losing request drafts.
• Removed unused artwork and generation metadata; package checks compare bundled brand masters against source.
• Unpinned latest-version consumer installation checks and documented upgrades.

0.0.2 — 9 October 2026

Published on PyPI and GitHub.

• Refined terminal mark, plain Relay browser title and consistent report branding.
• Array query serialization, blank optional-body support and consistent header validation.
• More accurate effective-auth feedback, validated endpoint credentials and independent explicit Authorization/API-key headers.
• Previous responses preserved after failed requests; empty bodies and truncated-copy/export boundaries made explicit.
• JSON formatting and reports preserve large integers and duplicate keys; large bodies avoid costly formatting.
• Runnable FastAPI factory/router example with user/admin auth, nested bodies and validation cases.
• Custom visual guides and simpler installation documentation.
• Clean-install verification exercises actual handlers and authentication outside the checkout; Socket.IO integration coverage added.

0.0.1 — 9 October 2026

Published on PyPI as relay-backend, import relay_agent, under Apache-2.0.

• Bundled offline UI mounted at /relay/; install_relay(app) and optional enabled= development flag.
• Native schema discovery and execution through FastAPI middleware/dependencies/startup state.
• Categorized inline APIs, method colors, filters, manual status defaulting Done and Git workflow/source attribution.
• Shared/per-endpoint auth, request inputs, body/raw/header inspection, copy/snippets, response focus and wrapping.
• Five themes, custom Relay branding, terminal chrome and compact UI scale.
• Relay/JSON exports, offline opener and Windows user-level file association.
• Self-contained wheel/sdist, dependency notices, clean-install verification and Trusted Publishing workflow.

Python 3.11+; native FastAPI is the primary integration, with standalone local OpenAPI CLI also included. Multipart, OAuth browser flows, public deployment, realtime collaboration, YAML/external refs and macOS/Linux desktop associations are not included.