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

task urls must have http or https scheme #996

Merged
merged 1 commit into from
Oct 18, 2024
Merged

Conversation

wintonzheng
Copy link
Contributor

@wintonzheng wintonzheng commented Oct 17, 2024

Important

Update API documentation to enforce HTTP/HTTPS scheme for URL parameters.

  • Documentation:
    • Update docs/running-tasks/api-spec.mdx to specify that url, webhook_callback_url, and totp_verification_url parameters must be of type HttpUrl, enforcing HTTP or HTTPS scheme.

This description was created by Ellipsis for 61ceb2c. 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 61ceb2c in 8 seconds

More details
  • Looked at 21 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. docs/running-tasks/api-spec.mdx:28
  • Draft comment:
    Consider adding a sample value for webhook_callback_url to maintain consistency with other parameters.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The PR changes the type of several URL parameters to HttpUrl, which is a good practice for ensuring valid URLs. However, the description for webhook_callback_url is missing a sample value, which is inconsistent with the other parameters.

Workflow ID: wflow_vGzaCNzmOfjVPBTb


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

@wintonzheng wintonzheng merged commit f132a9c into main Oct 18, 2024
2 checks passed
@wintonzheng wintonzheng deleted the shu/add_url_doc branch October 18, 2024 04:47
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