sharingan-no-kakashi opened a new pull request #16953:
URL: https://github.com/apache/airflow/pull/16953


   In reference to #16790, I have worked on this "Task Note" feature. 
   
   In a nutshell, a task note is a user-provided annotation for a task instance 
that keeps track of Airflow-external events that are not collected in the logs. 
   
   **Model**
   The model consists of (dag_id, task_id, execution_date, timestamp) that form 
the primary key a user_name, and a task_note field. The task not field is an 
unbounded collection of text. 
   
   **Table**
   I have created a new table "Task notes" to store notes. 
   
   **Views**
   There are two new views. The task instance details view has a new "sub view" 
that contains the task note and there is a new menu called "task notes". 
   
   **Task Note view**:
   Users can view in a tabular fashion the notes related to that task and, if 
authorized, can submit a new task note. 
   
   **Task notes menu**:
   Users can list all the task notes, edit them and delete them (Similar to 
xcom menu)
   
   **Security**
   I have introduced a new resource "Task note", viewers can list all the task 
notes, while users can edit/create/delete them. 
   (In the current implementation, users can edit other users' notes)
   
   **Screenshot**
   [Viewers without creating task note permissions](https://ibb.co/h2B6xps)
   [Users with creating task note permission](https://ibb.co/CWdMBkb)
   [Task note menu](https://ibb.co/VCVcrSp)
   
   
   
   **Question**
   
   1.  It's not entirely clear to me how ` airflow/migrations/versions` works, 
I have just added the table creation there, but it's likely wrong. 
   2. Should task notes' sizes be limited?
   3. Once this flow has been reviewed and validated, I will be happy to write 
a piece of documentation maybe `docs/apache-airflow/concepts/task-note.rst` ?
   4. API endpoints are missing from this, do you think they should be added?
   
   
   
   
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


Reply via email to