Skip to content

Commit

Permalink
Kafka Confluent avro schema serializer doc update
Browse files Browse the repository at this point in the history 
Resolves #36372
  • Loading branch information
@ozangunalp
ozangunalp committed Oct 26, 2023
1 parent a4cb913 commit 35a1b22
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 6 deletions.
23 changes: 18 additions & 5 deletions docs/src/main/asciidoc/kafka-schema-registry-avro.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -795,12 +795,25 @@ dependencies {
----

In JVM mode, any version of `io.confluent:kafka-avro-serializer` can be used.
In native mode, Quarkus only supports the following versions:
In native mode, Quarkus supports the following versions: `6.2.x`, `7.0.x`, `7.1.x`, `7.2.x`, `7.3.x`.

Check warning on line 798 in docs/src/main/asciidoc/kafka-schema-registry-avro.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'need to'.

Raw Output:
{"message": "[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'need to'.", "location": {"path": "docs/src/main/asciidoc/kafka-schema-registry-avro.adoc", "range": {"start": {"line": 798, "column": 101}}}, "severity": "INFO"}

* 6.2.x
* 7.0.x
* 7.1.x
* 7.2.x
For version `7.4.x` and `7.5.x`, due to an issue with the Confluent Schema Serializer, you need to add another dependency:

[source,xml,role="primary asciidoc-tabs-target-sync-cli asciidoc-tabs-target-sync-maven"]
.pom.xml
----
<dependency>
<groupId>com.fasterxml.jackson.dataformat</groupId>
<artifactId>jackson-dataformat-csv</artifactId>

Check warning on line 807 in docs/src/main/asciidoc/kafka-schema-registry-avro.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.CaseSensitiveTerms] Use 'Gradle' rather than 'gradle'.

Raw Output:
{"message": "[Quarkus.CaseSensitiveTerms] Use 'Gradle' rather than 'gradle'.", "location": {"path": "docs/src/main/asciidoc/kafka-schema-registry-avro.adoc", "range": {"start": {"line": 807, "column": 40}}}, "severity": "INFO"}
</dependency>
----
[source,gradle,role="secondary asciidoc-tabs-target-sync-gradle"]
.build.gradle
----
dependencies {
implementation("com.fasterxml.jackson.dataformat:jackson-dataformat-csv")

Check warning on line 814 in docs/src/main/asciidoc/kafka-schema-registry-avro.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Spelling] Use correct American English spelling. Did you really mean 'Avro'?

Raw Output:
{"message": "[Quarkus.Spelling] Use correct American English spelling. Did you really mean 'Avro'?", "location": {"path": "docs/src/main/asciidoc/kafka-schema-registry-avro.adoc", "range": {"start": {"line": 814, "column": 60}}}, "severity": "WARNING"}
}
----

For any other versions, the native configuration may need to be adjusted.

Check warning on line 818 in docs/src/main/asciidoc/kafka-schema-registry-avro.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsWarnings] Consider using 'might (for possiblity)' or 'can (for ability)' rather than 'may' unless updating existing content that uses the term.

Raw Output:
{"message": "[Quarkus.TermsWarnings] Consider using 'might (for possiblity)' or 'can (for ability)' rather than 'may' unless updating existing content that uses the term.", "location": {"path": "docs/src/main/asciidoc/kafka-schema-registry-avro.adoc", "range": {"start": {"line": 818, "column": 50}}}, "severity": "WARNING"}

Check warning on line 818 in docs/src/main/asciidoc/kafka-schema-registry-avro.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'need to'.

Raw Output:
{"message": "[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'need to'.", "location": {"path": "docs/src/main/asciidoc/kafka-schema-registry-avro.adoc", "range": {"start": {"line": 818, "column": 54}}}, "severity": "INFO"}

Expand Down
6 changes: 5 additions & 1 deletion integration-tests/kafka-avro-apicurio2/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,14 +57,18 @@
<dependency>
<groupId>io.confluent</groupId>
<artifactId>kafka-avro-serializer</artifactId>
<version>7.2.1</version>
<version>7.5.1</version>
<exclusions>
<exclusion>
<groupId>org.checkerframework</groupId>
<artifactId>checker-qual</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.dataformat</groupId>
<artifactId>jackson-dataformat-csv</artifactId>
</dependency>
<!-- Apicurio & Confluent -->
<dependency>
<groupId>io.quarkus</groupId>
Expand Down

0 comments on commit 35a1b22

Please sign in to comment.