Skip to content

docs: add description fields to inline message schemas - #88

Merged
k-rister merged 1 commit into
masterfrom
schema-descriptions
Jun 11, 2026
Merged

docs: add description fields to inline message schemas#88
k-rister merged 1 commit into
masterfrom
schema-descriptions

Conversation

@k-rister

Copy link
Copy Markdown
Contributor

Summary

  • Add description fields to the protocol message schema (define_msg_schema) and user message schema (define_usr_msg_schema) in roadblock.py
  • Documents purpose of payload fields, sender/recipient identification, protocol commands, user message payloads, and integrity checksums
  • Part of a cross-repo effort to add descriptions to all JSON schemas (PERFNFV-319)

Test plan

  • python3 -m py_compile roadblock.py passes
  • CI passes

🤖 Generated with Claude Code

Add description fields to the protocol message schema
(define_msg_schema) and user message schema (define_usr_msg_schema)
in roadblock.py, documenting the purpose of each property including
payload fields, sender/recipient identification, protocol commands,
user message payloads, and integrity checksums.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@k-rister k-rister self-assigned this Jun 11, 2026
@k-rister
k-rister requested a review from a team June 11, 2026 16:16
@project-crucible-tracking project-crucible-tracking Bot moved this to In Progress in Crucible Tracking Jun 11, 2026
@k-rister
k-rister merged commit d26e183 into master Jun 11, 2026
432 of 434 checks passed
@k-rister
k-rister deleted the schema-descriptions branch June 11, 2026 18:24
@github-project-automation github-project-automation Bot moved this from In Progress to Done in Crucible Tracking Jun 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants