[YAML] Note about error output schemas.

robertwb · robertwb · commit 07c8bc4b4fa0 · 2023-11-02T10:10:07.000-07:00
diff --git a/sdks/python/apache_beam/yaml/yaml_errors.md b/sdks/python/apache_beam/yaml/yaml_errors.md
@@ -67,6 +67,10 @@ Note that with `error_handling` declared, `MapToFields.my_error_output`
 logging the bad records to stdout would be sufficient (though not recommended
 for a robust pipeline).
 
+Note also that the exact format of the error outputs is still being finalized.
+They can be safely printed and written to outputs, but their precise schema
+may change in a future version of Beam and should not yet be depended on.
+
 Some transforms allow for extra arguments in their error_handling config, e.g.
 for Python functions one can give a `threshold` which limits the relative number
 of records that can be bad before considering the entire pipeline a failure
