API endpoints for sharing HITL details, operations through links from HITLOperators #52202

Body

Why

According to AIP-90

An URL endpoint is provided that can be used to provide a prepared link that can be shared (utility to generate included in provider to automate creation of notifications)

• Directly opens and re-directs to the dialog with details
• Directly trigger one action as a single-click (e.g. single click on a link in an email to approve) - assuming user is logged-in before
• Security first! This would need to be explicitly enabled in configuration and a token would be added when generating to ensure CSRF is not made by artificial URLs. URLs would need to be generated by the utility before distribution.

, we need a URL endpoint for users to perform actions on HITLOperators.

What

1. A URL endpoint that can generate a link that opens and redirects to the Airflow page, where the user can choose an option and enter input
2. A URL endpoint that generates a link that sends a patch request to /api/v2/hitl-details/{dag_id}/{dag_run_id}/{task_id} and /api/v2/hitl-details/{dag_id}/{dag_run_id}/{task_id}/{map_index} with proper option embed (e.g., {"chosen_options": ["a", "b"], "params_input": {"input_1": 1}}) to Airflow if the user has logged in and has sufficient permission
3. An airflow config that allows the user to enable the two URL endpoints above. Without explicit setup, the two URL endpoints should not be hooked into Airflow.
4. For the above two URL endpoints, we need to add a token to ensure CSRF is not made by artificial URLs.

The endpoints for HITL-details are now ready. Please use {dag_id}/{dag_run_id}/{task_id} or /{dag_id}/{dag_run_id}/{task_id}/{map_index} as suffix of the new endpoint

Committer

• I acknowledge that I am a maintainer/committer of the Apache Airflow project.