asyncapi / bindings

AsyncAPI bindings specifications
Apache License 2.0
71 stars 75 forks source link

fix: updated topic configuration object data types #242

Closed gokerakc closed 7 months ago

gokerakc commented 7 months ago

Description

The following properties need to be updated as long:

If you need further details about the configs you can check this documentation page: https://kafka.apache.org/documentation/#topicconfigs_retention.bytes

Change log

gokerakc commented 7 months ago

If we are dependent on JSON in this README.md file then you are right, we can not use long as a data type.

But also it would be good to raise that developers should use long in their tooling otherwise they may end up having problems.

dalelane commented 7 months ago

That's a fair point - I'm perhaps being unhelpfully strict for a markdown file, and this is better thought of as an issue for https://github.com/asyncapi/spec-json-schemas only, where you do have them as integers.

@smoya - what do you think?

smoya commented 7 months ago

That's a fair point - I'm perhaps being unhelpfully strict for a markdown file, and this is better thought of as an issue for https://github.com/asyncapi/spec-json-schemas only, where you do have them as integers.

@smoya - what do you think?

The issue is that you can't specify long as a type in JSON Schema, so we won't be able to really ensure it. Anyway, I also agree this README should mention long to be more accurate.

dalelane commented 7 months ago

fair enough - this way round makes sense then - the formal json schema is only as precise as it can be (integer) but we give a more helpful/accurate description in the markdown doc here

Thanks, both, for hearing me out :)

gokerakc commented 7 months ago

/rtm