skills.rest
clemensv
clemensvCOMMUNITY
Explore all skills by this author →
Website𝕏@clemensvGitHub

xreg-source-contract

Design and validate real-time event contracts for data sources using xreg.

36|7|Updated Jul 27, 2023
Search Tags:#kafka#regenerate#contract#cloud-events#json-structure#xreg#upstream-schema
One-click install
npx skills add https://github.com/clemensv/real-time-sources --skill xreg-source-contract
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: xreg-source-contract
Source: https://github.com/clemensv/real-time-sources/tree/main/.github/skills/xreg-source-contract
Command: npx skills add https://github.com/clemensv/real-time-sources --skill xreg-source-contract

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps teams design and validate real-time event contracts for their data sources using the xreg framework, ensuring upstream schemas and contract semantics are aligned.

Core Features & Use Cases

  • Add or update an xreg manifest for a source to govern its contract model and downstream producer wiring.
  • Change CloudEvents subject or Kafka key modeling to reflect evolving data schemas.
  • Split one source into multiple message groups or endpoints to isolate contract boundaries and improve routing.
  • Regenerate producers after contract changes with the provided tooling to keep generated code in sync with the manifest.
  • Refresh EVENTS.md and ensure documentation matches the live contract.

Quick Start

Create or update the xreg manifest for your source, review upstream contracts and then regenerate the producer using the local xrcg tooling.

Frequently Asked Questions about xreg-source-contract

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I design and validate real-time event contracts for Kafka topics?▼

You design and validate real-time event contracts by creating an xreg manifest that governs upstream schemas and messaging semantics. This ensures your Kafka key and subject modeling aligns correctly with evolving data schemas across designated topics.

What is the best way to model CloudEvents definitions for REST data feeds?▼

Modeling CloudEvents definitions for REST data feeds requires updating your xreg manifest to enforce exhaustive channel enumeration and correct template naming. This validates contract boundaries and ensures proper event routing across OpenAPI endpoints.

How do I regenerate producers after changing upstream schemas?▼

You regenerate producers after upstream schema changes by running the xrcg 0.10.1 tooling against your updated xreg manifest. This synchronization updates generated code and automatically refreshes your EVENTS.md documentation to match the live contract.

Can I split one data source into multiple message groups to isolate contract boundaries?▼

Yes, you can split a single source into multiple message groups or endpoints to isolate contract boundaries and improve routing. The xreg manifest supports this separation to maintain strict semantic alignment across distinct MQTT topics or OpenAPI endpoints.

Does xreg work with MQTT topics and OpenAPI endpoints for event contract validation?▼

Yes, xreg validates event contracts across MQTT topics, OpenAPI endpoints, and REST data feeds. It enforces reference-data modeling where available and ensures correct template naming to maintain consistent messaging semantics across all supported communication protocols.

Related Skills

Explore More Legal & Compliance Skills→
mescamesca

spec-driven

Align OpenAPI/OpenRPC contracts with Pydantic models and services.

Community
Intermediate
Pryma-TechPryma-Tech

deepinit

Generate hierarchical AGENTS.md documentation with parent references across repository directories.

Community
Advanced
phatblatphatblat
12

WebAssessment

Automate web application security assessments with reconnaissance, threat modeling, and vulnerability analysis.

Community
Advanced
duc01226duc01226
7

message-bus

Publish and consume RabbitMQ messages with standardized schemas and naming conventions.

Community
Advanced