Skip to content

docs/guides/job-events.md references JobStarted.jobId, which does not exist #64

@nficano

Description

@nficano

JobStarted is declared at lib/src/main/kotlin/dev/arcp/messages/Execution.kt:117 with a single property, startedAt: Instant. The job-events guide at docs/guides/job-events.md:11 shows is JobStarted -> println("Job ${msg.jobId} is now running") — there is no msg.jobId; the job id lives on the envelope (env.jobId). A reader following the snippet would get a compilation error. The same guide's heartbeat and chunk snippets at docs/guides/job-events.md:36, docs/guides/job-events.md:69, and docs/guides/job-events.md:101 are correct in shape but should be re-checked against the message constructors while the file is being edited.

Fix prompt: Change the JobStarted example to is JobStarted -> println("Job ${env.jobId} started at ${msg.startedAt}"), and audit the rest of docs/guides/job-events.md to ensure every msg.<field> reference exists on the corresponding MessageType data class. Run a docs-snippet test (or compile the snippet through a hidden internal test target) so future drift is caught at build time.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationseverity:lowLow severity issue

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions