OpenVoiceOS / OpenVoiceOS/architecture

Spec questions from messagebus model coverage (PIPELINE-1 / STOP-1)

Open
#58 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
3
Forks
0
Avg merge
15h 20m
Merged PRs (30d)
90

Description

Raised while adding validated pydantic models for the spec-defined messages (ovos-pydantic-models#6):

  1. PIPELINE-1 §8 — the handler-lifecycle messages (ovos.intent.handler.start/complete/error) lack a canonical payload schema (unlike §9.1/§9.2/§9.6). Models currently infer skill_id + intent_name (+ optional pipeline_id) from the §7.1 dispatch shape. Should §8 define the payload normatively?
  2. STOP-1 §4.2ovos.stop.pong payload: is a skill_id field expected for disambiguation on the shared reply topic, or is session propagation via reply() considered sufficient? (Modeled as Optional pending verification against ovos-stop-pipeline-plugin.)
  3. PIPELINE-1 §9.6ovos.utterance.speak vs the legacy speak TTS dispatch are distinct layers; consider a spec note clarifying the relationship for consumers.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the referenced ovos-pydantic-models#6 coverage alongside PIPELINE-1 §§7.1, 8, and 9.6 and STOP-1 §4.2, then verify the ovos-stop-pipeline-plugin behavior. Done means the payload expectations are resolved and the relevant specifications clearly document the canonical schemas and relationship between the message layers.

Written by the indexing model from the issue text.

Assessment

Domain
backend-api-design, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.