Generate DAG docs

WordPress · May 24, 2023 · ded9ff1 · ded9ff1
1 parent 843f272
commit ded9ff1
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 7 deletions.
diff --git a/catalog/DAGs.md b/catalog/DAGs.md
@@ -669,10 +669,12 @@ It runs on Saturdays at 00:00 UTC in order to happen before the data refresh.
 The DAG will automatically delete the oldest snapshots when more snaphots exist
 than it is configured to retain.
 
-Requires two variables:
+Relies on three variables:
 
-`AIRFLOW_RDS_ARN`: The ARN of the RDS DB instance that needs snapshots.
-`AIRFLOW_RDS_SNAPSHOTS_TO_RETAIN`: How many historical snapshots to retain.
+`CATALOG_RDS_DB_IDENTIFIER`: (Required) The "DBIdentifier" of the RDS DB
+instance. `CATALOG_RDS_SNAPSHOTS_TO_RETAIN`: (Required) How many historical
+snapshots to retain. `CATALOG_RDS_REGION`: (Optional) The region of the RDS DB
+instance. Defaults to `us-east-1`.
 
 ## `science_museum_workflow`
 

diff --git a/catalog/dags/maintenance/rotate_db_snapshots.py b/catalog/dags/maintenance/rotate_db_snapshots.py
@@ -9,11 +9,12 @@
 The DAG will automatically delete the oldest snapshots when more snaphots
 exist than it is configured to retain.
 
-Requires three variables:
+Relies on three variables:
 
-`CATALOG_RDS_DB_IDENTIFIER`: The "DBIdentifier" of the RDS DB instance.
-`CATALOG_RDS_SNAPSHOTS_TO_RETAIN`: How many historical snapshots to retain.
-`CATALOG_RDS_REGION`: The region of the RDS DB instance.
+`CATALOG_RDS_DB_IDENTIFIER`: (Required) The "DBIdentifier" of the RDS DB instance.
+`CATALOG_RDS_SNAPSHOTS_TO_RETAIN`: (Required) How many historical snapshots to retain.
+`CATALOG_RDS_REGION`: (Optional) The region of the RDS DB instance. Defaults to
+`us-east-1`.
 """
 
 import logging