Skip to content

Conversation

@Joe-Abraham
Copy link
Contributor

@Joe-Abraham Joe-Abraham commented Nov 3, 2025

Description

Add documentation for REST-based remote functions

Impact

NA

Test Plan

NA

Contributor checklist

  • Please make sure your submission complies with our contributing guide, in particular code style and commit standards.
  • PR description addresses the issue accurately and concisely. If the change is non-trivial, a GitHub Issue is referenced.
  • Documented new properties (with its default value), SQL syntax, functions, or other functionality.
  • If release notes are required, they follow the release notes guidelines.
  • Adequate tests were added if applicable.
  • CI passed.
  • If adding new dependencies, verified they have an OpenSSF Scorecard score of 5.0 or higher (or obtained explicit TSC approval for lower scores).

Release Notes

== NO RELEASE NOTE ==

@prestodb-ci prestodb-ci added the from:IBM PR from IBM label Nov 3, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Nov 3, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR extends the Presto documentation by adding comprehensive coverage for REST-based remote functions, including an overview, detailed syntax and configuration parameters, and practical usage examples—all integrated into the features.rst guide.

File-Level Changes

Change Details Files
Introduce REST-based remote functions feature
  • Added a new section outlining the concept and benefits of REST-based remote functions
  • Explained prerequisites and high-level workflow for invoking remote HTTP endpoints
presto-docs/src/main/sphinx/presto_cpp/features.rst
Document syntax and configuration parameters
  • Defined SQL syntax for declaring REST-based remote functions
  • Listed and described new configuration properties (endpoint URL, HTTP method, SSL settings, headers)
  • Clarified default values and optional vs. required parameters
presto-docs/src/main/sphinx/presto_cpp/features.rst
Add practical examples and usage notes
  • Provided example remote function definitions and sample HTTP request/response snippets
  • Included notes on error handling and authentication header usage
presto-docs/src/main/sphinx/presto_cpp/features.rst

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@Joe-Abraham
Copy link
Contributor Author

@sourcery-ai review

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@steveburnett
Copy link
Contributor

Thanks for the documentation! I'll wait to review this until it's out of Draft mode.

@Joe-Abraham Joe-Abraham marked this pull request as ready for review November 4, 2025 04:27
@Joe-Abraham Joe-Abraham requested review from a team, elharo and steveburnett as code owners November 4, 2025 04:27
@prestodb-ci prestodb-ci requested review from a team and Dilli-Babu-Godari and removed request for a team November 4, 2025 04:27
Copy link
Contributor

@steveburnett steveburnett left a comment

Choose a reason for hiding this comment

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

Thanks for the documentation! This is really well-done: good organization, useful examples, and clear instructions on how to configure. A few minor nits of formatting and phrasing but overall very good. Thanks!

@github-project-automation github-project-automation bot moved this from 🆕 Unprioritized to 🏗 In progress in Presto Documentation Nov 4, 2025
Copy link
Contributor

@steveburnett steveburnett left a comment

Choose a reason for hiding this comment

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

LGTM! (docs)

Pull updated branch, new local doc build. Thanks for the update!

@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Presto Documentation Nov 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs from:IBM PR from IBM

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants