Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update running-workflows.mdx w/ workflow run url #1075

Merged
merged 1 commit into from
Oct 28, 2024
Merged

Conversation

suchintan
Copy link
Contributor

@suchintan suchintan commented Oct 28, 2024

Important

Update endpoint path in running-workflows.mdx documentation for workflow runs retrieval.

  • Documentation:
    • Update endpoint path in running-workflows.mdx from GET /workflows/{workflow_id}/runs/{workflow_run_id} to GET /workflows/runs/{workflow_run_id}.

This description was created by Ellipsis for bd31dd2. It will automatically update as commits are pushed.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks good to me! Reviewed everything up to bd31dd2 in 17 seconds

More details
  • Looked at 13 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. docs/workflows/running-workflows.mdx:52
  • Draft comment:
    The endpoint URL should be GET /workflows/{workflow_id}/runs/{workflow_run_id} to match the context and maintain consistency with the workflow ID being part of the URL path.
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable:
    The comment is directly related to the change made in the diff. It suggests that the original URL structure, which includes the workflow_id, should be maintained for consistency. This is a valid point as including the workflow_id could be important for identifying the specific workflow context. The comment is actionable and suggests a clear code change.
    The comment assumes that including the workflow_id is necessary for consistency without providing evidence that it is required. The change might have been intentional to simplify the URL structure.
    While the change might be intentional, the comment raises a valid concern about consistency and context, which could be important for API design.
    The comment is valid as it raises a concern about maintaining consistency in the API endpoint structure by including the workflow_id.

Workflow ID: wflow_mK9mrYqum7JL0eYS


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

@suchintan suchintan merged commit 4949372 into main Oct 28, 2024
2 checks passed
@suchintan suchintan deleted the suchintan-patch-1 branch October 28, 2024 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant