Skip to content

docs: align UnifiedEvent id field#953

Merged
realfishsam merged 1 commit into
mainfrom
fix/easy-159-unified-event-docs
Jun 10, 2026
Merged

docs: align UnifiedEvent id field#953
realfishsam merged 1 commit into
mainfrom
fix/easy-159-unified-event-docs

Conversation

@realfishsam

Copy link
Copy Markdown
Contributor

Summary

  • Update UnifiedEvent schema docs to use the code-backed id field instead of eventId
  • Update the /v0/events example and llms-full aggregate docs to match
  • Refresh generated API doc config metadata after running the docs generator

Fixes #159

Test Plan

  • git diff --check
  • npm run generate:docs --workspace=pmxt-core

@mintlify

mintlify Bot commented Jun 8, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
PMXT 🟢 Ready View Preview Jun 8, 2026, 10:53 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@realfishsam

Copy link
Copy Markdown
Contributor Author

PR Review: PASS (NOT VERIFIED)

What This Does

Updates documentation/generated docs to align UnifiedEvent id wording for SDK consumers reading docs.

Blast Radius

Docs and generated API doc config only; no runtime core or SDK client code changed.

Consumer Verification

Before (base branch):
Base docs contained the older/misaligned UnifiedEvent id description. No runtime consumer API behavior differs.

After (PR branch):
PR branch updates docs. Core build passed; core Jest tests passed (24 suites, 644 tests). Root verification then stopped at Python SDK tests because pytest is not installed.

Test Results

  • Build: PASS
  • Unit tests: CORE PASS (24 suites, 644 tests; root verification blocked by missing pytest)
  • Server starts: PASS during root verification
  • E2E smoke: N/A (docs-only)

Findings

No blocking findings.

PMXT Pipeline Check

  • Field propagation (3-layer): N/A
  • OpenAPI sync: N/A
  • Financial precision: N/A
  • Type safety: N/A
  • Auth safety: N/A

Semver Impact

patch -- documentation correction.

Risk

Generated docs freshness depends on the docs generation pipeline; runtime behavior was not affected.

@realfishsam realfishsam merged commit 23488c9 into main Jun 10, 2026
12 checks passed
@realfishsam realfishsam deleted the fix/easy-159-unified-event-docs branch June 10, 2026 07:06
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.

UnifiedEvent: code uses id field but docs show eventId in JSON response tables

1 participant