Skip to content

Draft Phase 3 event topic conventions - #71

Merged
Alajmah merged 1 commit into
mainfrom
phase3-topic-docs
Jun 7, 2026
Merged

Alajmah merged 1 commit into
mainfrom
phase3-topic-docs

Conversation

@Alajmah

@Alajmah Alajmah commented Jun 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a docs-only draft of Phase 3 event topic and envelope conventions.

Changes

  • Defines proposed topic naming patterns.
  • Documents command, task, approval, patch/audit, artifact, memory, and system heartbeat topic families.
  • Captures envelope and correlation expectations.
  • Explicitly avoids adding broker, Solace, A2A, MCP, or runtime dependencies.

Closes #49.

Validation

  • Docs-only change.
  • CI should run on this PR.

@gitwire-hq gitwire-hq Bot added the size/S label Jun 7, 2026

@chatgpt-codex-connector chatgpt-codex-connector Bot 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 0eee338f7a

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +16 to +20
Proposed topic names use dot-separated segments:

```text
sovereign.<workspace>.<domain>.<event>
```

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Use Solace topic-level delimiters

When these conventions are implemented with the stated Solace stack, dots leave the entire address in one topic level, so consumers cannot independently wildcard workspace, domain, or event as this hierarchy intends. Solace uses / to separate routable topic levels (https://docs.solace.com/Cloud/Event-Portal/event-portal-topic-addresses.htm); define these addresses with that delimiter or explicitly document an adapter translation.

Useful? React with 👍 / 👎.

Comment on lines +60 to +62
sovereign.<workspace>.approval.requested
sovereign.<workspace>.approval.approved
sovereign.<workspace>.approval.rejected

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Map topics to the existing EventType values

When an adapter publishes the approval events currently emitted by cli.py, these names provide no deterministic topic: the canonical enum contains PatchApproved and PatchRejected, while the document defines approval.approved and approval.rejected and omits the corresponding patch topics. Since the document says topic names derive from canonical event types and EventEnvelope remains authoritative, either use topics corresponding to those enum values or document the explicit mapping; the same inventory should cover PolicyChecked.

Useful? React with 👍 / 👎.

@Alajmah
Alajmah merged commit 361d511 into main Jun 7, 2026
2 checks passed
@Alajmah
Alajmah deleted the phase3-topic-docs branch June 7, 2026 14:16
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.

Draft Phase 3 event topic conventions

1 participant