Skip to content

Commit 782392a

Browse files
committed
fmt example readme
1 parent f455348 commit 782392a

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

examples/README.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Apicurio Registry Example Applications
22
This repository contains a set of example applications (mostly Kafka applications) that use the
3-
Apicurio Registry as part of their workflow. The registry is typically used to store schemas
3+
Apicurio Registry as part of their workflow. The registry is typically used to store schemas
44
used by Kafka serializer and deserializer classes. These serdes classes will fetch the schema
5-
from the registry for use during producing or consuming operations (to serializer, deserializer,
5+
from the registry for use during producing or consuming operations (to serializer, deserializer,
66
or validate the Kafka message payload).
77

88
Each example in this repository attempts to demonstrate some specific use-case or configuration.
@@ -23,13 +23,13 @@ Simply run ``docker-compose -f examples/tools/kafka-compose/kafka-compose.yaml
2323
A list of examples is included below, with descriptions and explanations of each covered use-case.
2424

2525
## Simple Avro Example
26-
This example application demonstrates the basics of using the registry in a very simple Kafka
27-
publish/subscribe application using Apache Avro as the schema technology used to serialize
28-
and deserialize message payloads.
26+
This example application demonstrates the basics of using the registry in a very simple Kafka
27+
publish/subscribe application using Apache Avro as the schema technology used to serialize
28+
and deserialize message payloads.
2929

3030
## Simple JSON Schema Example
31-
This example application demonstrates the basics of using the registry in a very simple Kafka
32-
publish/subscribe application using JSON Schema to validate message payloads when both producing
31+
This example application demonstrates the basics of using the registry in a very simple Kafka
32+
publish/subscribe application using JSON Schema to validate message payloads when both producing
3333
and consuming them. JSON Schema is not a serialization technology, but rather is only used for
3434
validation. Therefore, it can be enabled or disabled in the serializer and deserializer.
3535

@@ -42,7 +42,7 @@ is essentially the same as the Simple Avro Example, but using a Confluent serial
4242
Apicurio Registry deserializer.
4343

4444
## Avro Bean Example
45-
This example demonstrates how to use Avro as the schema and serialization technology while
45+
This example demonstrates how to use Avro as the schema and serialization technology while
4646
using a Java Bean as the Kafka message payload. This is essentially the same as the Simple
4747
Avro Example, but using a java bean instead of a `GenericRecord` as the message payload.
4848

@@ -55,18 +55,18 @@ the same as the Simple Avro Example, except instead of using one of the default
5555
Registry Global ID strategies, it uses a custom one.
5656

5757
## Simple Avro Maven Example
58-
This example application demonstrates how to use the Apicurio Registry maven plugin to
58+
This example application demonstrates how to use the Apicurio Registry maven plugin to
5959
pre-register an Avro schema so that it does not need to be embedded within the producer
6060
application. Note that this example will fail unless the maven plugin is executed before
6161
the Java application. See the javadoc in the example for details.
6262

6363
## Rest Client example
64-
This example application demonstrates how to use the Apicurio Registry rest client to create,
65-
delete, or fetch schemas. This example contains two basic java application, one showing how to
66-
improve the logs by logging all the request and response headers and a basic example on how to
64+
This example application demonstrates how to use the Apicurio Registry rest client to create,
65+
delete, or fetch schemas. This example contains two basic java application, one showing how to
66+
improve the logs by logging all the request and response headers and a basic example on how to
6767
use the client.
6868

6969
## Mix Avro Schemas Example
7070
This example application showcases an scenario where Apache Avro messages are published to the same
7171
Kafka topic using different Avro schemas. This example uses the Apicurio Registry serdes classes to serialize
72-
and deserialize Apache Avro messages using different schemas, even if received in the same Kafka topic.
72+
and deserialize Apache Avro messages using different schemas, even if received in the same Kafka topic.

0 commit comments

Comments
 (0)