[jira] [Created] (FLINK-21064) Format docs incorrectly contain "format" property

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

[jira] [Created] (FLINK-21064) Format docs incorrectly contain "format" property

Shang Yuanchun (Jira)
Ingo Bürk created FLINK-21064:
---------------------------------

             Summary: Format docs incorrectly contain "format" property
                 Key: FLINK-21064
                 URL: https://issues.apache.org/jira/browse/FLINK-21064
             Project: Flink
          Issue Type: Improvement
          Components: Documentation
    Affects Versions: 1.12.1, 1.12.0
            Reporter: Ingo Bürk


In the Flink docs, all formats document the "format" property as required. However, this is actually a property of the connector, not the format.

Prior to 1.12 this was only an issue for custom connectors as all of Flink's connectors by convention had a "format" property. With 1.12+, the Kafka connector made the "format" property non-required as users can instead use "value.format". Although being synonyms, this now logically breaks the documentation of the Formats stating that "format" is a required property.

 



--
This message was sent by Atlassian Jira
(v8.3.4#803005)