fmorillo7694 commented on PR #236:
URL: 
https://github.com/apache/flink-connector-aws/pull/236#issuecomment-5888389723

   Two more proactive commits, applying the same "run the docs against the 
code" lens that round 3 of #206 got.
   
   **`8cf3613` -- docs that did not match the code** (found by auditing the 
three format pages against the factories and converters):
   
   - `schema.compatibility` default was documented as `NONE` on all three 
pages. The option defaults to the registry client's default, which is 
`BACKWARD`. A user relying on `NONE` would have had registrations rejected by a 
compatibility check they did not know was on.
   - `avro-glue.schema.type` was documented with `SPECIFIC_RECORD` support. The 
option was declared by the factory but never read anywhere; the SQL path is 
`GenericRecord`-only. Removed from the factory and the page, and the page now 
says so.
   - avro-glue Limitations referred to an `avro.schema` option that does not 
exist.
   - protobuf-glue's type table listed `ARRAY -> repeated`, `MAP -> map`, `ROW 
-> message` while the converter rejects all three (its own Limitations said 
so); the real scalar mappings (`DECIMAL`, `DATE`, `TIME`, `TIMESTAMP`, 
`CHAR`/`BINARY` families) were missing.
   - json-glue's table said the `INT` family maps to `number`; the registered 
JSON Schema declares `integer`.
   - The hand-written Maven `<dependency>` blocks pinned `6.0.0` on a 
`6.1-SNAPSHOT` tree; replaced with the repo's `connector_artifact` shortcode.
   
   **`d3fec58` -- a docs test per format module** so this class of drift fails 
the build instead of a reader:
   
   - every `CREATE TABLE` example on the English and Chinese page is executed 
in a real `TableEnvironment` with the connector it names (`kinesis` / 
`firehose`, now test dependencies) and planned as a source or a sink;
   - the Format Options table is compared key by key with the factory's 
required / optional / forwarded options and defaults;
   - for json-glue and protobuf-glue, every row of the Data Type Mapping table 
is fed through the converter and the generated schema must carry the documented 
target type.
   
   Verified negatively before committing: a wrong default, an undeclared option 
in an example, and the old `ARRAY -> repeated` row each fail the corresponding 
test. The tests point any registry client an example builds at planning time at 
a closed loopback port, so they never touch the network. Unit suites: avro 63, 
json 44, protobuf 34, spotless and checkstyle clean.
   


-- 
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