Skip to content

feat: add OpenFaaS connection type and documentation #58759

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.

Sign up for GitHub

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

Jump to bottom
Merged
Lee-W merged 5 commits into from
Nov 27, 2025
Merged

feat: add OpenFaaS connection type and documentation #58759

Lee-W merged 5 commits into from
Nov 27, 2025

Conversation

@LeoLiao123
Copy link
Contributor

@LeoLiao123 LeoLiao123 commented Nov 27, 2025 •
edited
Loading

Why

Related Issue : #28790 (OpenFaasHook section)

What

  • hooks/openfaas.py - Added connection class attributes and get_ui_field_behaviour()
  • provider.yaml - Added connection-types section
  • get_provider_info.py - Added connection-types entry
  • docs/connections/openfaas.rst - New connection documentation
  • docs/index.rst - Added link to connection docs

Test

Run breeze start-airflow and verify that OpenFaaS appears in the Connection Type dropdown menu.
image

@boring-cyborg
Copy link

boring-cyborg bot commented Nov 27, 2025

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our prek-hooks will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

@LeoLiao123
feat: add OpenFaaS connection type and documentation
6f3482d 
fix: remove redundant line from OpenFaaS documentation and add connection type to provider info
@LeoLiao123 LeoLiao123 force-pushed the feat/add-openfaas-conn-type branch from f4ed776 to 6f3482d Compare November 27, 2025 07:07
@LeoLiao123 LeoLiao123 marked this pull request as ready for review November 27, 2025 07:08
Lee-W
Lee-W approved these changes Nov 27, 2025
View reviewed changes
Copy link
Member

@Lee-W Lee-W left a comment

Choose a reason for hiding this comment

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

LGTM. one docstring improvement. Thanks!

@Lee-W Lee-W requested a review from jason810496 November 27, 2025 07:24
@LeoLiao123 @Lee-W
Update providers/openfaas/src/airflow/providers/openfaas/hooks/openfa…
97344e5 
…as.py

Co-authored-by: Wei Lee <weilee.rx@gmail.com>
jason810496
jason810496 reviewed Nov 27, 2025
View reviewed changes
Copy link
Member

@jason810496 jason810496 left a comment

Choose a reason for hiding this comment

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

Nice! Thanks for the PR!

LeoLiao123 and others added 2 commits November 27, 2025 15:40
@LeoLiao123 @jason810496
Update providers/openfaas/docs/connections/openfaas.rst
127351a 
Co-authored-by: Jason(Zhe-You) Liu <68415893+jason810496@users.noreply.github.com>
@LeoLiao123 @jason810496
Update providers/openfaas/docs/connections/openfaas.rst
a2d6667 
Co-authored-by: Jason(Zhe-You) Liu <68415893+jason810496@users.noreply.github.com>
jason810496
jason810496 approved these changes Nov 27, 2025
View reviewed changes
Copy link
Member

@jason810496 jason810496 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks for the PR again!
It should be good to go after passing CI.

@LeoLiao123
test: add unit test for get_ui_field_behaviour
d6385fb 
fix: update test to use instance method for get_ui_field_behaviour
@LeoLiao123 LeoLiao123 force-pushed the feat/add-openfaas-conn-type branch from 29005e4 to 6f3482d Compare November 27, 2025 07:58
choo121600
choo121600 approved these changes Nov 27, 2025
View reviewed changes
Copy link
Member

@choo121600 choo121600 left a comment

Choose a reason for hiding this comment

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

LGTM ;)

@Lee-W Lee-W merged commit 7f8b088 into apache:main Nov 27, 2025
78 checks passed
@boring-cyborg
Copy link

boring-cyborg bot commented Nov 27, 2025

Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions.

@jscheffl jscheffl mentioned this pull request Nov 27, 2025
Closed
62 tasks
RoyLee1224 pushed a commit to RoyLee1224/airflow that referenced this pull request Dec 3, 2025
@LeoLiao123 @Lee-W
@jason810496 @RoyLee1224
feat: add OpenFaaS connection type and documentation (apache#58759)
b5c8592 
Co-authored-by: Wei Lee <weilee.rx@gmail.com>
Co-authored-by: Jason(Zhe-You) Liu <68415893+jason810496@users.noreply.github.com>
Copilot AI pushed a commit to jason810496/airflow that referenced this pull request Dec 5, 2025
@LeoLiao123 @Lee-W
@jason810496
feat: add OpenFaaS connection type and documentation (apache#58759)
cf832ce 
Co-authored-by: Wei Lee <weilee.rx@gmail.com>
Co-authored-by: Jason(Zhe-You) Liu <68415893+jason810496@users.noreply.github.com>
itayweb pushed a commit to itayweb/airflow that referenced this pull request Dec 6, 2025
@LeoLiao123 @Lee-W
@jason810496 @itayweb
feat: add OpenFaaS connection type and documentation (apache#58759)
1ce205e 
Co-authored-by: Wei Lee <weilee.rx@gmail.com>
Co-authored-by: Jason(Zhe-You) Liu <68415893+jason810496@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Lee-W Lee-W Lee-W approved these changes

@choo121600 choo121600 choo121600 approved these changes

@jason810496 jason810496 jason810496 approved these changes

Assignees

No one assigned

Labels

area:providers kind:documentation provider:openfaas

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@LeoLiao123 @Lee-W @choo121600 @jason810496