docs: show queued status in the Goal Run creation example - #56
Open
Zen-cronic wants to merge 1 commit into
Open
Zen-cronic wants to merge 1 commit into
Zen-cronic wants to merge 1 commit into
Conversation
The 201 create example returns a run that is accepted but not yet dialed (call_id: null); per the OpenAPI acceptedDeliveryConfirmation example and the GoalRunStatus enum, that state is queued, not in_progress.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
The Goal Run Create (
POST /v1/goals/{goal_id}/runs)201example incontent/guides/goal-runs.mdxshows"status": "in_progress"for a run that has just been accepted and not yet dialed ("call_id": null,"result": null,"completed_at": null).The OpenAPI contract documents the same response with a different status.
openapi/calle.openapi.yaml→acceptedDeliveryConfirmationis the identical object (id: rgrp_delivery_ord_8472,run_id: run_delivery_ord_8472,call_id: null) and shows:The
GoalRunStatusenum listsqueuedandin_progressas the two non-terminal states, withqueuedfirst, and the guide's own prose just above the example says a201"does not mean the provider accepted the call, the recipient answered, or the structured result is ready." So a freshly-accepted, not-yet-executed run isqueued; the create example is the only place that saysin_progress, which disagrees with the spec it documents.Change
One token,
content/guides/goal-runs.mdx:Found while wiring a live integration against the Goal Runs API — a reader who takes the create example at face value expects
in_progresson a201, which the API doesn't return. Happy to close this ifin_progressis intended here instead; in that case the OpenAPI example and the enum ordering are probably the things to align.