Skip to content

Commit

Permalink
Update serdes documentation (#5250)
Browse files Browse the repository at this point in the history
  • Loading branch information
carlesarnal authored Sep 26, 2024
1 parent f4919d5 commit f698783
Show file tree
Hide file tree
Showing 18 changed files with 23 additions and 23 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -140,12 +140,12 @@ After the topic export files have been created, you can run the following comman

== Importing the kafkasql-journal topic data

To import `kafkasql-journal` topic data that has been created with `kcat`, use an https://github.com/Apicurio/apicurio-registry-examples/tree/main/tools/kafkasql-topic-import[application from the Apicurio Registry examples repository] as follows:
To import `kafkasql-journal` topic data that has been created with `kcat`, use an https://github.com/Apicurio/apicurio-registry/tree/main/examples/tools/kafkasql-topic-import[application from the Apicurio Registry examples repository] as follows:

[source,bash]
----
git clone https://github.com/Apicurio/apicurio-registry-examples.git
cd apicurio-registry-examples/tools/kafkasql-topic-import
git clone https://github.com/Apicurio/apicurio-registry.git
cd examples/tools/kafkasql-topic-import
mvn clean install
export VERSION=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)
java -jar target/apicurio-registry-tools-kafkasql-topic-import-$VERSION-jar-with-dependencies.jar -b <optional-kafka-bootstrap-server-url> -f <path-to-topic-dump-file>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,5 @@ endif::[]
ifdef::apicurio-registry[]
* link:https://debezium.io/documentation/reference/stable/configuration/avro.html[Configuring Debezium to use Avro serialization and {registry}]
endif::[]
* link:https://github.com/Apicurio/apicurio-registry-examples/tree/main/event-driven-architecture[Example of using Debezium to monitor the PostgreSQL database used by Apicurio Registry]
* link:https://github.com/Apicurio/apicurio-registry/tree/main/examples/event-driven-architecture[Example of using Debezium to monitor the PostgreSQL database used by Apicurio Registry]
* link:https://kafka.apache.org/documentation/#connect[Apache Kafka Connect documentation]
Original file line number Diff line number Diff line change
Expand Up @@ -129,4 +129,4 @@ ifdef::rh-openshift-sr[]
** {base-url}{manage-api-url-registry}[Managing Service Registry data using the Core Registry API].
** {base-url}{manage-maven-plugin-url-registry}[Managing schemas and APIs using the Service Registry Maven plug-in].
endif::[]
* For a Java example, see the https://github.com/Apicurio/apicurio-registry-examples/tree/main/serdes-with-references[Apicurio Registry SerDes with references demonstration].
* For a Java example, see the https://github.com/Apicurio/apicurio-registry/tree/main/examples/serdes-with-references[Apicurio Registry SerDes with references demonstration].
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ These applications demonstrate use cases such as the following examples:

[role="_additional-resources"]
.Additional resources
* For more details, see link:https://github.com/Apicurio/apicurio-registry-examples[]
* For more details, see link:https://github.com/Apicurio/apicurio-registry/tree/main/examples[]
Original file line number Diff line number Diff line change
Expand Up @@ -121,5 +121,5 @@ When using these schemas with Avro SerDes, two artifacts are created in {registr

* For more details on Avro configuration, see the link:https://github.com/Apicurio/apicurio-registry/blob/main/serdes/avro-serde/src/main/java/io/apicurio/registry/serde/avro/AvroSerdeConfig.java[AvroSerdeConfig Java class]
* For Java example applications, see:
** link:https://github.com/Apicurio/apicurio-registry-examples[Simple Avro example]
** link:https://github.com/Apicurio/apicurio-registry-examples[SerDes with references example]
** link:https://github.com/Apicurio/apicurio-registry/tree/main/examples[Simple Avro example]
** link:https://github.com/Apicurio/apicurio-registry/tree/main/examples[SerDes with references example]
Original file line number Diff line number Diff line change
Expand Up @@ -105,5 +105,5 @@ In this example, a given citizen has a city. In {registry}, a citizen artifact w
.Additional resources
* For more details, see the link:https://github.com/Apicurio/apicurio-registry/blob/main/serdes/jsonschema-serde/src/main/java/io/apicurio/registry/serde/jsonschema/JsonSchemaKafkaDeserializerConfig.java[JsonSchemaKafkaDeserializerConfig Java class]
* For Java example applications, see:
** link:https://github.com/Apicurio/apicurio-registry-examples[Simple JSON Schema example]
** link:https://github.com/Apicurio/apicurio-registry-examples[SerDes with references example]
** link:https://github.com/Apicurio/apicurio-registry/tree/main/examples[Simple JSON Schema example]
** link:https://github.com/Apicurio/apicurio-registry/tree/main/examples[SerDes with references example]
Original file line number Diff line number Diff line change
Expand Up @@ -105,5 +105,5 @@ In this example, two Protobuf artifacts are stored in {registry}, one for `Table
[role="_additional-resources"]
.Additional resources
* For Java example applications, see:
** link:https://github.com/Apicurio/apicurio-registry-examples[Protobuf Bean and Protobuf Find Latest examples]
** link:https://github.com/Apicurio/apicurio-registry-examples[SerDes with references example]
** link:https://github.com/Apicurio/apicurio-registry/tree/main/examples[Protobuf Bean and Protobuf Find Latest examples]
** link:https://github.com/Apicurio/apicurio-registry/tree/main/examples[SerDes with references example]
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,4 @@ private static KafkaConsumer<Long, GenericRecord> createKafkaConsumer() {

[role="_additional-resources"]
.Additional resources
* For an example application, see the link:https://github.com/Apicurio/apicurio-registry-examples[Simple Avro example]
* For an example application, see the link:https://github.com/Apicurio/apicurio-registry/tree/main/examples[Simple Avro example]
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ endif::[]
[role="_additional-resources"]
.Additional resources
* For more details on using Apache Maven, see the https://maven.apache.org/index.html[Apache Maven documentation].
* For an open source example of using the {registry} Maven plug-in to automatically register multiple artifact references, see the link:https://github.com/Apicurio/apicurio-registry-examples/tree/main/avro-maven-with-references-auto[avro-maven-with-references-auto demonstration example].
* For an open source example of using the {registry} Maven plug-in to automatically register multiple artifact references, see the link:https://github.com/Apicurio/apicurio-registry/tree/main/examples/avro-maven-with-references-auto[avro-maven-with-references-auto demonstration example].
* For more examples of artifact references, see the section on configuring each artifact type in {registry-client-serdes-config}.


Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ endif::[]
[role="_additional-resources"]
.Additional resources
* For more details on using Apache Maven, see the https://maven.apache.org/index.html[Apache Maven documentation].
* For an open source example of using the {registry} Maven plug-in to manually register an artifact reference, see the link:https://github.com/Apicurio/apicurio-registry-examples/tree/main/avro-maven-with-references[avro-maven-with-references demonstration example].
* For an open source example of using the {registry} Maven plug-in to manually register an artifact reference, see the link:https://github.com/Apicurio/apicurio-registry/tree/main/examples/avro-maven-with-references[avro-maven-with-references demonstration example].
* For more examples of artifact references, see the section on configuring each artifact type in {registry-client-serdes-config}.


Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,4 @@ endif::[]
[role="_additional-resources"]
.Additional resources
* For more details on using Apache Maven, see the https://maven.apache.org/index.html[Apache Maven documentation].
* For open source examples of using the {registry} Maven plug-in, see the link:https://github.com/Apicurio/apicurio-registry-examples[Apicurio Registry demonstration examples].
* For open source examples of using the {registry} Maven plug-in, see the link:https://github.com/Apicurio/apicurio-registry/tree/main/examples[Apicurio Registry demonstration examples].
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,4 @@ endif::[]
[role="_additional-resources"]
.Additional resources
* For more details on using Apache Maven, see the https://maven.apache.org/index.html[Apache Maven documentation].
* For open source examples of using the {registry} Maven plug-in, see the link:https://github.com/Apicurio/apicurio-registry-examples[Apicurio Registry demonstration examples].
* For open source examples of using the {registry} Maven plug-in, see the link:https://github.com/Apicurio/apicurio-registry/tree/main/examples[Apicurio Registry demonstration examples].
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ $ curl -X POST -H "Content-type: application/json; artifactType=AVRO" -H "X-Regi
[role="_additional-resources"]
.Additional resources
* For more REST API sample requests, see the link:{attachmentsdir}/registry-rest-api.htm[Apicurio Registry REST API documentation].
* For demonstration examples, see link:https://github.com/Apicurio/apicurio-registry-examples[].
* For demonstration examples, see link:https://github.com/Apicurio/apicurio-registry/tree/main/examples[].
Original file line number Diff line number Diff line change
Expand Up @@ -94,5 +94,5 @@ $ curl -X POST -H "Content-type: application/json; artifactType=AVRO" -H "X-Regi
[role="_additional-resources"]
.Additional resources
* For more REST API sample requests, see the link:{attachmentsdir}/registry-rest-api.htm[Apicurio Registry REST API documentation].
* For demonstration examples, see link:https://github.com/Apicurio/apicurio-registry-examples[].
* For demonstration examples, see link:https://github.com/Apicurio/apicurio-registry/tree/main/examples[].
* For more details on Apache Kafka, see https://kafka.apache.org/documentation/.
Original file line number Diff line number Diff line change
Expand Up @@ -57,5 +57,5 @@ $ curl -X POST -H "Content-type: application/json; artifactType=AVRO" -H "X-Regi
[role="_additional-resources"]
.Additional resources
* For more REST API sample requests, see the link:{attachmentsdir}/registry-rest-api.htm[Apicurio Registry REST API documentation].
* For demonstration examples, see link:https://github.com/Apicurio/apicurio-registry-examples[].
* For demonstration examples, see link:https://github.com/Apicurio/apicurio-registry/tree/main/examples[].
* For more details on PostgreSQL, see the link:https://www.postgresql.org/docs/12/index.html[PostgreSQL documentation].
Original file line number Diff line number Diff line change
Expand Up @@ -96,4 +96,4 @@ endif::[]

[role="_additional-resources"]
.Additional resources
* For detailed configuration examples, see the link:https://github.com/Apicurio/apicurio-registry-examples[Apicurio Registry example applications].
* For detailed configuration examples, see the link:https://github.com/Apicurio/apicurio-registry/tree/main/examples[Apicurio Registry example applications].
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,4 @@ endif::[]
[role="_additional-resources"]
.Additional resources
* For more details on using Apache Maven, see the https://maven.apache.org/index.html[Apache Maven documentation].
* For open source examples of using the {registry} Maven plug-in, see the link:https://github.com/Apicurio/apicurio-registry-examples[Apicurio Registry demonstration examples].
* For open source examples of using the {registry} Maven plug-in, see the link:https://github.com/Apicurio/apicurio-registry/tree/main/examples[Apicurio Registry demonstration examples].
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,6 @@ When the client is created, you can use all of the operations available in the {

[role="_additional-resources"]
.Additional resources
* For an open source example of how to use and customize the {registry} client, see the https://github.com/Apicurio/apicurio-registry-examples[Apicurio Registry REST client demonstration].
* For an open source example of how to use and customize the {registry} client, see the https://github.com/Apicurio/apicurio-registry/tree/main/examples[Apicurio Registry REST client demonstration].

* For details on how to use the {registry} Kafka client serializers/deserializers (SerDes) in producer and consumer applications, see {kafka-client-serdes}.

0 comments on commit f698783

Please sign in to comment.